SpringBoot实战（二十一）集成 TLog 日志

已于 2023-07-24 21:14:18 修改
阅读量1.3k 收藏 2
点赞数
分类专栏： SpringBoot实战 文章标签： spring boot 后端 java
于 2023-07-22 19:14:08 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_33204709/article/details/131871588
版权

目录

在这里插入图片描述

一、简介

TLog 是一款国产的轻量级分布式日志标记追踪组件。集成方便，通过对日志打标签的方式实现了微服务的链路追踪。支持 log4j、log4j2、logback 三大日志框架。支持 dubbo、dubbox、springcluod 三大RPC框架。

特点： 轻量级、10分钟接入、适配广泛。

二、Maven依赖

spring boot依赖：

<dependency>
  <groupId>com.yomahub</groupId>
  <artifactId>tlog-all-spring-boot-starter</artifactId>
  <version>1.5.1</version>
</dependency>

spring native依赖：

<dependency>
  <groupId>com.yomahub</groupId>
  <artifactId>tlog-all</artifactId>
  <version>1.5.1</version>
</dependency>

以上是集成了 TLog 的全部依赖，如果只想集成 TLog 的部分依赖可以根据需要进行选择：

模块名适用项目
tlog-dubbo-spring-boot-starter适用于 apache dubbo 项目。
tlog-dubbox-spring-boot-starter适用于当当的 dubbox 项目。
tlog-feign-spring-boot-starter适用于 spring cloud 中 open feign 项目。
tlog-gateweay-spring-boot-starter适用于 spring cloud 中 gateway 网关服务。
tlog-soul-spring-boot-starter适用于 soul 网关服务。
tlog-web-spring-boot-starter适用于 spring web 项目。
tlog-xxljob-spring-boot-starter适用于 xxl-job 项目。

三、启动类集成

在 Spring Boot 项目中，集成 TLog 只需在引入相关依赖后，在启动类增加 static {AspectLogEnhance.enhance();} 即可生效。

import com.yomahub.tlog.core.enhance.bytes.AspectLogEnhance;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class SpringbootDemoApplication {

    //进行日志增强，自动判断日志框架
    static {AspectLogEnhance.enhance();}

    public static void main(String[] args) {
        SpringApplication.run(SpringbootDemoApplication.class, args);
    }
}

到这一步就可以启动项目运行测试了，下面是一些测试和定制化的内容说明。

四、测试

1.服务简介

这里我们搭建三个服务：tlog-eureka、tlog-feign-a、tlog-feign-b。调用关系如下：

2.服务A代码

DemoController.java
import com.demo.common.Result;
import com.demo.feign.DemoFeignClient;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@Slf4j
@RestController
@RequestMapping("/demo")
public class DemoController {

    @Autowired
    private DemoFeignClient demoFeignClient;

    @GetMapping("/feignTest")
    public Result<Object> feignTest() {
        log.info("feignTest");
        return demoFeignClient.test();
    }
}
DemoFeignClient.java
import com.demo.common.Result;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;

@FeignClient(value = "tlog-feign-b")
public interface DemoFeignClient {

    @GetMapping("/demo/test")
    Result<Object> test();
}

3.服务B代码

import com.demo.common.Result;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@Slf4j
@RestController
@RequestMapping("/demo")
public class DemoController {

    @Value("${server.port:}")
    private String port;

    @GetMapping("/test")
    public Result<Object> test() {
        log.info("这是第一条日志。port:" + port);
        log.info("这是第二条日志。port:" + port);
        log.info("这是第三条日志。port:" + port);
        return Result.succeed();
    }
}

4.测试结果

请求接口： http://localhost:8081/demo/feignTest

请求结果：

在这里插入图片描述

服务A日志：

在这里插入图片描述

