ko-time/README-EN.md
2025-08-17 21:15:33 +08:00

132 lines
3.2 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<div align="center">
<h1 >KoTime<img src='https://shields.io/badge/forSpringboot-r.svg'></h1>
</div>
<div align="center">
<h2>Friendlier monitoring</h2>
</div>
<div align="center">
<img src='https://gitee.com/huoyo/ko-time/badge/star.svg'>
<img src='https://img.shields.io/github/stars/huoyo/ko-time.svg?&label=Stars&logo=github'>
<img src='https://shields.io/badge/version-2.5.1-green.svg'>
<img src='https://shields.io/badge/author-Chang Zhang-dbab09.svg'>
<img src='https://shields.io/badge/dependencies-Spring|aspectjweaver|tomcat|UIKit|Metricflow-r.svg'>
</div>
<h4>A lightweight springboot tool for tracing call graph ,which can help you find method's performances easily.</h4>
- ✅ Tracking the Java methods and calculating their execution times
- ✅ Show the paths of methods
- ✅ Find exceptions occurred in methods
- ✅ Email you after finding an overtime method
- ✅ Hot update online:you needn't restart it
- ✅ Thread manage:show threads information,the deadlocks included
- ✅ JVM SpaceEden、Survivor、OldGen and Metaspace
- ✅ Easy to use:you needn't additional learning costs
- ✅ Enough to add a pom dependency:you needn't additional deployment costs
![222](docs/kotime.gif)
## Locations
[Gitee](https://gitee.com/huoyo/ko-time.git)
[Github](https://github.com/huoyo/ko-time.git)
[Support](https://www.patreon.com/chongyang)
## Documents
[中文简介/CHINESE](README.md)
[documents](http://www.kotime.cn/)
## Display
1.Calculating the execution times of Java methods
Finding the methods that need optimize
> ![输入图片说明](docs/v220/syy.png)
2. Interface methods can be seen as follows
You can see every interface method that was called, and you need optimize them when they are red
![输入图片说明](docs/v201/apis.png)
3.Calling details
After clicking a inteface method,you can find paths of the method
![输入图片说明](docs/v204/ff.png)
4.Email
You can open email to receive a warning about overtime method since v2.2.5
![输入图片说明](docs/v200/image.png)
## Important Versions
> V1.0Basic functions
> V1.2Error version
> V1.3Log and time threshold
> V1.4Add koTime.pointcut
> V1.8Add the support for Mybatis and some metrics
> V1.9--
> V2.0.0Add the support for exceptions and data interfaces
> V2.0.1Remove freemarker and thymeleaf;
Remove 'spring.profiles.active=koTime';
Remove getAllStackTraces();
Remove layui;
Optimize configs
> V2.0.2Add auth;
> V2.0.7Display routes for Controllers
> V2.0.8Times for various params combinations
> V2.2.0Support using database to store data
> V2.2.2Support the viewer to use English
> V2.2.3Support using redis to store data
> V2.2.5Add `ko-time.discard-rate` to allow project discard some data;
Fix a bug for DataBase;
Add email;
> V2.2.8Hot update
>
> V2.3.0Add `ko-time.auth-expire` to allow users define timeout value;optimize ui
>
> V2.3.1Remove StringStack to adapt jdk17+
## Copyright
> 1.This project belongs to Chang Zhang,and Its open source protocol is LGPL-2.1
>
> 2.You can use it freely by linking it,but you can not do secondary development based on this before auhtor's authorization.;
>