mirror of
https://gitee.com/huoyo/ko-time.git
synced 2025-12-06 08:48:30 +08:00
69 lines
2.3 KiB
Markdown
69 lines
2.3 KiB
Markdown
## Add a ependency
|
||
|
||
add a dependency in pom.xml.
|
||
|
||
|
||
```
|
||
<dependency>
|
||
<groupId>cn.langpy</groupId>
|
||
<artifactId>ko-time</artifactId>
|
||
<version>2.3.9</version>
|
||
</dependency>
|
||
```
|
||
|
||
## Config
|
||
|
||
Add some options in `application.properties`
|
||
|
||
* Required options
|
||
|
||
>
|
||
> ko-time.pointcut=`execution(public * com.huoyo..*.*(..))` # monitoring scope(refer to aop's @pointcut)
|
||
>
|
||
|
||
|
||
* Optional options
|
||
|
||
```
|
||
ko-time.enable=true # KoTime switch,default true
|
||
ko-time.log-enable=false # KoTime's console log switch,default false
|
||
ko-time.language=chinese # language（english/chinese）,default chinese
|
||
ko-time.threshold=800.0 # time threshold for the method node whose color is red if its avgRunTime>threshold,default 800
|
||
ko-time.context-path=http://localhost:80 # context path for the viwer,and you need not set it under normal circumstances. added in v2.0.1
|
||
ko-time.exception-enable=true # exception detect switch，default false. added in v2.0.0
|
||
ko-time.auth-enable=true # authentication switch，default false. added in v2.0.2
|
||
ko-time.user-name=xxxx # username added in v2.0.2
|
||
ko-time.password=xxxx # password added in v2.0.2
|
||
ko-time.data-reset=false # delete data switch ,default false. added in v2.2.3
|
||
ko-time.param-analyse=true # param-analyse switch, default true. added in v2.0.8(you can see it when you dblclick on the method node)
|
||
ko-time.thread-num=2 # thread-num to to store data,default 2. this value is up to the performance of cpu and database.added in v2.2.0-BETA
|
||
ko-time.discard-rate=0.3 # discard rate（0-1） you can give up some data for IO performance,default 30%. added in v2.2.5
|
||
ko-time.auth-expire=43200 # login timeout value default 43200 s.added in v2.3.0
|
||
```
|
||
|
||
## Visit
|
||
|
||
> Notice：
|
||
> 1.after adding above configurations，you need also add some dependencies about aop such as aspectj or spring-boot-starter-aop.
|
||
> 2.allow `/koTime` and `/koTime/**` to access you service without authorization
|
||
> 3.stop here, and you have done all jobs.
|
||
|
||
|
||
|
||
* run you service and visit `/koTime`
|
||
|
||
|
||
|
||
> use chrome or edge
|
||
|
||
visit `http://localhost:8080/context-path/koTime` if you set context-path
|
||
|
||
for example: visit `http://localhost:8080/myservice/koTime` if you set `server.servlet.context-path=/myservice` in application.properties
|
||
|
||
set `ko-time.context-path=http://localhost:8080/myservice` if you can not access you service,but it is not recommended!
|
||
|
||
|
||
---
|
||
|
||
|