文档章节

55最佳实践系列:Logging最佳实践

旁观者-郑昀
 旁观者-郑昀
发布于 2013/02/08 22:44
字数 1900
阅读 199
收藏 11

【推荐】2019 Java 开发者跳槽指南.pdf(吐血整理) >>>

@郑昀汇总 创建日期:2012/10
 
#意识

ASAP (As Soon As Possible)原则

当线上出现诡异问题,
当你意识到靠现有的日志无法定位问题时,
当现象难以在你的开发环境重现时,
请不要执著于枯坐肉眼看代码,因为:一)不一定是你代码逻辑问题,可能是脏数据造成的,是老业务数据造成的,是分布式环境造成的,是其他子系统造成的;二)线上业务处于不稳定中,条件不允许问题定位无限期。
此时, 请立即在问题相关的调用链条上,一次性:
  • 在函数的入口和出口打印日志,同时打印输入、输出参数
  • catch(){……}里打印stacktrace,同时打印try块中关键变量的值(避免你发现某个异常是问题第一原因,却不知道是什么变量传入导致的)
  • 与其他模块交互的接口入口处打印输入参数,
即, 解决线上问题归根结底要靠log、a lot of log output!
在logging的力度上切勿犹犹豫豫,我们的工程师习惯于吝啬地找两个函数打印日志、打包部署一把、没看出来、再找几个函数打印、再部署、等着现象重现再观察、……,一来二去时间流逝,闲庭信步,从客服知道的小事故变成了全国皆知的大事故。
所以,再强调一遍: 在你的调用链条上,逐层调用的函数入口和出口都打印详细日志,不怕多只怕少,然后部署,等待现象重现,毕其功于一役!
 
我们要记录什么?
1)完成某项操作所需的时间

通过它可以跟踪为什么系统响应变慢或者太快

  • 处理完一个incoming request所耗费的时间,精确到毫秒
  • 执行数据库查询的时间
  • 从磁盘或者存储介质获取数据的时间
  • 等等
2)异常和堆栈跟踪
 
3)Sessions
知道一个问题是由谁引起的非常重要,因此在日志中使用会话标识符就变得必不可少。它可以简单到是一个 IP 地址或者是一个更复杂的 UUID,只要能区分不同的请求者就足够。
 
4)版本号
 
#工具
推荐的Java Logging框架
1)log4j:我们的配置是,log4j.appender.CONSOLE.layout.ConversionPattern= [%-d{yyyy-MM-dd HH\:mm\:ss.SSS}] [%p] [%c] [%m]%n;%p是日志优先级,%c是类目名,%m是输出信息,%n是回车换行符。
2)logback:log4j创建人Ceki Gülcü后续推出了SLF4J+logback。SLF4J(Simple Logging Facade for Java)作为commons-logging的替代,为各种logging APIs提供了一个简单的统一接口,使得最终用户能够在部署的时候配置所希望的logging APIs的实现。logback胜在性能,据称“某些关键操作,比如判定是否记录一条日志语句的操作,其性能得到了显著的提高。这个操作在logback 中需要3纳秒,而在 log4j 中则需要30纳 秒。 logback 创建记录器(logger)的速度也更快:13毫秒,而在 log4j 中需要23毫秒。更重要的是,它获取已存在的记录器只需94纳秒, 而 log4j 需要2234纳秒,时间减少到了1/23。跟java.util.logging(JUL)相比性能提高也是显著的”。
 
#配置
不要随便从网上找一个log4j的配置文件,请确认你理解每一个配置项
我们既然输出日志,自然期望在面对“ 这个问题是否从过去几天开始出现?”这样的疑问时,不至于发现你的rollingPolicy错误设置导致只能看到最近几小时的日志,或者日志发生时间没有精确到毫秒。
后面会张贴主站生产环境里的log4j配置。
 
#理念
可用grep抽取的日志:独立的行!
我们总是希望能用grep处理日志文件。这意味着: 一个日志条目永远不应该跨多行,除非你是堆栈打印
我们会用grep问日志什么问题呢?如:
  • 用手机号13910******下单的顾客最近三天内都来自于哪些IP?
  • 浏览地址是****?from=kfapi的顾客,但referral却是搜索引擎域名,最近三天有多少次?
  • 最近一周内,订单中心执行的所有事务,耗时最长的一次是多长时间?
  • ××××的接口是否真的于18:00发送了一个请求,我们收到的参数是什么?
确保你的日志能回答这样的问题。
 
不同关注领域写不同的日志文件
当访问和调用极其频繁,有时候你会发现把你的工程里什么信息都打印到一个日志文件里,会让你看得头昏脑胀。
最简单的示范就是Apache的访问日志和错误日志是分开的。
同样,你也可以把更加安静的事件(偶尔出现)与更加喧闹的事件分开存储。
如,对外的开放平台可以打印三种日志文件:connection log(建立链接和关闭链接,附带接入参数),message log(内部调用链),stacktrace log(异常的堆栈打印)。
 
#具体实现
至少精确到毫秒
日志必须包含时间戳,精确到至少毫秒级。
如果只是记录到秒级,我们曾明知代码因缺乏并发控制而产生BUG,却只能郁闷地看着精确到秒级的日志。
对Java来说,最好配置为: yyyy-MM-dd/HH:mm:ss.SSS
 
请尽可能打印明确的会话标识
日志条目里打印一个会话标识(A certain session identifier),当有许多并发请求打过来时,你就能基于此字段过滤 client 了。比如,我们司南日志会补充打印一个浏览器 cookies 里种下的 UUID 。
 
