本期内容概述
本文主要阐述并整理了在进行项目开发时关于日志记载方面的一些个人考虑，其间也参考了比如阿里巴巴开发手册等等的一些日志标准主张，但并没有完全的照搬照抄。
文末给出了一个集中日志展现剖析渠道的建造方案，期望能协助到有需要的同学
日志的概述
日志的界说
日志是一种依照时间顺序存储记载的数据，它记载了什么时间产生了什么事情，提供精确的体系记载，依据日志信息能够定位到过错概况和本源。
日志是依照过错等级分级的，常见的过错等级有ERROR/ WARNING / INFO / DEBUG /TRACE 5种类型。通常咱们会在项目里边界说一个日志打印等级，高于这个等级的过错日志会数据落盘
日志的价值
1.日志所记载的信息方便体系进行排错，告警，优化功能
2.用户行为的剖析，协助产品经理以及运营人员进行事务决策
3.排查反常访问，安全进犯，进行审计跟踪
项目日志标准
强制标准
运用中不可直接运用日志体系中的 API，而应依靠运用日志结构中的 API，运用门面模式的日志结构，有利于保护和各个类的日志处理办法一致
- JAVA项目运用SLF4J、Jakarta Commons Logging中的API
对日志输出进行分类,便于开发人员检查,也便于经过日志对体系进行及时监控
- 当天运用日志，以“appName_logLevel.log”来保存
- 过往日志格局为: appName_logLevel.log.{保存日期}，日期格局:yyyy-MM-dd
- 运用中的扩展日志(如事务埋点、临时监控、访问日志等)命名办法为:appName_logType.log
- 不同类型的日志能够输出不同的日志格局，如事务埋点日志能够直接输出JSON格局
在日志输出时，字符串变量之间的拼接运用占位符的办法
- 由于 String 字符串的拼接会运用 StringBuilder 的 append()办法，有必定的功能损耗，运用占位符仅是替换动作，能够有效提升功能
出产环境制止直接运用 System.out 或 System.err 输出日志或运用e.printStackTrace()打印反常仓库
反常信息应该包含两类信息:案发现场信息和反常仓库信息，如果不处理，那么经过要害字 throws 往上抛出。
- 示例:logger.error(“恳求参数:{} ,反常信息:{}”, 各类参数或者目标 toString(), e.getMessage(), e);
所有日志文件至少保存两周，由于有些反常具有以“周”为频次产生的特色
引荐标准
打印日志时仅打印出事务相关特点值或者调用其目标的 toString()办法
- 日志打印时不主张直接用 JSON 东西将目标转换成 String,不过具体问题具体剖析，并发访问量不高的情况下能够尝试运用
记载日志时请先进行考虑:这些日志真的有人看吗，看到这条日志你能做什么，能不能给问题排查带来优点。
- 大量地输出无效日志，不利于体系功能提升，也不利于快速定位过错点。
一个项目尽量运用一致的言语(英文/中文)来描绘日志信息
记载日志时机
体系启动初始化时加载的自界说装备信息
调用第三方服务的出参以及入参
- HTTP调用的恳求参数与呼应参数
- RPC结构调用恳求参数与呼应参数
- MQ调用的恳求参数与呼应参数
后台定时任务的履行情况
程序反常
- 在程序出现exception的时分，要么选择向上抛出反常，要么必须在catch块中打印反常仓库信息
特别的条件分支
- 一些参数本不应该为空但是判断条件为空而履行的分支等，主张运用WARN等级日志输出
接口恳求数据的入参以及出参
- 包含但不限于体系中Controller层的恳求入参以及呼应出参
履行要害办法的入参以及出参
- 包含但不限于体系中要害Service层的恳求入参以及出参
履行要害办法的中心状态记载
- 要害办法中心逻辑运转的状态记载
日志输出格局
强制输出
- 时间戳
- 履行线程
- 日志等级
- 履行类名
- 履行类行号
- 输出内容
引荐输出
- traceId，轨道Id，用于串联一次完整的恳求履行途径
- userId，用户Id，用于作业体系标识某位事务操作人员履行的恳求
建立集中一致的日志搜集剖析展现渠道
建造目的
- 期望经过原始日志能够理解体系行为，建造具有功能剖析，问题定位的才能的东西渠道，在毛病产生前，剖析危险和体系瓶颈，在毛病产生时，及时告诉，快速定位解决问题，在毛病产生后，有历史数据迅速复盘
- 经过建造具有日志即时搜集、剖析、存储等才能的东西渠道，用户能够快速高效地进行问题诊断、体系运维，追寻并记载恳求在体系中的调用顺序，调用时间等一系列要害信息，协助咱们定位反常服务和发现功能瓶颈
- 集中一致的日志搜集剖析展现渠道是进行事务体系微服务化拆分的要害基础设施
建造方案
架构规划
- Filebeat 轻量级的日志文件收集东西，用于收集文件所产生的日志
- Kafka 消息中心件，不单单能够接纳Filebeat收集的日志数据，也能够接纳体系埋点 用户操作轨道等数据，用于后续的事务剖析统计汇总
- logstash 接纳kafka上面的日志数据后进行剖析过滤，变更为结构化的数据进行输出
- ElasticSearch 用于存储剖析过滤后的数据，建立查询索引
- Kibana 提供报表、图形化数据进行可视化展现 Web 界面，能够协助汇总、剖析和搜索重要数据日志