2023-07-22 18:03:50.396  INFO 4464 --- [nio-8081-exec-8] c.y.t.w.i.TLogWebInvokeTimeInterceptor   : <NONE><0><vouM834852011728769024> [TLOG]开始请求URL[/demo/feignTest],参数为:{}
2023-07-22 18:03:50.397  INFO 4464 --- [nio-8081-exec-8] com.demo.controller.DemoController       : <NONE><0><vouM834852011728769024> >>>>>>>>>> 【INFO】feignTest
2023-07-22 18:03:50.410  INFO 4464 --- [nio-8081-exec-8] c.y.t.w.i.TLogWebInvokeTimeInterceptor   : <NONE><0><vouM834852011728769024> [TLOG]结束URL[/demo/feignTest]的调用,耗时为:12毫秒

服务B日志：

在这里插入图片描述

2023-07-22 18:03:50.403  INFO 35816 --- [nio-8082-exec-2] c.y.t.w.i.TLogWebInvokeTimeInterceptor   : <tlog-feign-a><0.1><vouM834852011728769024> [TLOG]开始请求URL[/demo/test],参数为:{}
2023-07-22 18:03:50.404  INFO 35816 --- [nio-8082-exec-2] com.demo.controller.DemoController       : <tlog-feign-a><0.1><vouM834852011728769024> 这是第一条日志。port:8082
2023-07-22 18:03:50.404  INFO 35816 --- [nio-8082-exec-2] com.demo.controller.DemoController       : <tlog-feign-a><0.1><vouM834852011728769024> 这是第二条日志。port:8082
2023-07-22 18:03:50.404  INFO 35816 --- [nio-8082-exec-2] com.demo.controller.DemoController       : <tlog-feign-a><0.1><vouM834852011728769024> 这是第三条日志。port:8082
2023-07-22 18:03:50.407  INFO 35816 --- [nio-8082-exec-2] c.y.t.w.i.TLogWebInvokeTimeInterceptor   : <tlog-feign-a><0.1><vouM834852011728769024> [TLOG]结束URL[/demo/test]的调用,耗时为:3毫秒

补充一：自定义日志标签模板

TLog 默认只打印 spanId 和 traceId，以 <$spanId><$traceId> 模板打印，我们也可以自定义模板，加入其他的标签头。

只需要在 Spring Boot 项目中进行如下配置：

tlog.pattern=<$preApp><$spanId><$traceId>

具体配置项信息如下：

  • $preApp：上游微服务节点名称。
  • $preHost：上游微服务的 Host Name。
  • $preIp：上游微服务的IP地址。
  • $spanId：链路 spanId。
  • $traceId：全局唯一跟踪ID。（雪花算法）

配置好后，TLog 就会按照我们定义的模板进行打印日志。

2023-07-22 17:23:37.788  INFO 33604 --- [nio-8082-exec-1] com.demo.controller.DemoController       : <tlog-feign-a><0.1><EDEN834841887140286464> 这是第一条日志。port:8082
2023-07-22 17:23:37.788  INFO 33604 --- [nio-8082-exec-1] com.demo.controller.DemoController       : <tlog-feign-a><0.1><EDEN834841887140286464> 这是第二条日志。port:8082
2023-07-22 17:23:37.788  INFO 33604 --- [nio-8082-exec-1] com.demo.controller.DemoController       : <tlog-feign-a><0.1><EDEN834841887140286464> 这是第三条日志。port:8082

补充二：SpanId的生成规则

TLog 中的 SpanId 代表本次调用在整个调用链路数中的位置。

假设一个 Web 系统 A 接受了一次用户请求，那么在这个系统的日志中，记录下的 SpanId 会有如下情况：

  • 0，代表在这次请求中， A 系统是整个调用的根节点。
  • 0.1、0.2、0.3…，代表 A 系统通过 RPC 依次调用了 B、C、D 等系统。
  • 0.2.1、0.2.2…，代表在 A 系统调用 C 系统后，C 系统在处理请求的时候又调用了 E、F 等系统。

根据上面的描述，我们可以把一次调用中所有的 SpanId 收集起来，组成一棵完整的链路树：

