Log messages have been used widely in many software systems for a variety of purposes during software development and field operation. There are two phases in software logging: log instrumentation and log management. Log instrumentation refers to the practice that developers insert logging code into source code to record runtime information. Log management refers to the practice that operators collect the generated log messages and conduct data analysis techniques to provide valuable insights of runtime behavior. There are many open source and commercial log management tools available. However, their effectiveness highly depends on the quality of the instrumented logging code, as log messages generated by high-quality logging code can greatly ease the process of various log analysis tasks (e.g., monitoring, failure diagnosis, and auditing). Hence, in this article, we conducted a systematic survey on state-of-the-art research on log instrumentation by studying 69 papers between 1997 and 2019. In particular, we have focused on the challenges and proposed solutions used in the three steps of log instrumentation: (1) logging approach; (2) logging utility integration; and (3) logging code composition. This survey will be useful to DevOps practitioners and researchers who are interested in software logging.

中文翻译：

---

软件日志检测调查

在软件开发和现场操作期间，日志消息已广泛用于许多软件系统中，用于各种目的。软件日志记录有两个阶段：日志检测和日志管理。日志检测是指开发人员将日志代码插入源代码以记录运行时信息的做法。日志管理是指操作员收集生成的日志消息并进行数据分析技术以提供对运行时行为的宝贵见解的做法。有许多可用的开源和商业日志管理工具。然而，它们的有效性在很大程度上取决于检测日志代码的质量，因为高质量的日志代码生成的日志消息可以极大地简化各种日志分析任务（例如，监控、故障诊断和审计）的过程。因此，在本文中，我们通过研究 1997 年至 2019 年间的 69 篇论文，对测井仪器的最新研究进行了系统调查。特别是，我们重点关注了测井仪器三个步骤中使用的挑战和提出的解决方案：（1）测井方式；(2) 日志工具集成；(3) 记录代码组成。该调查将对对软件日志记录感兴趣的 DevOps 从业者和研究人员有用。