应用系统日记打印标准理论之道

若是你是一名优良的应用系统开发人员，想必应该十分清晰在应用系统运行期间，打印日记有多么重要。它不单可以记录应用系统运行情况及轨迹，还有助于提拔毛病排查及定位问题的效率，以至还能够对其停止阐发及监控，洞察系统隐患，提早预警防备。

但并非说只要打印尽可能多的日记，就能轻松获得那些才能。设想一下，若是你毫无所惧地打印了一堆毫无价值的日记，那请问日记又何以可以来为你供给价值呢。由此可见，那里的核心关键点其实不在于日记的几，而在于日记打印能否标准且合理。

不标准合理的日记，不单无法阐扬感化产生价值，还会增加毛病定位难度、降低处理效率，以及额外增加日记存储成本，消耗应用系统性能。在极端情况下，以至还会对应用系统形成致命性冲击，引发应用系统瘫痪的可能。

讲到那，我想你应该大白我想说的——应用系统日记打印确实十分重要，但日记打印标准将更为重要，它就像一把双刃剑，只要合理运用才气阐扬其特有的感化及价值。

但在组织中，若是你想让你四周的人都能大白那个事理可其实不容易，它需要一个漫长的传布过程，而在那个过程中，你不只需要对峙不竭地宣导来逐渐加强他们的认知，还应借助需要的治理手段及东西平台停止辅助，只要利其所器，才气善其所事。

利器一：标准先行

在你想启动标准化日记打印前，建议先造定一份日记打印标准，它可能无法八面玲珑，但没有关系，它的目标仅是为了先突显日记打印标准的重要性，而且让那件工作可以正式进入正轨。

若是组织中大部门都是Java应用，那么标准内容能够次要围绕Java应用来写，固然无法笼盖所有开发语言，但其核心原则仍是能够借鉴的。别的，前期请务必不要将其复杂化，不然它将无法具备普适性，也无法被承受和传布。

Java应用系统日记打印标准

1）Java日记框架

常用的Java日记框架可选择Log4j/Logback/Log4j2等，但为了制止后续改换日记框架所带来的额外革新成本，建议将接口层和实现层停止别离，将SLF4J做为接口层，将Log4j/Logback/Log4j2做为实现层，两者通过桥接的体例停止集成。

2）Java日记标准

标准一：【强迫】级别只允许利用ERROR、WARN、INFO、DEBUG，定义如下：

标准二：【强迫】制止利用Logback/Log4j2等的API，应利用SLF4J的API。

标准三：【强迫】在接口/办法的入口/出口处，打印恳求及响应参数日记。

标准四：【强迫】ERROR级别日记需打印仓库，而非ERROR级别日记则不需要。

标准五：【强迫】制止在代码轮回体中间接打印非DEBUG级此外日记。

标准六：【强迫】制止日记打印内容中仅打印特殊字符或数字的情况。

标准七：【建议】日记内容中应包罗关键特征类信息，例如：用户标识或流水号。

标准八：【建议】应接纳异步打印形式，且打印时建议封闭打印位置信息。

标准九：【建议】日记打印若呈现梗塞，建议至少丢弃INFO级别以上的日记。

标准十：【建议】每条日记在语义上可独立被理解，削减上下文联系关系理解。

*）Java日记字段

注：位置信息包罗类(class)/文件(file)/行号(line)/办法(method)，若打印位置信息，则对性能有所影响。

以上仅是一些标准参考，你能够按照组织中的现实情况来停止调整，但标准仅仅只是标准，有了它其实不代表你已达成目的，只能申明你已为日记打印标准化那件事，迈出了第一步。

利器二：办事至上

当造定完应用系统日记打印标准后，请不要梦想有任何人会来自觉地遵守它，一是不知它的存在，二是他们无从下手，三是各人都挺“忙”的。我把它总结为六字实言，别离是“不知”、“不会”、“不想”。

我曾见过组织中的有些标准，出格是手艺标准，在造定完成后就会被长久地封存起来，没有人晓得，也没有人想晓得。所以，要落实好标准，你还得构想一套战术才行。不然，那些无法落实的标准就和废纸毫无两样。

在良多人眼里，可能会将标准视为是一种约束，而又错误地将约束理解为贬义词，从而避而远之。那种曲解的发作，其原因其实不出在他们自己，而更多的出在那些造定例范的人身上。

有些标准造定者不单没有身在此中，以至也没有去诠释标准所能带来的价值，而仅仅只是强行推行那份冷冰冰的标准，请问此时谁会愿意在不知其所以然的情况下，无缘无故地背上那繁重的“承担”。

因而，你必需得为那份标准付与更多的“温度”，而主动办事可能会是一种比力好的“升温”体例。但在动作前，切忌不要站在他们的对立面，并请做好放低姿势的觉悟，你要让对方深入的意识到你和他们是统一阵营的。