在这里插入图片描述

补充三：业务标签

很多系统在打印日志的时候，每打印一条日志都会带入一些业务信息，比如记录ID、会员CODE，方便日志的定位。

TLog 除了实现分布式链路标签追加之外，还可以自定义业务标签来添加到日志中。TLog 的自定义业务标签是方法级的。我们可以在方法上使用 @TLogAspect 注解指定需要添加的业务标签字段，TLog 会自动将业务标签统一添加到日志的开头。

业务标签的位置为：<$spanId><$traceId><业务标签>

下面是几种常见的自定义业务标签的使用方法：

1.打印入参

@TLogAspect 注解会读取 id 和 name 值，从而打印到日志中。

@TLogAspect({"id","name"})
public void demo1(String id,String name){
  log.info("这是第一条日志");
  log.info("这是第二条日志");
  log.info("这是第三条日志");
  new Thread(() -> log.info("这是异步日志")).start();
}

日志示例：

2023-07-22 17:41:02.190  INFO 33516 --- [nio-8081-exec-1] com.demo.controller.DemoController       : <0><bInv834846270246686720> [id:"1",name:"ACGkaka"] 这是第一条日志
2023-07-22 17:41:02.190  INFO 33516 --- [nio-8081-exec-1] com.demo.controller.DemoController       : <0><bInv834846270246686720> [id:"1",name:"ACGkaka"] 这是第二条日志
2023-07-22 17:41:02.190  INFO 33516 --- [nio-8081-exec-1] com.demo.controller.DemoController       : <0><bInv834846270246686720> [id:"1",name:"ACGkaka"] 这是第三条日志
2023-07-22 17:41:02.192  INFO 33516 --- [      Thread-28] com.demo.controller.DemoController       : <0><bInv834846270246686720> [id:"1",name:"ACGkaka"] 这是异步日志

2.指定连接符

@TLogAspect 注解支持指定 pattern 和 参数间的连接符。pattern 指的是业务标签的打印格式，其中 {} 表示业务标签的内容。

@TLogAspect(value = {"id","name"},pattern = "<-{}->",joint = "_")
public void demo(String id,String name){
  log.info("加了patter和joint的示例");
}

日志示例：

2020-02-08 22:09:40.103 [main] INFO  Demo - <0.2><7205781616706048><-NO1234_jenny-> 加了patter和joint的示例

3.打印常量

@TLogAspect 注解也支持常量字符串作为业务标签。

@TLogAspect(str = "demo1()")
public void demo1(String name){
  log.info("这是第一条日志");
  log.info("这是第二条日志");
  log.info("这是第三条日志");
  new Thread(() -> log.info("这是异步日志")).start();
}

日志示例：

2020-02-08 20:22:33.945 [main] INFO  Demo - <0.2><7205781616706048>[demo1()] 这是第一条日志
2020-02-08 20:22:33.945 [main] INFO  Demo - <0.2><7205781616706048>[demo1()] 这是第二条日志
2020-02-08 20:22:33.945 [main] INFO  Demo - <0.2><7205781616706048>[demo1()] 这是第三条日志
2020-02-08 20:22:33.948 [Thread-3] INFO  Demo - <0.2><7205781616706048>[demo1()] 这是异步日志

4.打印JSON某属性

@TLogAspect 支持解析JSON入参，通过 . 点操作符可以进行对象属性的取值，支持类型：

  • Java对象
  • JSON格式的字符串

Java 对象属性的获取：

@TLogAspect({"person.id","person.age","person.company.department.dptId"})
public void demo(Person person){
  log.info("多参数加多层级示例");
}

日志示例：

2020-02-08 22:09:40.110 [main] INFO  Demo - <0.2><7205781616706048>[31-25-80013] 多参数加多层级示例

JSON格式字符串属性的获取：

@TLogAspect({"person.id","person.age","person.company.department.dptId"})
public void demo(String person){
  log.info("多参数加多层级示例");
}

