日志规范多重要,这篇文章告诉你!

发表于 4年以前  | 总阅读数:1024 次

本文脉络

  • 1 日志的重要性
    • 1.1 写好业务代码很重要
    • 1.2 记好日志一样重要
  • 日志要素
  • 记录时机
  • 日志框架
  • 总结

1 日志的重要性

1.1 写好业务代码很重要

在开发过程中,写好业务代码的重要性不言而喻,毕竟这是跟程序功能最密切相关的工作,程序出 BUG,一般就是业务代码写得有问题了。

1.2 记好日志一样重要

做好日志记录,也是非常重要的,通过查看日志,能帮我们解决很多问题,以下是开发过程中经常会碰到的一些问题:

程序是不是按预期执行?

我们可以通过日志记录程序的执行流程、运行状态、关键指标⋯⋯有了这些日志,才能更好地进行调试跟踪。

程序有BUG怎么办?

有BUG得排查问题,而定位问题最高效的方式,就是日志。我们总不能一行行代码排查,或者掐指一算随便蒙,不然问题没找到,更不用谈修复上线。

用户在系统上干了什么?

这就需要结合业务,记录用户操作行为。用户登录到退出系统中间,所有的重要操作,都应该形成日志,作为审计的依据。

这个问题是谁造成的?

在大型应用中,不同系统之间的协作相当紧密,有时系统出问题了,可能是第三方系统造成的,通过在程序交互的关键位置记好日志,就能减少不必要的扯皮。

日志要素

既然日志这么重要,一份好的日志,应该具备哪些要素呢?结合工作中的积累,我把日志要素总结为以下这张图(绿色部分是必选项,红色部分酌情选择):

日志时间

日志作为事件的表述,事件发生的时间一定要有,而且应该精确,推荐的格式是:

yyyy-MM-dd HH:mm:ss.SSS

日志级别

应该根据日志的重要性或严重程度划分等级,最常用的日志级别有:DEBUGINFOWARNERROR,只有合理定义日志级别,才能避免日志混乱。

  • DEBUG:调试,在开发、测试阶段使用,记录调试性质的内容,生产上应该关闭该级别的日志,减少频繁打印导致程序性能受影响及存储空间的浪费。
  • INFO:信息,记录系统正常运行期间的关键信息,主要是程序运行度量、业务操作记录两部分内容,分别用于系统监控及业务审计。
  • WARN:警告,用于程序告警,造成这些告警的原因是可预期有规划的,比如请求参数不合法、系统资源紧张但可等待恢复、依赖方不可用但允许临时降级。
  • ERROR:错误,记录不可预知的程序异常。比如网络调用、数据库访问等低层资源造成的错误,应用层面没有预期到的,这种错误日志数量上应该很少,内容上应该尽量详尽记录出错成因。

线程名称

特别在 Web 应用程序中,一次同步请求一般对应一个处理线程,输出线程名称可以区分一次具体的请求上下文。

业务标识

用来区分日志属于哪块业务,因为日志都是跟业务相关联的,通过该部分内容便于按业务进行日志归类聚合。

记录器名称

日志的记录器名称一般是声明日志记录器实例的类名,通过记录器名称可以快速定位到日志输出的类是哪个。

日志内容

根据不同的日志等级,在日志内容上会有不同的侧重点,但在内容输出上,有一些点是需要注意的:

  • 通过日志框架而不是直接使用程序输出流(System.outSystem.err)来打印日志内容。
  • 除了开发环境,其它线上环境应该采用文件日志而不是控制台日志,一方面是日志持久化,另一方面是程序性能考虑。
  • 日志内容应该异步输出,而不是同步阻塞的方式,特别是大迸发应用场景下更应该注意。
  • 善用占位符特性,一般日志框架都有占位符功能,避免不必要的字符串拼接。
  • 预防日志内容构建过程中的空指针异常、多余的对象序列化、不必要的中间过程执行。
  • 注意敏感内容输出,造成的安全隐患,比如用户密码、账户信息等。

OpenTracing 标识

通过 AOP 切面,日志框架 MDC 等技术结合,在日志上添加一些链路追踪的扩展元素,将会很大程度方便通过日志进行程序请求调用的链路追踪,这在分布式系统中尤其重要。

异常堆栈

堆栈异常信息有助于程序异常的排查定位,但这部分信息的记录输出,对系统性能有一定的影响,应该酌情考虑,如果记录异常信息足够定位异常的,就不要打印整个堆栈。一般是ERROR打印异常堆栈,WARN不打印,还有就是通过日志框架打印,避免用printStackTrace方法打印。

产生行数

即产生日志的源代码行,该记录对程序性能有比较大的影响,也应该谨慎使用,前面谈到通过记录器名称跟类名关联,很大程度上能帮我们定位产生日志的代码范围,行信息就可以不用了。

日志输出格式

记录时机

程序流程

记录程序的流转分支,在关键代码逻辑的执行前后进行相应的日志输出,有助于代码调试。但要避免不必要的日志输出,比如一般只在循环体前后记录日志,而不在循环体内重复记录,过多的日志反而会影响阅读。

远程调用

