项目介绍

koTime 是一个 springboot 项目性能分析工具,通过追踪方法调用链路以及对应的运行时长快速定位性能瓶颈

特点:

1、实时监听方法

2、统计运行时长 web 展示方法调用链路,瓶颈可视化追踪

引入依赖

在 pom.xml 文件中引入

 <dependency>
    <groupId>cn.langpy</groupId>
    <artifactId>ko-time</artifactId>
    <version>2.0.9</version>
  </dependency>

配置

在application.properties文件中进行配置

  • 必填配置

ko-time.pointcut=execution(public * com.huoyo….(…)) # 需要监测的切面范围,参考 aop 的 @pointcut 或者左侧常见问题

  • 可选配置(以下配置一般不用设置)

ko-time.enable=true # 是否开启 koTime,默认开启,当为 false 时,关闭 koTime
ko-time.log-enable=false # 是否开启控制输出,默认 false
ko-time.log-language=chinese # 控制台输出语言(english/chinese)默认 chinese
ko-time.threshold=800.0 # 时间阈值,用于前端展示,大于阈值显示红色,小于阈值显示绿色,默认 800
ko-time.context-path=http://localhost:80 # 前端页面调用接口的上下文环境,无法自动获取时可手动配置,一般情况切记不要配置 v2.0.1 开始支持
ko-time.exception-enable=true # 是否开启异常检测,默认为 false,开启后会对方法内部抛出的异常进行统计 v2.0.0 开始支持
ko-time.auth-enable=true # 是否开启认证,默认为 false,开启后需要登录才能访问调用链路 v2.0.2 开始支持
ko-time.user-name=xxxx # 登录用户 v2.0.2 开始支持
ko-time.password=xxxx # 登录密码 v2.0.2 开始支持
ko-time.param-analyse=true #是否开启入参组合分析 默认开启 v2.0.8 开始支持 双击方法节点即可看到效果

访问

注意:
1.引入了上面的依赖和配置以后,确认项目中是否有 aop 相关的包,koTime 使用了 @Aspect 注解,未引入的自行引入,如 aspectj 或者 spring-boot-starter-aop
2.做完前面的步骤,koTime 的集成已经完毕,无需进行其他配置
3.如果后台有权限认证,需要放开/koTime和/koTime/**

  • 启动项目访问 /koTime 路径即可
  • 如果仅仅只是想统计某个方法,在方法上加上@ComputeTime即可,控制台会输出耗时

建议使用谷歌浏览器或者 Edge 浏览器,IE 是不可能支持的

如果项目自定义的 contextpath,访问如http://localhost:8080/xxx 服务/koTime

如:application.properties 中定义了
server.servlet.context-path=/myservice,那么访问路径为
http://localhost:8080/myservice/koTime

如果页面能正常显示,但是无法获取方法链路,可配置ko-time.context-path=
http://localhost:8080/myservice

可视化展示

1.接口调用统计

根据颜色判断需要优化的接口数,红色为待优化,绿色为正常

20220327112043.png

2.接口列表总览

在列表中会显示该接口的运行耗时,如果为绿色则无需优化,如果为红色,需要详细查看问题所在

20220327112104.png

3.调用详情

点开接口时,会显示该接口的调用链路以及运行时长,红色节点即为需要优化的节点

20220327112126.png

重要版本说明

V1.0:基本功能

V1.1:接口统计

V1.2:不可用,错误版本

V1.3:添加日志、时间阈值可配置

V1.4:添加 koTime.pointcut 配置

V1.8:支持 Mybatis 的 Mapper 监测、新增最大/最小运行时间、修复小数位数过长页面边界溢出的 bug

^b985dd

V2.0.0:添加异常监测,开放数据接口,修复与 swagger 冲突 bug,添加配置动态更新功能以及重构数据存储机制

V2.0.1:移除 freemarker 与 thymeleaf; 移除 spring.profiles.active=koTime 配置; 优化方法链路获取机制(移除 getAllStackTraces()); 替换 layui; 优化配置方式; 优化页面显示

V2.0.2:新增登录认证; 优化页面加载; 修复方法循环调用栈溢出的 bug

V2.0.7:Controller 层显示路由

V2.0.8:入参组合分析

原文