JSON格式字符串中数组的获取：

对于JSON格式字符串中的数组，可以用下标 [num] 来获取。

@TLogAspect({"person.id","person.age","person.company.title[1]"})
public void demo(String person){
  log.info("多参数加多层级示例");
}

补充四：打印调用参数和时间

在 Spring Boot 项目中，如果我们想在日志的第一行打印调用的参数和时间，我们可以在配置文件中进行如下配置：

# 默认为false
tlog.enable-invoke-time-print=true

请求地址：http://localhost:8081/demo/tlogTest?id=1&name=ACGkaka

日志示例：

2023-07-22 17:41:02.039  INFO 33516 --- [nio-8081-exec-1] c.y.t.w.i.TLogWebInvokeTimeInterceptor   : <0><bInv834846270246686720> [TLOG]开始请求URL[/demo/tlogTest],参数为:{"id":["1"],"name":["ACGkaka"]}
2023-07-22 17:41:02.190  INFO 33516 --- [nio-8081-exec-1] com.demo.controller.DemoController       : <0><bInv834846270246686720> 这是第一条日志
2023-07-22 17:41:02.190  INFO 33516 --- [nio-8081-exec-1] com.demo.controller.DemoController       : <0><bInv834846270246686720> 这是第二条日志
2023-07-22 17:41:02.190  INFO 33516 --- [nio-8081-exec-1] com.demo.controller.DemoController       : <0><bInv834846270246686720> 这是第三条日志
2023-07-22 17:41:02.192  INFO 33516 --- [      Thread-28] com.demo.controller.DemoController       : <0><bInv834846270246686720> 这是异步日志
2023-07-22 17:41:02.221  INFO 33516 --- [nio-8081-exec-1] c.y.t.w.i.TLogWebInvokeTimeInterceptor   : <0><bInv834846270246686720> [TLOG]结束URL[/demo/tlogTest]的调用,耗时为:171毫秒

整理完毕，完结撒花~ 🌻





参考地址：

1.SpringBoot 2.5.5整合轻量级的分布式日志标记追踪神器TLog，https://www.cnblogs.com/chenyanbin/p/16804650.html