log4j的isDebugEnabled判断
如果打印信息是常量字符串或简单字符串拼接,那么不需要if ( log.isDebugEnabled() )。
如果你拼装的动作比较耗资源,请用if ( log.isDebugEnabled() )。
 
如有可能,请将性能数据标准化输出
这样更方便grep或hadoop做性能数据抽取和挖掘,从而能很轻松地转换为图形监控。
比如,订单中心的性能数据格式为: 树枝标志 当前节点起始时间 [当前节点持续时间, 当前节点自身消耗时间, 在父节点中所占的时间比例]
 
哪些位置需要部署性能检测点 
(1)访问数据库的dao层;
(2)访问外部资源的ext层;
(3)访问mq的方法;
(4)等等,一切不在你自己负责的工程掌握的部分(外部),或一切你认为自己工程的性能危险点,都需要加入性能监控日志。
 
 
#Sample
一个好的启动日志
http://images.cnblogs.com/cnblogs_com/zhengyun_ustc/255879/o_clipboard%20-013%20%E5%89%AF%E6%9C%AC.png
打印了应用的版本号,客户端的会话标识,关键步骤的执行时长。
 
一个好的堆栈跟踪日志
http://images.cnblogs.com/cnblogs_com/zhengyun_ustc/255879/o_clipboard%20-%20014%E5%89%AF%E6%9C%AC.png
 
 
参考资源:
1) 55最佳实践系列:MongoDB最佳实践  (2012-12-15 15:48)
2) 55最佳实践系列:Logging最佳实践  (2012-12-15 16:43)
3)
赠图1枚:
61e40352jw1dz3xp4brtbj.jpg (440×440)

© 著作权归作者所有

旁观者-郑昀
粉丝 101
博文 77
码字总数 162700
作品 0
朝阳
私信 提问
加载中

评论(1)

相见欢
相见欢
不断追求最佳实践,已经成为我以后开发的一个主要目标,向前辈学习
关于 Multiget hole:spymemcached对此的实现方法

火丁说: 『 Multiget的无底洞问题 Facebook在Memcached的实际应用中,发现了Multiget无底洞问 题,具体表现为:出于效率的考虑,很多Memcached应用都已Multiget操作为主,随着访问量的增加,...

旁观者-郑昀
2013/02/08
128
0
spymemcached :某个mc节点操作连续超时超过998次就 Auto-Reconne...

spymemcached 中,一个 mc client 与某一个 mc node 之间已建立的 connection 上, 如果执行操作屡屡超时(net.spy.memcached.OperationTimeoutException), 那么,有一个计数器专门记录超时...

旁观者-郑昀
2013/02/08
163
0
spymemcached 的 useNagle 问题与 TCP/IP延迟发送数据

先说一下结论。 如果你没有特意在 spymemcached 的 client bean definition 里配置 useNagleAlgorithm 属性为 True, 那么默认 spymemcached 是不启用 Nagle 算法的。 所以默认情况下不会引发...

旁观者-郑昀
2013/02/08
168
0
三个实例演示 Java Thread Dump 日志分析

dump 文件里,值得关注的线程状态有: 死锁,Deadlock(重点关注) 执行中,Runnable 等待资源,Waiting on condition(重点关注) 等待获取监视器,Waiting on monitor entry(重点关注) ...

小小小七
2014/07/24
56
0
三个实例演示 Java Thread Dump 日志分析

jstack Dump 日志文件中的线程状态 dump 文件里,值得关注的线程状态有: 死锁,Deadlock(重点关注) 执行中,Runnable 等待资源,Waiting on condition(重点关注) 等待获取监视器,Waiti...

旁观者-郑昀
2013/02/08
217
0

没有更多内容

加载失败,请刷新页面

加载更多

采购单品汇总_华南.xlsx

import pandas as pdimport matplotlib.pyplot as pltimport matplotlib as mp1mp1.rcParams["font.family"] = "STFangsong"# 加载《销售》表数据df1 = pd.read_excel(r"C:\Us......

龙玉滕
今天
5
0
OSChina 周五乱弹 —— 一次四千 要4次还能多给一千

Osc乱弹歌单(2019)请戳(这里) 【今日歌曲】 @这次装个文艺青年吧 :#今日歌曲推荐# 分享金志文的单曲《远走高飞》: 版权又回来了现在听歌得好几个软件 《远走高飞》- 金志文 手机党少年们...

小小编辑
今天
7
0
Spring Cloud Alibaba 实战(十) - Spring Cloud GateWay

> 本文主要内容是:为什么要使用网关,整合Gateway,Gateway核心学习:Route,Predicate,Filter,最后使用Gateway聚合微服务请求 先总结至此的架构 1 网关的价值 不使用网关行嘛? 各个请求直接打在...

JavaEdge
今天
4
0
【CKB.DEV 茶话会】第二期:聊聊 CKB 钱包和 Nervos DAO 全流程

CKB.DEV 茶话会第二期:聊聊 CKB 钱包和 Nervos DAO 全流程 为了鼓励更多优秀的开发者和研究人员参与到 CKB 的开发和生态建设中去,我们希望组织一系列 CKB Developer Seminar(CKB.DEV 茶话...

NervosCommunity
今天
4
0
聊聊rocketmq的HAClient

序 本文主要研究一下rocketmq的HAClient HAClient rocketmq-all-4.6.0-source-release/store/src/main/java/org/apache/rocketmq/store/ha/HAService.java class HAClient extends Serv......

go4it
昨天
4
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部