在软件工程和系统运维中，日记系统的伏击性可想而知，尤其是在支付交游系统中，它关于监控、故障排查和安全合规性起着至关伏击的作用。本文将深切研讨支付系统日记假想的最好执行，包括日记的中枢作用、假想原则和常见误区，以及何如构建一个结构清亮、易于监控和问题排查的日记系统。
也曾在多家头部互联网公司的多个中枢技俩组，齐有发现一些职责多年的资深工程师打印的日记亦然东倒西歪的，非论关于监控照旧排查问题齐极为艰辛，终末没宗旨唯独安排再行纠正日记，费时又繁重。是以聊聊这个话题。
本次主要讲结构清亮的日记在支付系统中的中枢作用，假想日记模范需要驯顺的一些基本原则，以及接口选录日记、业务选录日记、详备日记、特别日记等常用日记假想的最好执行。
一、什么是日记
写过代码的同学一定再闇练不外。日记实践等于一种系统记载文献，用于存储发生在操作系统、欺诈软件、收罗和存储建立上的事件，主要用于问题会诊、审计和监控。
比如PIC认证时，就会审核日记系统。
不外咱们最常用的仍然是用于查问题和监控告警。
二、日记关于支付系统启程点保险的伏击性
日记的伏击性信赖不必多说，莫得日记，系统上线后出问题就等于合手瞎。
在支付系统中，日记不仅用于记载交游信赖和系统现象，还起到监控和安全审计的作用。它们匡助咱们及时监控系统的健康现象，快速排查线上的问题。此外，在支付界限日记关于交游考据和法律合规性文档记载齐是不可或缺的。
三、日记假想的常见误区
好多职责多年的工程师根蒂莫得假想日记的办法，更别说何如去假想简约的日记，透顶是念念到哪就打印到哪。
比如过度记载。记载广大不消信息，导致伏击信息难以识别。每操作几步就打印一次。
比如身手杂沓。莫得合股的日记身手，监控系统无法按轨则进行切分，给监控告警、日记分析和问题定位带来艰辛。
还有冷落诡秘和安全。也不管什么是敏锐信息，是否要脱敏，径直toJsonString，增多数据露馅风险。比如卡号，身份证号，手机号等齐属于敏锐信息，不成径直打印到日记。
还有一个很常见的等于关节信息缺失。比如打印特别日记，只打印堆栈信息，没联系节的业务数据信息。
四、假想清亮日记模范的基本原则
凭证这样多年的执行，假想一个清亮的日记系统最少应免除以下原则：
分辩日记种类：接口选录日记，业务选录日记，详备日记，特别日记等各自有本身的侧重心，要分辩打印，不扫数打印在一个日记文献中。
结构化日记：使用结构化数据身手记载，便于机器分解。这个尤其对监控系统灵验。
日记分级：合理设立日记级别（如DEBUG、INFO、WARN、ERROR），便于过滤和搜索。
尺度化字段：尺度化常用字段（如手艺戳、日记级别、恳求ID等），保持一致性。
高下文信息：确保日记含有满盈的高下文信息，便捷定位问题。尤其是详备日记，一定要打印高下文信息。
脱敏解决：关于敏锐数据，如手机号、卡号等，进行合乎的脱敏解决。
散播式跟踪ID：引入散播式跟踪系统，为跨处事的恳求分派惟一的跟踪ID。
五、最好执行
领先咱们要显著日记是用来作念什么的。仅仅先弄显著作念事的盘算，咱们才调更好把事情作念对。
在我看来，日记有两个中枢的作用：
1）监控，会诊系统或业务是否存在问题；
2）排查问题。
关于监控而言，咱们需要知说念几个中枢的数据：业务/接口的恳求量、告捷量、告捷率、耗时，系统复返码、业务复返码，特别信息等。
关于排查问题而言，咱们需要有进出参、中间解决数据的高下文，报错的高下文等。
接下来，基于上头的分析，咱们就明晰咱们应该有几种日记：
接口选录日记。监控接口的恳求量、告捷量、耗时、复返码等。使用固定身手，需要打印：手艺、接口称号、成果（告捷/失败)、复返码、耗时等基本信息就满盈。
业务选录日记。监控业务的恳求量、告捷量、中枢业务信息、复返码等。使用固定身手，需要打印：手艺、业务类型、上一步现象、现时现象、复返码、中枢业务信息（不同行务有不同的中枢业务信息，比如流入，就有支付金额/退款金额，卡品牌，卡BIN等)。
详备日记。用于排查问题，不消于监控。身手不固定。主要包括手艺、接口、入参、出参，中间解决数据输入，特别的堆栈信息等。
系统特别日记。同期用于监控。身手固定。需要打印：手艺、造作码、造作信息、堆栈信息等。
补充一个典型的支付场景下的业务日记身手如下：
文献名：payment.biz.digest.log
身手模范：
[手艺,散播式跟踪ID,环境标,压测标,站点标,恳求源头系统,上游恳求ID,上游支付ID,本身系统业务ID],[交游类型,交游币种,交游金额,上一个现象,现时现象],[渠说念名,收单国度,发夹行,卡品牌,风控参数],[本身尺度复返码,本身尺度复返码描摹,渠说念复返码,渠说念复返码描摹]
日记示例：
[2024-01-04 20:02:32.239,293242318382329329232,P,0,UK,payment,2024010401203223220001,2024010401203223220001,2024010401203223220003],[pay,USD,2392,INIT,PAYING],[WPG,US,CMB,VISA,2D],[-,-,-,-]
诠释：上头的日记使用进行了块分隔，第一个内部是基础信息，第二个内部是交游信息，第三个内部是渠说念信息，第四个内部是复返码信息。
使用切割的克己是，如若后头要加字段，不错找到对应的位置增多。不影响现存监控。比如我要加个卡BIN，那就不错在风控参数后头加，不影响复返码监控位置。
有几点绝顶补充诠释：
平淡业务和系统特别需要拆分出来。NPE等于系统特别，余额不及等于一个预期内的业务场景，不要打印到特别文献中。
业务选录信息需要凭证业务不同，假想不同的业务选录日记身手。比如支付、流出提现的交游，路由、渠说念连接等，监控诉求是不相同的，是以需要单独假想。拿路由例如，需要监控哪些渠说念分流了几许，掷中了哪个轨则等，势必不成径直使用支付、退款的业务选录日记身手。是以每出现一种新业务，就需要单独假想一种业务日记。
接口选录日记，不要打印进出参。因为进出参有可能包含特别多数据，而接口咱们只热心恳求量、成果、耗时这些就够了，如若念念查进出参，就去详备日记内部查。
系统特别日记一定要有单独的日记文献。因为平淡的系统，绝大部分是业务上报错，比如风控隔绝，而不应该有好多NPE等系统特别。咱们需要监控特别日记的行数或特定造作码的频率，比如每分钟有X行或每分钟有Y个特定造作码就需要告警出来。
六、铁心语
一个简约假想的日记系统不错为监控、告警和问题排查提供强有劲的支援，反之，关于线上问题险些等于恶梦。
今上帝要讲了日记身手模范的假想，关于log4j的成就什么的，网上依然有好多公开贵寓，这里不再赘述。另外，散播式环境底下还有日记转存、查询等，亦然一个很广大的体系。
内容已收录到《图解支付系统假想与终了》。