不愿放下技术的小赵
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
【项目实战】日志追踪框架TLog入门介绍
本本本添哥
05-14 156
TLog是一款基于MDC（Mapped Diagnostic Context）模型的日志追踪框架TLog旨在提供一种简单的方式来解决日志追踪问题TLog支持Java主流微服务框架，比如dubbo、dubbox、spring cloud等RPC框架。TLog 是一个轻量级的分布式日志追踪工具使用 TLog 来增强微服务架构中的日志追踪能力，提升问题定位和系统维护的效率。
TLog轻量级日志追踪
zwrlj527的专栏
10-25 1414
序 前段时间快马加鞭的把2个项目的需求弄完了，一个说是做了就验收，一个是支持期，要提高客户友好体验。完了后，这2天有点小闲暇，不能浪费，于是就逛逛论坛，发现了一个轻量级的日志增强框架TLog。 一、日志增强的场景 这个springBoot也可以用，但是感觉用处不大，真正有用处的场景我认为是springCloud里用，可以查看各层级日志，也就调用链路。这个我这里也是因为受限服务器资源、人力资源等，所以觉得这个于我最实在。 二、依赖引入 我这里是springCloud项目，且是maven的主从项目，所以我直接在
TLog轻量级分布式日志标记追踪神器
灵熙云工作室
12-02 1091
TLog通过对日志打标签完成企业级微服务的日志追踪。它不收集日志，使用简单，产生全局唯一的追踪码。除了追踪码以外，TLog还支持SpanId和上下游服务信息 标签的追加。为用户使用方便而设计，提供完全零侵入式接入方式，自动探测项目中使用的RPC框架和日志框架， 进行字节码的注入完成系统级日志标签的追加。dubbo，dubbox，spring cloud的open feign。TLog提供Javaagent，字节码注入，日志框架适配三种接入模式，无论是哪一种，都保证了无性能损耗。
SpringBoot 2.5.5整合轻量级的分布式日志标记追踪神器TLog
weixin_47367099的博客
10-19 1097
但是搭建分布式追踪系统，熟悉以及推广到全公司的系统需要一定的时间周期，而且当中涉及到链路span节点的存储成本问题，全量采集还是部分采集？2022-10-18 23:24:52.137 INFO 88321 --- [nio-8080-exec-1] com.ybchen.controller.DemoController : 多个数值-------->加了patter和joint的示例。
轻量级的日志追踪框架TLog。10 分钟即可接入！
没有伞的孩子必须努力奔跑！—小林
11-13 2092
开始文章之前，且听我简单BB几句。 国产开源之路不易，好的国产开源项目还是太少太少了。国内一些用心做开源的技术人基本都是靠爱发电。 今天介绍的这个日志框架的作者自己维护了 3 个开源框架，为此他经常忙到凌晨1，2点。目前，这个日志框架目前仍在开发中。不得不说的是！这个项目整体的代码质量很高，非常值得小伙伴们学习一波！ 前言 随着微服务盛行，很多公司都把系统按照业务边界拆成了很多微服务，在排错查日志的时候。因为业务链路贯穿着很多不同微服务，同一个微服务又可能部署着十几个节点，要排查某一个请求的日志，总
【springboot进阶】基于starter项目构建（二）构建starter项目-web
12-11 1523
构建springboot 自定义 starter，为业务系统构建公共的web模块，配置一些项目中常见的 mvc 等方面的配置，这样就能简化子系统的配置。
gateway 与 spring-boot-starter-web 冲突问题
热门推荐
weixin_43198403的博客
12-31 1万+
gateway 与 spring-boot-starter-web 冲突问题 环境： SpringCloud 版本 ---- Finchley.SR2 SpringBoot 版本 ---- 2.0.6.RELEASE 问题描述： 将 zuul 网关升级为 gateway 时，引入gateway 依赖启动网关子项目报错 引入的依赖： <dependency> <...
【开源项目】日志框架TLog介绍及实现原理
秋装什么的博客
12-13 760
【开源项目】TLog介绍及实现原理
Java开发案例-springboot-35-整合TLog实现分布式日志标记追踪-源代码+文档.rar
最新发布
05-31
Java开发案例-springboot-35-整合TLog实现分布式日志标记追踪-源代码+文档.rar Java开发案例-springboot-35-整合TLog实现分布式日志标记追踪-源代码+文档.rar Java开发案例-springboot-35-整合TLog实现分布式日志...
TLog分布式日志标记追踪器-其他
06-11
TLog是一个轻量级的分布式日志标记追踪神器，10分钟即可接入，自动对日志打标签完成微服务的链路追踪。支持log4j，log4j2，logback三大日志框架，支持dubbo，dubbox，springcloud三大RPC框架。 特性： 通过对日志打...
TLog是一个轻量级的分布式日志标记追踪神器
06-09
TLog是一个轻量级的分布式日志标记追踪神器，10分钟即可接入，自动对日志打标签完成微服务的链路追踪。支持log4j，log4j2，logback三大日志框架，支持dubbo，dubbox，springcloud三大RPC框架
TLog:轻量级分布式日志标签跟踪框架
04-12
您的star是我继续前进的动力，如果喜欢请右上角帮忙点个star Gitee的star趋势图 贡献者 概述 TLog是一个轻量级的分布式日志标记追踪神器，10分钟即可接入，自动对日志打标签完成微服务的链路追踪。支持log4j，log4j2，logback三大日志框架，支持dubbo，dubbox，springcloud三大RPC框架 项目主页请点击： 示例工程请点击： 特性 通过对日志打标签完成轻量级微服务日志追踪 提供三种接入方式：javaagent完全无侵入接入，字节码一行代码接入，基于配置文件的接入 对业务代码无侵入式设计，使用简单，10分钟即可接入 支持常见的log4j，log4j2，logback三大日志框架，并提供自动检测，完成适配 支持dubbo，dubbox，springcloud三大RPC框架 支持日志标签的自定义模板的配置，提供多个系统级埋点标签的选择 支持异步线程的追
TLog分布式日志标记追踪器 v1.5.0.zip
04-02
TLog分布式日志标记追踪器 v1.5.0.zip
TLog-master.zip
03-20
一个轻量级的分布式日志标记追踪神器，10分钟即可接入，自动对日志打标签完成微服务的链路追踪
Spring Boot日志配置logback
夏壹分享
11-16 3206
logback在Spring Boot项目中使用特别注意异步打印队列大小、丢弃大小、是否阻塞。此外log节点注意additivity属性值
Spring+Boot核心笔记(一)：环境准备、配置文件详解、日志模块
qq_42003636的博客
01-18 293
Spring Boot在启动的时候从类路径下的META-INF/spring.factories中获取EnableAutoConfifiguration指定的值，将这些值作为自动配置类导入到容器中，自动配置类就生效。SpringBoot能自动适配所有的日志，而且底层使用slf4j+logback的方式记录日志，引入其他框架的时候，只需要把这个框架依赖的日志框架排除掉即可；这个配置类就会给容器中添加各种组件；这些组件的属性是从对应的properties类中获取的，这些类里面的每一个属性又是和配置文件绑定的；
SpringBoot 项目中使用日志及线上日志相关配置
m0_73311735的博客
05-20 1219
其实是方便我们在相同日志接口下的不同日志框架实现自由切换，不需要改动任何代码。
springboot整合tlog进行链路追踪、接口耗时统计
蔡定努
01-17 484
链路追踪
springboot之spring-boot-starter-web
m0_54849806的博客
04-26 5956
在这个互联网的时代，使用spring框架除了开发少数的独立应用，大部分情况下实际上在使用SpringMVC开发web应用，为了帮我们简化快速搭建并开发一个Web项目，Spring boot为我们提供了spring-boot-starter-web自动配置模块。 只要将spring-boot-starter-web加入项目的maven依赖： <dependency> <groupId>org.springframework.boot</groupId> &l
springboot tlog
11-10
Spring Boot是一个开源的Java开发框架，用于简化Java应用程序的开发和部署。它提供了一个开箱即用的环境，自动配置和管理各种依赖项，并提供了一组方便的功能和组件，以简化开发人员的工作量。Spring Boot的目标是使Java开发更加快速、简单和高效。 Tlog指的是一个基于Spring Boot的开源日志管理系统，用于记录和管理应用程序的运行日志。它提供了一组灵活和强大的功能，以便开发人员更好地监控和分析应用程序的运行情况。 使用Spring Boot和Tlog可以帮助开发人员更好地管理应用程序的日志。通过在Spring Boot应用程序中集成Tlog，开发人员可以轻松地记录和追踪应用程序的运行日志。Tlog提供了多种日志级别，可以根据需求进行配置，使开发人员能够精确地控制和管理日志输出。 除了基本的记录日志功能外，Tlog还提供了一些高级功能，例如日志的分析和监控。开发人员可以使用Tlog来分析应用程序的运行情况，识别潜在的问题，并做出相应的优化和调整。此外，Tlog还支持将日志信息发送到远程服务器或第三方平台，以便进一步的分析和处理。 总而言之，Spring Boot和Tlog是一对强大的工具，可在Java应用程序的开发和运行过程中提供更简便、高效和可控的日志管理。通过集成Tlog，开发人员可以更好地监控和分析应用程序的运行情况，从而能够更好地进行调优和优化。同时，Tlog还提供了灵活和强大的功能，使开发人员能够更好地管理应用程序的日志输出。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

不愿放下技术的小赵

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值