写点什么

程序那些事:日志记录的作用和方法

2012 年 11 月 06 日

程序中记录日志一般有两个目的:Troubleshooting 和显示程序运行状态。好的日志记录方式可以提供我们足够多定位问题的依据。日志记录大家都会认为简单,但如何通过日志可以高效定位问题并不是简单的事情。这里列举下面三个方面的内容,辅以代码示例,总结如何写好日志,希望对他人有所启发和帮助:

  • 怎样记日志可以方便 Troubleshooting
  • 程序运行状态可以记哪些
  • 应该避免怎样的日志方式

怎样记日志可以方便 Troubleshooting?

1. 对外部的调用封装

程序中对外部系统与模块的依赖调用前后都记下日志,方便接口调试。出问题时也可以很快理清是哪块的问题

复制代码
1. LOG.debug("Calling external system:" + parameters);
2. Object result = null;
3. try {
4. result = callRemoteSystem(params);
5. LOG.debug("Called successfully. result is " + result);
6. } catch (Exception e) {
7. LOG.warn("Failed at calling xxx system . exception : " + e);
8. }

2. 状态变化

程序中重要的状态信息的变化应该记录下来,方便查问题时还原现场,推断程序运行过程

复制代码
1. boolean isRunning;
2.
3. isRunning = true;
4. LOG.info("System is running");
5.
6. //...
7.
8. isRunning = false;
9. LOG.info("System was interrupted by " + Thread.currentThread().getName());

3. 系统入口与出口:

这个粒度可以是重要方法级或模块级。记录它的输入与输出,方便定位

复制代码
1. void execute(Object input) {
2. LOG.debug("Invoke parames : " + input);
3. Object result = null;
4.
5. //business logic
6.
7. LOG.debug("Method result : " + result);
8. }

4. 业务异常:

任何业务异常都应该记下来:

复制代码
1. try {
2. //business logical
3. } catch (IOException e) {
4. LOG.warn("Description xxx" , e);
5. } catch (BusinessException e) {
6. LOG.warn("Let me know anything");
7. } catch (Exception e) {
8. LOG.error("Description xxx", e);
9. }
10.

5. 非预期执行:

为程序在“有可能”执行到的地方打印日志。如果我想删除一个文件,结果返回成功。但事实上,那个文件在你想删除之前就不存在了。最终结果是一致的,但程序得让我们知道这种情况,要查清为什么文件在删除之前就已经不存在

复制代码
1. int myValue = xxxx;
2. int absResult = Math.abs(myValue);
3. if (absResult < 0) {
4. LOG.info("Original int " + myValue + "has nagetive abs " + absResult);
5. }

6. 很少出现的 else 情况:

else 可能吞掉你的请求,或是赋予难以理解的最终结果

复制代码
1. Object result = null;
2. if (running) {
3. result = xxx;
4. } else {
5. result = yyy;
6. LOG.debug("System does not running, we change the final result");
7. }

程序运行状态可以记哪些?

程序在运行时就像一个机器人,我们可以从它的日志看出它正在做什么,是不是按预期的设计在做,所以这些正常的运行状态是要有的。

1. 程序运行时间:

复制代码
1. long startTime = System.currentTime();
2.
3. // business logical
4.
5. LOG.info("execution cost : " + (System.currentTime() - startTime) + "ms"); 

2. 大批量数据的执行进度:

复制代码
1. LOG.debug("current progress: " + (currentPos * 100 / totalAmount) + "%");

3. 关键变量及正在做哪些重要的事情:

执行关键的逻辑,做 IO 操作等等

复制代码
1. String getJVMPid() {
2. String pid = "";
3. // Obtains JVM process ID
4. LOG.info("JVM pid is " + pid);
5. return pid;
6. }
7.
8. void invokeRemoteMethod(Object params) {
9. LOG.info("Calling remote method : " + params);
10. //Calling remote server
11. }

应该避免怎样的日志方式?

1. 混淆信息的 Log

日志应该是清晰准确的: 当看到日志的时候,你知道是因为连接池取不到连接导致的问题么?

复制代码
1. Connection connection = ConnectionFactory.getConnection();
2. if (connection == null) {
3. LOG.warn("System initialized unsuccessfully");
4. }

2. 记错位置

产品代码中,使用 console 记录日志,导致没有找到日志。

复制代码
1. } catch (ConfigurationException e) {
2. e.printStackTrace();
3. }

3. 记错级别

