限时领|《AI 百问百答》专栏课+实体书(包邮)! 了解详情
写点什么

写一个无配置格式统一的日志

  • 2020-02-11
  • 本文字数:3515 字

    阅读完需:约 12 分钟

写一个无配置格式统一的日志

背景

大量项目在使用 logback 记日志,有部分项目使用日志混乱,格式不统一,多数人搞不懂配置文件,导致配置错误,现在需要开发一套统一的、少配置的日志组件,使用方便

设计思路

  • 尽量采用 0 配置,无 logback.xml

  • 日志格式统一,方便后续日志分析系统

  • 只有两个日志级别,一个是正常日志,一个是异常日志

  • 提供 log4j、jcl、logback、commons-log 等桥接方案及版本兼容方案

  • 提子线程、json 格式化输出、map 格式化、数组格式化、请求响应参数(供耗时)等便捷日志输出方法

  • 支持 redis、db、http 自动开关配置****

  • 新增日志类型(logger)

  • api 采用流式结构,类似 StringBuffer

  • 概要设计

    零配置


  • 调研代码


上面代码等价于下面的 xml


                    %d{MMddHHmmss.SSS} [%thread] %-5level %logger{36} - %msg%n
复制代码


由此可以随意把配置文件中的内容以代码形式编写,理论已经可以实现 0 配置。

输出路径

约定固定将日志输出到,相对路径 log/xxx.yyyy-MM-dd-HH.log,其中 xxx 为 logger 的 name

日志格式

格式固定:MMddHHmmss.SSS||id||【交易名★子步骤】||context ||[level][线程号]例:150000.311||N-XrUTQzIc1531897200311||【CiTeeFilter★ci拦截器】||ci拦截器 请求的完整参数为:{"merchantId":["0012444"],"userId":["13112341232"]} ||[INFO][http-8091-7]
复制代码


固定格式的核心代码,拦截到日志请求,按照格式拼装,主要方法为继承 ThrowableProxyConverter 和 MessageConverter 来实现对日志的拦截,并修改为想要的格式,其中使用的例如 id 等放到本地变量内,核心是对 MDC 的使用

基础 logger

所有日志都默认输出到这里 logger name:service 系统初始化时,定义这个 Logger 和 appender,即这个 Logger 为 root log

自定义的 logger

提供 addLogger 方法,参数 packageName 包名,例如:com.test 必输参数 如果 name 未设置时,name 默认为包名最后一个.后面的字符 name 名字,决定日志文件的名字 非必输 path 日志路径 非必输 additivity 是否输出到 root log 内

特殊的 log

提供特殊组件的 log 配置,例如: redis 默认 ERROR http 默认 ERROR db 连接池 默认 ERROR kafka 默认 ERROR schedul 默认 ERROR spring 默认 ERROR

异常、换行日志处理

提供 exception 异常栈格式打印 提供带换行的格式化打印 代码思路:继承 ThrowableProxyConverter,获取异常栈,在每行的前面插入固定格式文本

普通日志 api(VirgoLog)

方法方法描述
setUniqKey(id)设置当前线程id,线程开始时设置即可,后面无需设置
updateStep(trade, step)更新当前id的步骤信息
log(msg, param)记录普通日志,msg替换规则,普通替换为{},如果想替换为业务日志api中的格式,使用``替换
logErr(msg, e)记录异常日志
log( trade, step, msg, param)记录普通日志,此方法会自动更新id、trade、step,不建议使用
logErr(trade, step, msg, e)记录异常日志
log(cid, trade, step, msg, param)记录普通日志,此方法会自动更新id、trade、step,不建议使用
logErr(cid, trade, step, msg, e)记录异常日志
debug(msg, param)记录debug级别日志,不建议使用

业务日志 api(VirgoLog)

平时记日志时,如果某个类没有时间 toString 方法,会无法正确打印出数据,此时提供替换方法,直接将 object 替换为 json 打印,核心代码思路为


MessageFormatter 是处理{}替换的类,重新写个类,稍加改动即支持{}也支持`` ,并判断替换为 json 还是 toString


api 如下


方法方法描述
begin(msg)记录开始
end(msg)记录完成,会打印本线程内上一个begin到现在的耗时
logJson(json, format)记录json格式化日志,format表示是否换行
logMap(map, format)记录map格式化日志
logCollection(list, format)记录集合格式化日志
logArray(array, format)记录数组格式化日志
logObjct(obj, format)记录Object格式化日志

系统 api(LoggerHelper)

方法方法描述
getLogger()获取logger,用于记日志
getLogger(name)通过name获取logger
addLogger()参考自定义Logger,如果logger已经创建,则不再创建,一般不使用,除非想自定义日志名等
consoleOpen()打开控制台日志,系统启动时默认配置控制台日志
commonOpen(name, level)默认的组件都是error级别,这个方法可以变更日志级别,例如redis http等

特殊的格式化

map:即转化为 json,然后再格式化


collection:同上


array:也同上


object:同上

问题

1、密码脱敏、加解密有必要单独提取方法吗


2、提供父线程打印开关

maven 依赖

                    com.cdc.ecliptic            virgo            1.5_1.6-SNAPSHOT
复制代码

demo

