mirror of
https://gitee.com/huoyo/ko-time.git
synced 2025-12-08 01:38:26 +08:00
3.3 KiB
3.3 KiB
引入依赖
在pom.xml文件中引入
<dependency>
<groupId>cn.langpy</groupId>
<artifactId>ko-time</artifactId>
<version>2.2.6</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.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开始支持 双击方法节点即可看到效果
ko-time.data-reset=false # 启动时是否删除过往数据 默认false v2.2.3开始支持
ko-time.thread-num=2 # 调用信息存储线程数(为了不影响项目本身性能,链路存储异步进行),默认2,该值并非越大越好,瓶颈取决于数据库性能和服务器配置,尽可能少占用项目资源为上 v2.2.0-BETA开始支持
ko-time.discard-rate=0.3 # 丢弃率(0-1) 同一个方法在多次连续调用时,耗时差距并不大,为了存储的IO性能考虑,可以随机丢弃一部分耗时数据。默认30% v2.2.5开始支持
访问
注意:
1.引入了上面的依赖和配置以后,确认项目中是否有aop相关的包,koTime使用了@Aspect注解,未引入的自行引入,如aspectj或者spring-boot-starter-aop
2.做完前面的步骤,koTime的集成已经完毕,无需进行其他配置
3.如果后台有权限认证,需要放开/koTime和/koTime/**
4.v2.2.5集成了邮件功能,如果项目报错javamail相关的类NotFoundException时,需要引入:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-mail</artifactId>
</dependency>
-
启动项目访问
/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://正确路径/myservice进行koTime接口访问路径纠正