`
zhengyun_ustc
  • 浏览: 82806 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

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

阅读更多
@郑昀汇总 创建日期: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
 
 
参考资源:

2)55最佳实践系列:Logging最佳实践 (2012-12-15 16:43)
3)

赠图1枚:
61e40352jw1dz3xp4brtbj.jpg (440×440)
分享到:
评论
1 楼 magicyang919 2014-01-14  
写的不错,值得学习

相关推荐

    标准库系列:logging 日志打印 - 小康要好好学习 - 博客园.html

    标准库系列:logging 日志打印 - 小康要好好学习 - 博客园.html

    jboss-logging-3.4.3.Final-API文档-中文版.zip

    赠送jar包:jboss-logging-3.4.3.Final.jar; 赠送原API文档:jboss-logging-3.4.3.Final-javadoc.jar; 赠送源代码:jboss-logging-3.4.3.Final-sources.jar; 赠送Maven依赖信息文件:jboss-logging-3.4.3.Final....

    jboss-logging-3.4.1.Final-API文档-中文版.zip

    赠送jar包:jboss-logging-3.4.1.Final.jar; 赠送原API文档:jboss-logging-3.4.1.Final-javadoc.jar; 赠送源代码:jboss-logging-3.4.1.Final-sources.jar; 赠送Maven依赖信息文件:jboss-logging-3.4.1.Final....

    Greenplum 数据库最佳实践

    最佳实践的掌握需要对Greenplum的架构、工具集和最佳配置有深刻的理解,并结合实际业务情况进行动态调整。通过实施这些最佳实践,可以确保数据库集群的稳定运行,提升查询性能,优化资源利用,同时也能快速应对业务...

    logging-interceptor-3.14.4.jar

    logging-interceptor-3.14.4的jar包,用于okhttp网络拦截器

    jboss-logging-3.3.2.Final-API文档-中文版.zip

    赠送jar包:jboss-logging-3.3.2.Final.jar; 赠送原API文档:jboss-logging-3.3.2.Final-javadoc.jar; 赠送源代码:jboss-logging-3.3.2.Final-sources.jar; 赠送Maven依赖信息文件:jboss-logging-3.3.2.Final....

    《Java Enterprise 最佳实践》【1】 JDBC最佳实践

    《Java Enterprise 最佳实践》是Java开发者们深入理解企业级应用开发的重要参考资料,尤其是其中的JDBC最佳实践部分,对于数据库交互的优化和性能提升有着关键性的影响。JDBC(Java Database Connectivity)是Java...

    jboss-logging-3.4.2.Final-API文档-中文版.zip

    赠送jar包:jboss-logging-3.4.2.Final.jar; 赠送原API文档:jboss-logging-3.4.2.Final-javadoc.jar; 赠送源代码:jboss-logging-3.4.2.Final-sources.jar; 赠送Maven依赖信息文件:jboss-logging-3.4.2.Final....

    DevOps实战 VMware管理员运维方法、工具及最佳实践.pdf

    DevOps 实战 - VMware 管理员运维方法、工具及最佳实践 在 IT 行业中,DevOps 已经成为一个热门话题,越来越多的企业开始实施 DevOps 理念,以提高软件交付速度和质量。然而,对于 VMware 管理员来说,如何实施 ...

    smokeping启动脚本

    smokeping启动脚本 service smokeping start/stop/restart/reload

    commons-logging-1.1.3-API文档-中文版.zip

    赠送jar包:commons-logging-1.1.3.jar; 赠送原API文档:commons-logging-1.1.3-javadoc.jar; 赠送源代码:commons-logging-1.1.3-sources.jar; 赠送Maven依赖信息文件:commons-logging-1.1.3.pom; 包含翻译后...

    commons-logging-1.1.1-API文档-中英对照版.zip

    赠送jar包:commons-logging-1.1.1.jar; 赠送原API文档:commons-logging-1.1.1-javadoc.jar; 赠送源代码:commons-logging-1.1.1-sources.jar; 赠送Maven依赖信息文件:commons-logging-1.1.1.pom; 包含翻译后...

    Python最佳实践指南(彩色阅读版)

    《Python最佳实践指南》是一本深入探讨Python编程的权威书籍,尤其强调了代码质量和效率的提升。虽然标签中提到了"java",但显然这里我们关注的是Python编程领域。本书以彩色阅读版的形式呈现,旨在提供更为直观和易...

    sloth:现代的基于浏览器的 XMPP 客户端 (WIP)

    2014-12-11 13:44:21.803:INFO::main: Logging initialized @4524ms 2014-12-11 13:44:22.880:INFO:oejs.Server:main: jetty-9.2.5.v20141112 2014-12-11 13:44:22.904:INFO:oejs.ServerConnector:main: Started ...

    Oracle运维最佳实践-上.pdf 带书签

    **Oracle运维最佳实践**是指在管理与维护Oracle数据库系统过程中遵循的一系列高效、安全的操作方法和技术策略。这些实践旨在提高数据库性能、确保数据完整性和安全性的同时降低运营成本。本书旨在通过一系列深入浅出...

    Tomcat最佳实践T.omcat最佳实践

    在【目录】中,我们看到Tomcat的最佳实践涵盖了多个方面: 1. **WEB SERVER介绍**:讲解了Web服务器的不同类型,如Jetty、Tomcat、Jweb、JBoss AS、GlassFish、Weblogic和WebSphere。其中,Tomcat因其良好的集群和...

    Python自动化运维 技术与最佳实践

    Python自动化运维技术与最佳实践是IT领域中一个重要的主题,特别是在现代数据中心和云计算环境中,运维工作日益复杂,Python因其简洁、强大的库支持和丰富的社区资源,成为自动化运维的首选语言。本资源集提供了深入...

    commons-logging-1.1.3-API文档-中英对照版 (2).zip

    赠送jar包:commons-logging-1.1.3.jar; 赠送原API文档:commons-logging-1.1.3-javadoc.jar; 赠送源代码:commons-logging-1.1.3-sources.jar; 赠送Maven依赖信息文件:commons-logging-1.1.3.pom; 包含翻译后...

    commons-logging-1.2-API文档-中文版.zip

    赠送jar包:commons-logging-1.2.jar; 赠送原API文档:commons-logging-1.2-javadoc.jar; 赠送源代码:commons-logging-1.2-sources.jar; 包含翻译后的API文档:commons-logging-1.2-javadoc-API文档-中文...

    commons-logging-1.0.4.zip

    《Apache Commons Logging详解》 Apache Commons Logging(简称Commons Logging)是Apache软件基金会的一个开源项目,它是Java平台上的一个轻量级的日志记录抽象层。这个库的主要目标是为Java应用程序提供一个简单...

Global site tag (gtag.js) - Google Analytics