public static void main(String[] args) throws InterruptedException {
// 启动 VirgoLancher.start("hahaha", "com.cdc.virgo", "D:/test/hahah.log"); LoggerHelper.commonOpen("hahaha", LogLevel.DEBUG); Logger logger1 = LoggerFactory.getLogger("druid");// VirgoLancher.commonStart("abc", "com.cdc.virgo"); // 打开控制台 LoggerHelper.consoleOpen(); // 设置cid VirgoLog.setUniqKey(null); // 设置步骤名和交易名 VirgoLog.updateStep("adfa", "saf"); // 获取Logger VirgoLog logger = VirgoLog.getLogger();
// 打开debug级别(只有在开发阶段可以打开)// logger.changeLevel(LogLevel.DEBUG); // 记录换行 logger.log("a");
logger1.info("dddddddddd"); logger1.error("dddddddddd");
// logger1.info("sfdasfaf" +// "\nafafdasfd" +// "\nasfdasf"); logger.log("sfdasfaf" + "\nafafdasfd" + "\nasfdasf");
// logger1.info("b"); // 正常日志// logger.log("我只有一行"); Map map = new HashMap(); map.put("asdf", "1"); map.put("asdf2", "2"); map.put("asdf3", "13"); map.put("asdf4", "14"); map.put("asdf5", "15"); map.put("asdf6", "16");// // 异常日志也支持格式化// logger.logErr("我错了:{},你没错:~~", new Exception("asdfsaflk"), "啊", map);// logger.log("----------------------------------------------");// // {}替换普通对象,调用toString() ~~把对象转换为json并且格式化输出 ``把对象转换为json不格式化输出 logger.log("你好{},你是谁~~``,sd~xx {}", map, map, map, "tttt"); VirgoLog.updateStep("saf2");// // 把对象转换为json输出// logger.logJson(map, false);// // 更新步骤名和交易名// VirgoLog.updateStep("bbbbb", "ccccc");// // 耗时日志打印 logger.begin("处理内容"); logger.begin("处理第二个"); logger.begin("处理第三个"); Thread.sleep(3000L); logger.end(); Thread.sleep(1000L); logger.end(); VirgoLog.updateStep("saf3"); logger.end();// // 记录debug日志,一般调试用// logger.logDebug("jajajajaja");
// List l = new ArrayList();// B b = new B();// try {// b.b();// } catch (Exception e) {// logger.logErr("woqu", e);// }
复制代码


本文转载自宜信技术学院网站。


原文链接:http://college.creditease.cn/detail/206


2020-02-11 20:19910

评论

发布
暂无评论
发现更多内容

【算法实践】| 手把手带你实现快速排序算法

迷彩

快速排序 算法实践 8月月更

头脑风暴:最大子序和

HelloWorld杰少

数据结构 算法 LeetCode 8月月更

[JS真好玩] 遇到表格,手动翻页太麻烦?我教你写脚本,一页展示所有数据

HullQin

CSS JavaScript html 前端 8月月更

一对一语音直播系统源码——如何解决音视频直播技术难点

开源直播系统源码

软件开发 直播系统源码 语音直播系统源码 语音直播源码 一对一语音直播

最新版MySQL8 绝对有用的lag函数实现同比、环比、均差计算

知识浅谈

MySQL 8月月更

阿里云林小平:如何实现应用的持续发布?

阿里云弹性计算

持续发布 应用 自动化运维

机器学习服务文本翻译能力升级,中文直译模型让译文表达更地道!

HarmonyOS SDK

灵活多样认证授权,零开发投入保障IoT安全

EMQ映云科技

安全 物联网 认证授权 emqx 8月月更

一次客户需求引发的K8S网络探究

京东科技开发者

k8s 中台架构 #k8s K8s 多集群管理 数据库·

电商秒杀系统设计(架构实战营 毕业设计项目)

Gor

基于STM32L431设计的云端绿化管理系统(ESP8266+腾讯物联网云平台)

DS小龙哥

8月月更

leetcode 560. Subarray Sum Equals K 和为 K 的子数组(中等)

okokabcd

LeetCode 算法与数据结构

程序员最容易读错的单词,听到status我炸了

艾小仙

Java 前端

golang实战之flag包

程序员欣宸

golang 8月月更

数据治理(六):编译Atlas安装包

Lansonli

数据治理 8月月更

什么是公共云、私有云、混合云、社区云,四者分别有啥区别?

wljslmz

云计算 8月月更

Latex安装教程(附美赛论文latex模板)

乌龟哥哥

8月月更

动态尺寸模型优化实践之Shape Constraint IR Part II

阿里云大数据AI技术

深度学习 编译器 优化

PingCode 权限系统设计与实现

PingCode研发中心

权限系统

C++多态之析构和纯虚析构分析与示例(三)

CtrlX

c++ 后端 面向对象思想 8月月更

SpringBoot 整合 Junit

springboot junit5 8月月更

Excelize 发布 2.6.1 版本更新,支持工作簿加密保护

xuri

开源 数据分析 Go 语言 Excelize Excel工具

软件测试中的树莓酱定律

BY林子

软件测试 敏捷测试 质量内建

企业分账如何帮助用户解决成本优化和预算分配的问题

阿里巴巴中间件

阿里云 Serverless 云原生 SAE

Web3 的通行证——DID 带来数字身份革命

One Block Community

为什么说:被观察者是 push 数据,迭代者是 pull 数据?

掘金安东尼

前端 函数式编程 8月月更

RocketMQ高可用设计之消息重试机制

急需上岸的小谢

8月月更

架构实战营 毕业总结

Gor

【Gopher 学个函数】边学边练,简单为 Go 上个分

梦想橡皮擦

Python 爬虫 8月月更

Curve Testing Camp Time|万元大奖等你来拿!

张慧

分布式存储 curve

写一个无配置格式统一的日志_文化 & 方法_刘鹏飞_InfoQ精选文章