介绍

Trace是一个单体架构的异步非阻塞监控追踪系统。用于收集单体架构系统中的信息数据，例如在一次请求中花费的时间、请求执行的方法调用链、以及操作是否出现异常和异常的详细信息等。

该项目源码地址：https://github.com/lastwhispers/trace-spring-boot
项目在线体验地址：http://39.105.49.50:8081/monitor/index.html
测试请求URL：
普通 http://39.105.49.50:8081/user?id=123&name=zhangsan
异常 http://39.105.49.50:8081/userException?id=123&name=zhangsan
分支 http://39.105.49.50:8081/fork?id=123&name=zhangsan&num=1
分支 http://39.105.49.50:8081/fork?id=123&name=zhangsan&num=2

实时调用链

实时收集接口请求调用链的耗时、异常相关信息

静态调用链

该功能将请求去重，保存静态调用链路，可以用来学习一个Web项目或者别的用途，比如生成毕设中的类图（教程还没写，有空再写）。

快速使用

目前只支持SpringBoot项目，trace-spring-boot-samples中有使用的例子

引入依赖

Trace的Maven依赖

<dependency>
    <groupId>io.github.lastwhispers</groupId>
    <artifactId>trace-spring-boot-starter</artifactId>
    <version>1.0.2.RELEASE</version>
</dependency>

Trace项目本身依赖了springboot的aop和web模块，为了防止依赖传递，项目本身不提供这两个模块的依赖，请自行引入。

<dependency>
 	<groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

配置注解

在SpringBoot的启动类上添加注解@EnableTrace(value = "")，该注解的value是一个切点表达式。

Trace会织入切点表达式包含的所有方法，进行信息收集。

@SpringBootApplication
@EnableTrace("execution(* com.example.demo..*(..))")
public class SpingBootApplication {

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

}

@EnableTrace配置完毕后，请先编译项目！！！，请先编译项目！！！，请先编译项目！！！，在编译期注解处理器（Annotation Processor Tool）会生成适配于你项目的CollectorAspect.java源文件，这是Trace的起点。

对于未在切点表达式中的方法可以通过@Exclude注解进行包含，对应的可以使用@Include对方法或类进行排除。

启动项目

启动你的个人项目，访问 127.0.0.1:8080/monitor/index.html 即可进入监控页面。
如果你的项目IP和端口不是127.0.0.1:8080，请修改成对应IP和端口。
如果有Shiro、Spring Security权限控制，请赋予监控地址权限。

注意事项

项目的IOC容器中不要注入final修改的类，如果必须注入请用@Exclude注解排除，因为无法运行时代理final修饰的类，会导致项目无法启动。
编译项目后，generated-sources目录下会有生成的代码。
项目中有权限控制，请将监控地址权限纳入其中。

原理架构

其他

移除Trace

由于第一次写三方库，难免有考虑不周到的地方，Trace可能会导致你的项目无法运行，下面介绍如何完全移除Trace。

将@EnableTrace（@Exclude、@Include）删除，并导入的包也移除。
删除Trace的maven依赖。
clean项目或者删除target目录下generated-sources目录。

持久化

Trace默认使用cn.lastwhisper.trace.repository.impl包下的*InMemoryRepository，通过几个基础的数据结构ArrayList、LinkedList、HashMap完成分页、查询、LRU。

如果你需要持久化数据，只需要重写cn.lastwhisper.trace.repository包下的*Repository接口，实现对应规范的方法即可。

lastwhispers / trace-spring-boot

介绍