远程调用也属于程序流程的一部分,但第三方远程调用的日志信息级别,应该比一般的调试日志区别对待,因为涉及到外部系统的交互,在出入口处记录请求响应的信息,相当重要。

系统初始化

系统初始化需要依赖一些关键配置参数,这些参数决定系统的启动状态,应该把这些系统初始化信息记录起来。

核心业务操作

系统用户进行核心业务操作的行为,也应该进行记录,便于进行操作审计。

可预期的异常

这类异常应该有效记录起来,通过警告方式反馈给相关人员加以关注,避免频繁发生,最终演化为不可控的错误。

预期外的错误

这类异常发生时,要有详尽记录,并通知相关人员介入处理,第一时间作出响应,因为这种错误已经影响系统的正常使用。

日志框架

在 Java 应用中,日志打印涉及到的组件工具主要如下图所示:

![](https://oss-cn-hangzhou.aliyuncs.com/codingsky/cdn/img/opt/1/fb25eb277fedbc3e1ea1a1dc57dd2903)

中间部分是日志输出的核心,除了 Logback 外,常用的还有 Log4j/Log4j 2,Log4j 已经有点过时,而 Log4j 2 在异步日志的性能表现上,比 Logback 更加突出。

总结

本文主要讲的是日志的一些相关概念,包括日志要素、记录时机、日志框架的简单介绍,日志很重要,好的系统离不开日志。后续会对这些进行细化,从技术实现的角度,分享应用日志性能提升、日志采集汇总、日志统计分析、分布式系统链路跟踪等内容,以及在工作中遇到的一些日志坑,后续会分享架构其他方向文章。

下篇预告:本文承上启下介绍了日志的重要性,下篇文章会分享基于非aop跨语言、高性能方式实现用户操作日志,一篇非常高大上的实战篇,记得mark哦!

本文作者:吴滨 。 某大型快递公司架构师,拥有多年编码经验和架构经验,在宝典哥无理由强制请了多次奶茶之后内心不安于是决定投稿抵账,才有了今天的文章。

本文由哈喽比特于4年以前收录,如有侵权请联系我们。
文章来源:https://mp.weixin.qq.com/s/6IzKu0_yG-4S619qmQE1pQ

 相关推荐

刘强东夫妇:“移民美国”传言被驳斥

京东创始人刘强东和其妻子章泽天最近成为了互联网舆论关注的焦点。有关他们“移民美国”和在美国购买豪宅的传言在互联网上广泛传播。然而,京东官方通过微博发言人发布的消息澄清了这些传言,称这些言论纯属虚假信息和蓄意捏造。

发布于:7月以前  |  808次阅读  |  详细内容 »

博主曝三大运营商,将集体采购百万台华为Mate60系列

日前,据博主“@超能数码君老周”爆料,国内三大运营商中国移动、中国电信和中国联通预计将集体采购百万台规模的华为Mate60系列手机。

发布于:7月以前  |  770次阅读  |  详细内容 »

ASML CEO警告:出口管制不是可行做法,不要“逼迫中国大陆创新”

据报道,荷兰半导体设备公司ASML正看到美国对华遏制政策的负面影响。阿斯麦(ASML)CEO彼得·温宁克在一档电视节目中分享了他对中国大陆问题以及该公司面临的出口管制和保护主义的看法。彼得曾在多个场合表达了他对出口管制以及中荷经济关系的担忧。

发布于:7月以前  |  756次阅读  |  详细内容 »

抖音中长视频App青桃更名抖音精选,字节再发力对抗B站

今年早些时候,抖音悄然上线了一款名为“青桃”的 App,Slogan 为“看见你的热爱”,根据应用介绍可知,“青桃”是一个属于年轻人的兴趣知识视频平台,由抖音官方出品的中长视频关联版本,整体风格有些类似B站。

发布于:7月以前  |  648次阅读  |  详细内容 »

威马CDO:中国每百户家庭仅17户有车

日前,威马汽车首席数据官梅松林转发了一份“世界各国地区拥车率排行榜”,同时,他发文表示:中国汽车普及率低于非洲国家尼日利亚,每百户家庭仅17户有车。意大利世界排名第一,每十户中九户有车。

发布于:7月以前  |  589次阅读  |  详细内容 »

研究发现维生素 C 等抗氧化剂会刺激癌症生长和转移

近日,一项新的研究发现,维生素 C 和 E 等抗氧化剂会激活一种机制,刺激癌症肿瘤中新血管的生长,帮助它们生长和扩散。

发布于:7月以前  |  449次阅读  |  详细内容 »

苹果据称正引入3D打印技术,用以生产智能手表的钢质底盘

据媒体援引消息人士报道,苹果公司正在测试使用3D打印技术来生产其智能手表的钢质底盘。消息传出后,3D系统一度大涨超10%,不过截至周三收盘,该股涨幅回落至2%以内。

发布于:7月以前  |  446次阅读  |  详细内容 »

千万级抖音网红秀才账号被封禁

9月2日,坐拥千万粉丝的网红主播“秀才”账号被封禁,在社交媒体平台上引发热议。平台相关负责人表示,“秀才”账号违反平台相关规定,已封禁。据知情人士透露,秀才近期被举报存在违法行为,这可能是他被封禁的部分原因。据悉,“秀才”年龄39岁,是安徽省亳州市蒙城县人,抖音网红,粉丝数量超1200万。他曾被称为“中老年...

发布于:7月以前  |  445次阅读  |  详细内容 »

亚马逊股东起诉公司和贝索斯,称其在购买卫星发射服务时忽视了 SpaceX

9月3日消息,亚马逊的一些股东,包括持有该公司股票的一家养老基金,日前对亚马逊、其创始人贝索斯和其董事会提起诉讼,指控他们在为 Project Kuiper 卫星星座项目购买发射服务时“违反了信义义务”。

发布于:7月以前  |  444次阅读  |  详细内容 »

苹果上线AppsbyApple网站,以推广自家应用程序

据消息,为推广自家应用,苹果现推出了一个名为“Apps by Apple”的网站,展示了苹果为旗下产品(如 iPhone、iPad、Apple Watch、Mac 和 Apple TV)开发的各种应用程序。

发布于:7月以前  |  442次阅读  |  详细内容 »

特斯拉美国降价引发投资者不满:“这是短期麻醉剂”

特斯拉本周在美国大幅下调Model S和X售价,引发了该公司一些最坚定支持者的不满。知名特斯拉多头、未来基金(Future Fund)管理合伙人加里·布莱克发帖称,降价是一种“短期麻醉剂”,会让潜在客户等待进一步降价。

发布于:7月以前  |  441次阅读  |  详细内容 »

光刻机巨头阿斯麦:拿到许可,继续对华出口

据外媒9月2日报道,荷兰半导体设备制造商阿斯麦称,尽管荷兰政府颁布的半导体设备出口管制新规9月正式生效,但该公司已获得在2023年底以前向中国运送受限制芯片制造机器的许可。

发布于:7月以前  |  437次阅读  |  详细内容 »

马斯克与库克首次隔空合作:为苹果提供卫星服务

近日,根据美国证券交易委员会的文件显示,苹果卫星服务提供商 Globalstar 近期向马斯克旗下的 SpaceX 支付 6400 万美元(约 4.65 亿元人民币)。用于在 2023-2025 年期间,发射卫星,进一步扩展苹果 iPhone 系列的 SOS 卫星服务。

发布于:7月以前  |  430次阅读  |  详细内容 »

𝕏(推特)调整隐私政策,可拿用户发布的信息训练 AI 模型

据报道,马斯克旗下社交平台𝕏(推特)日前调整了隐私政策,允许 𝕏 使用用户发布的信息来训练其人工智能(AI)模型。新的隐私政策将于 9 月 29 日生效。新政策规定,𝕏可能会使用所收集到的平台信息和公开可用的信息,来帮助训练 𝕏 的机器学习或人工智能模型。

发布于:7月以前  |  428次阅读  |  详细内容 »

荣耀CEO谈华为手机回归:替老同事们高兴,对行业也是好事

9月2日,荣耀CEO赵明在采访中谈及华为手机回归时表示,替老同事们高兴,觉得手机行业,由于华为的回归,让竞争充满了更多的可能性和更多的魅力,对行业来说也是件好事。

发布于:7月以前  |  423次阅读  |  详细内容 »

AI操控无人机能力超越人类冠军

《自然》30日发表的一篇论文报道了一个名为Swift的人工智能(AI)系统,该系统驾驶无人机的能力可在真实世界中一对一冠军赛里战胜人类对手。

发布于:7月以前  |  423次阅读  |  详细内容 »

AI生成的蘑菇科普书存在可致命错误

近日,非营利组织纽约真菌学会(NYMS)发出警告,表示亚马逊为代表的电商平台上,充斥着各种AI生成的蘑菇觅食科普书籍,其中存在诸多错误。

发布于:7月以前  |  420次阅读  |  详细内容 »

社交媒体平台𝕏计划收集用户生物识别数据与工作教育经历

社交媒体平台𝕏(原推特)新隐私政策提到:“在您同意的情况下,我们可能出于安全、安保和身份识别目的收集和使用您的生物识别信息。”

发布于:7月以前  |  411次阅读  |  详细内容 »

国产扫地机器人热销欧洲,国产割草机器人抢占欧洲草坪

2023年德国柏林消费电子展上,各大企业都带来了最新的理念和产品,而高端化、本土化的中国产品正在不断吸引欧洲等国际市场的目光。

发布于:7月以前  |  406次阅读  |  详细内容 »

罗永浩吐槽iPhone15和14不会有区别,除了序列号变了

罗永浩日前在直播中吐槽苹果即将推出的 iPhone 新品,具体内容为:“以我对我‘子公司’的了解,我认为 iPhone 15 跟 iPhone 14 不会有什么区别的,除了序(列)号变了,这个‘不要脸’的东西,这个‘臭厨子’。

发布于:7月以前  |  398次阅读  |  详细内容 »
 相关文章
Android插件化方案 5年以前  |  236859次阅读
vscode超好用的代码书签插件Bookmarks 1年以前  |  6838次阅读
 目录