在发布标准后的初期，你能够测验考试挑选几个日记打印情况最为蹩脚的应用系统，饰演为“VIP私家助理”来与对方进一步传达标准内容及感化，并为他们一一列举出当前存在的日记打印问题，以及那些问题会对系统形成哪些影响。

那种体例不单可以制止仅用文字传达所产生的理解误差，及时有效地为对方解答各类疑问，使他们可以更深一步天文解标准内容及感化，还可以让标准造定者更进一步地领会对方的顾忌及困难，并从同理心视角动身，为对方供给更好的建议及处理思绪。

就如许*个、10个、1*个应用系统......在精神有限的前提下逐渐扩大辐射范畴，事实证明，那种主动办事+循序渐进的体例对提拔标准的承受度将会有所帮忙。不外在过程中你仍然需要不竭回看标准的合理性及适用性，并对标准做出及时且有效的调整。

利器三：度量为王

当标准逐步被更多的人承受后，你的任务并没有完成，而实正的考验才刚刚起头。一是承受其实不代表整改，二是若何验证整改有效性，三是整改能否可持续性。若是那些问题都不在你的考虑范畴内，那你可能会前功尽弃。

若想要处理以上那些问题，借助度量或许会是一个不错的选择。办理巨匠德鲁克曾说过：“没有度量，就没有办理”，它同样适用于标准的落实工做，你能够按照日记打印标准来造定一些度量目标，并配套研发响应的度量东西平台。

通过度量东西平台“可视化”和“自助化”的两种特征，闪开发人员可以及时发现日记打印标准的问题，还可以让他们自主验证日记打印标准整改后的效果，从而让他们感触感染到一种“看得见”+“摸得着”的平安感。

此中，度量目标的设想将会尤其重要，往往一个不合理的目标，会让整个工作朝着料想中的反标的目的开展。所以，在初期其实不建议你设想过多的度量目标，并建议从度量难度、影响水平、达成难度、可解释性四个方面停止综合性评估，以确定较为合理的目标。

如下是其时初期选择的8个目标。

注：以上仅列出目标，目标要求建议你可按照现实情况停止动态调整，但过高的目标要求会变得毫无意义。

可能会有人提出，关于规模较大且日记条数较多的应用系统，能否可放宽目标要求，那听上去仿佛蛮有事理的，但我却其实不那么认为。规模越大意味着所承载的职责和才能也就越大，一旦发作毛病影响面也就越大，所以反倒更应该到达目标要求。

那些目标固然有必然的指点性，但似乎其实不能满足开发人员的“胃口”，因为那些目标仍然无法间接表露问题根源，也无法让他们可快速定位及明白优化标的目的。因而，你还得付与目标必然的阐发才能。

例如：订单系统单日ERROR级别日记888条（占日记总量0.0*%），（TOP1）*0%在com.OrderService的第88行。（TOP2）10%在com.PayService的第188行。

就如许，你能够逐渐完美目标系统及配套的阐发才能，但请在设想每一个目标时，遵照先辈行系统现状摸排，再停止小范畴试点运行，最初停止持续不雅测并调优，从而确保每一个目标的设想都具备必然的合理性和可解释性。

如下列出了一些目标，仅供参考。

除此之外，你还能够将差别应用系统的目标停止横向比照，并接纳排行榜的形式在科技内部停止公开，它将会产生一种改动行为的驱动力，能够有效激发“想要赢”和“不想失败”的心理活动，那就比如某些产物也会接纳排行榜的体例来鼓励用户一样。

通过设想目标系统+研发度量平台+公开排行榜单那三个手段的组合，在必然水平上能够驱动开发人员持续性整改日记打印的问题。但万事无绝对，那些始末无动于衷的人仍然会存在，不外请不要强行要求对方，究竟结果有时候存期近合理。

写在最初

日记打印标准当然重要，但也请不要过火逃捧，它的核心价值仍是在于可以帮忙开发人员更好地记录应用系统的“案发现场”，并可为应用系统供给可持续改良的“线索”。但请服膺，日记打印标准虽不是全能的，但没有日记打印标准却是千万不克不及的。

做者丨陈俊

来源丨公家号：手艺奇奥物语（ID：gh_cfee2fb*4*bc）

021yin.com

更多出色内容

11月1*日下战书14:00，dbaplus社群联袂中国银行，围绕“中国银行运维转型与敏捷开发摸索理论”那一主题开展线上曲播分享，针对运维监控、混沌工程、DevOps等内容停止深度切磋，为金融业的数字化转型供给更多新思绪。

021yin.com/*t8OC

关于我们

dbaplus社群是围绕Database、BigData、AIOps的企业级专业社群。资深大咖、手艺干货，每天精品原创文章推送，每周线上手艺分享，每月线下手艺沙龙，每季度GdevopsDAMS行业大会。

存眷公家号【dbaplus社群】，获取更多原创手艺文章和精选东西下载