koTime是一个开源免费的springboot项目性能分析工具,通过追踪方法调用链路以及对应的运行时长快速定位性能瓶颈,除此之外,代码热更新、异常检测都可以有!
一.添加KoTime依赖:
<dependency>
<groupId>cn.langpy</groupId>
<artifactId>ko-time</artifactId>
<version>2.4.1</version>
</dependency>
二.添加yml 配置文件
# 代码监控
ko-time:
# 是否开启koTime,默认开启,当为false时,关闭koTime
enable: true
# 是否开启控制输出,默认false
log-enable: true
# 语言(english/chinese)默认chinese
language: chinese
# 时间阈值,用于前端展示,大于阈值显示红色,小于阈值显示绿色,默认800
threshold: 800.0
# context-path: http://localhost:80 # 前端页面调用接口的上下文环境,无法自动获取时可手动配置,一般情况切记不要配置 v2.0.1开始支持
exception-enable: true # 是否开启异常检测,默认为false,开启后会对方法内部抛出的异常进行统计 v2.0.0开始支持
# 是否开启认证,默认为false,开启后需要登录才能访问调用链路 v2.0.2开始支持
auth-enable: false
# 登录用户 v2.0.2开始支持
# user-name: admin
# 登录密码 v2.0.2开始支持
# password: 123456
# 使用静态的token值进行认证访问(/koTime?kotoken=xxx) v2.3.7开始支持,该模式和user-name认证模式二选一
#static-token: xxxx
# 是否开启入参组合分析 默认开启 v2.0.8开始支持 双击方法节点即可看到效果
param-analyse: true
# 启动时是否删除过往数据 默认false v2.2.3开始支持
data-reset: false
# 调用信息存储线程数(为了不影响项目本身性能,链路存储异步进行),默认2,该值并非越大越好,瓶颈取决于数据库性能和服务器配置,尽可能少占用项目资源为上 v2.2.0-BETA开始支持
thread-num: 2
# 丢弃率(0-1) 同一个方法在多次连续调用时,耗时差距并不大,为了存储的IO性能考虑,可以随机丢弃一部分耗时数据。默认30% v2.2.5开始支持
discard-rate: 0.3
# 登录超时时间考虑 默认43200s(12个小时) v2.3.0开始支持
auth-expire: 43200
# 获取最新版本通知开关 在页面上可以看到 默认true v2.3.3开始支持
version-notice: true
#需要监测的范围,是链路包含的范围,不仅仅是接口层,参考aop的@pointcut
pointcut: execution(public * com.test.web.controller..*.*(..))
三.注意事项:
1.生产上尽量设置user-name 以及password 或者使用static-token 的方式进行加密处理
开启认证需要在配置文件中auth-enable参数改为true
2.引入了上面的依赖和配置以后,确认项目中是否有aop相关的包,koTime使用了@Aspect注解,未引入的自行引入,如aspectj或者spring-boot-starter-aop
3.做完前面的步骤,koTime的集成已经完毕,无需进行其他配置
4.如果后台有权限认证,需要放开/koTime和/koTime/**
四.切入点监控详解:pointcut: 参数规则如下
假设项目的包路径为:
com.test.demo
|-controller
|-service
|-mapper
|-others
|-other1
|-other2
|-Test.java
1.想要切com.test.demo
下面的所有方法(包括子包中的),可以写:
execution(public * com.test.demo..*.*(..)) #切记,是两个点.
2.只想要切cn.test.demo.controller
下面的类的所有方法(不包括子包的),可以写:
execution(public * com.test.demo.controller.*.*(..)) #切记,是一个点.
3.只想要切cn.test.demo.others
下面的类的所有方法(不包括other1和other2下面的),可以写:
execution(public * com.test.demo.others.*.*(..))
4.只想要切cn.test.demo.others
下面的类的所有方法(包括other1和other2),可以写:
execution(public * com.test.demo.others..*.*(..))
5.如果想排除某些类如Test.class,可以
execution(public * com.test.demo.others..*.*(..)) && !execution(public * com.test.demo.others.Test(..))
6.如果想监控多个不同的包下,可以
execution(public * com.test.a..*.*(..)) || execution(public * com.test.b..*.*(..))
五:若按照以上配置完成,则启动项目后通过页面访问:http://localhost:port/koTime
也可通过接口列表来具体执行情况,耗时在哪,如下图:
六,集成后若CPU显示异常解决
需要查看项目中是否引入 oshi或 jna ,若引入以上依赖,则需把相应的版本进行升级,这里使用的是如下版本,亲测可行,可供参考
<oshi.version>6.4.0</oshi.version>
<jna.version>5.9.0</jna.version>