记错级别常常发生,常见的如:混淆代码错误和用户错误, 如登录系统中,如果恶意登录,那系统内部会出现太多 WARN,从而让管理员误以为是代码错误。可以反馈用户以错误,但是不要记录用户错误的行为,除非想达到控制的目的。

复制代码
1. LOG.warn("Failed to login by "+username+");

4. 遗漏信息

这里可能包含两种情况:(1)用户自己少写了信息, 导致毫无参考价值;(2)用户调用 log 的方式导致丢失信息,如下例,没有 stack trace.

复制代码
1. } catch (Exception ex) {
2. log.error(ex);
3. }

总结:

日志记录在程序员日常编程实践中必须面对的事情,本文针对这个话题谈了下自己的体会,希望读者能有所收益。多有不足,请多包涵。

参考文献

http://www.infoq.com/cn/articles/10-java-questions-easy-to-ignore

作者介绍

冶秀刚, 平台工程师,从事分布式收集与存储系统的研究与开发,爱好读书,喜欢涉猎各类能长见识的内容


给 InfoQ 中文站投稿或者参与内容翻译工作,请邮件至 editors@cn.infoq.com 。也欢迎大家通过新浪微博( @InfoQ )或者腾讯微博( @InfoQ )关注我们,并与我们的编辑和其他读者朋友交流。

2012 年 11 月 06 日 00:1917023

评论

发布
暂无评论
发现更多内容

Spring-技术专题-设计模式和研究分析

李浩宇/Alex

spring 设计模式 原理分析 五月日更

一次过透气浆、印一次透气浆

C13713145387

透气胶浆 一次过透气浆

数字资产的发行是全球都无法阻挡的大趋势!

CECBC区块链专委会

数字资产

打破思维定式(二)

Changing Lin

5月日更

入门到精通!阿里码农熬了2晚整理的Java工具,真香

飞飞JAva

Java java工具类

采取有效云网络安全策略的5个基本步骤

浪潮云

云计算

MySQL数据迁移那些事儿

Simon

MySQL 数据迁移

基金会官宣3——看太空猫如何打破技术壁垒!

北熊老师

太空猫公链 太空猫社区联盟 TKM

Golang实现文件复制的技巧

liuzhen007

golang 5月日更

假期过得是真快啊

IT蜗壳-Tango

五月日更

喊话特斯拉、保时捷、戴森三巨头,户外造势热点!

󠀛Ferry

5月日更

融云亮相 CDEC2021 上海站 全场景通信能力赋能企业数字升级

融云 RongCloud

建筑行业全周期区块链产融平台

CECBC区块链专委会

建筑行业

4.2 Go语言从入门到精通:延迟函数 defer

xcbeyond

defer go语言 Go语言从入门到精通 5月日更

模块三作业:消息队列详细设计文档

薛定谔的指南针

架构实战营

postgresql数据库 timescaledb 时序库 超级表 块的压缩(compress_chunk()的应用)

Yang

数据库 postgresql

福利拉满!腾讯云大神亲码Redis深度手册【基础+应用+原理+集群+扩展+源码】六大核心知识,全部一次让你搞懂

神奇小汤圆

Java 数据库 程序员 架构

算法训练营 - 学习笔记 - 第五周

心在飞

自研消息队列架构设计文档

菠萝吹雪—Code

架构实战营

哑面爽滑肤感胶浆

C13713145387

哑面爽滑肤感胶浆

进击的速溶咖啡:当中国AI开始玩工业化

脑极体

太简单了!这套Java异常处理的总结,80%的人都没看过

牛哄哄的java大师

Java

区块链与物联网融合发展都会有哪些机遇与挑战

CECBC区块链专委会

区块链

基于golang分布式爬虫系统的架构体系v1.0

雨夜的博客

go 架构

OAuth 2.0 与 OIDC

Zhang

OAuth 2.0 OIDC

Java中用户线程和守护线程区别这么大?

王磊

Java 并发编程 多线程 5月日更

Spring Cloud Kubernetes之实战一配置管理

Damon

5月日更 五月日更

网络攻防学习笔记 Day5

穿过生命散发芬芳

5月日更 网络攻防

展开说说,Spring Bean IOC、AOP 循环依赖

小傅哥

Java spring 小傅哥 ioc 循环依赖

超级全面的测试用例设计,你确定不来看一看?

程序员一凡

软件测试 测试用例 测试工程师

NumPy之:结构化数组详解

程序那些事

Python 数据分析 Numpy 程序那些事

程序那些事:日志记录的作用和方法-InfoQ