它们都好吗？研究从业者对日志消息可读性的期望
软件工程
2023-08-21 v1
摘要
开发者编写日志语句以生成日志，为各类任务提供运行时信息。日志语句中日志消息（即描述性文本）的可读性对于所生成日志的价值相当关键。不成熟的日志消息可能减缓甚至阻碍日志分析过程。尽管日志消息十分重要，目前仍缺乏关于何种构成良好可读性及如何编写它们的标准。在本文中，我们对 17 名工业界从业者进行了一系列访谈，以调查他们对日志消息可读性的期望。通过访谈，我们推导出与日志消息可读性相关的三个方面，包括结构、信息与措辞，以及改进各方面的一些具体实践。我们通过一系列在线问卷调查验证了我们的发现，并收到了参与者的积极反馈。随后我们手动调查了大规模开源系统中日志消息的可读性，发现很大一部分（38.1%）的日志消息可读性不足。受此观察启发，我们进一步探索了利用深度学习和机器学习模型自动分类日志消息可读性的潜力。我们发现深度学习和机器学习模型均能有效地分类日志消息的可读性，平均平衡准确率 above 80.0%。我们的研究为撰写日志消息提供了全面指南，以进一步改进从业者的日志实践。
引用
@article{arxiv.2308.08836,
title = {Are They All Good? Studying Practitioners' Expectations on the Readability of Log Messages},
author = {Zhenhao Li and An Ran Chen and Xing Hu and Xin Xia and Tse-Hsun Chen and Weiyi Shang},
journal= {arXiv preprint arXiv:2308.08836},
year = {2023}
}
备注
Accepted as a research paper at the 38th IEEE/ACM International Conference on Automated Software Engineering (ASE 2023)