sander/perfix
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
Sander Hautvast 2018-07-10 22:07:40 +02:00
parent 1ade846957
commit ae51632c98
2 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.gitignore vendored
View file

@ -2,4 +2,4 @@
.idea/ .idea/
perfix.iml perfix.iml
target/ target/
hostkey.ser ui/node_modules

6
README.md
View file

@ -9,7 +9,7 @@ Pretty basic profiling tool for JVM's
* Execution time is measured in nanoseconds * Execution time is measured in nanoseconds
* No manual instrumentation necessary using loadtime bytecode manipulation (javassist). * No manual instrumentation necessary using loadtime bytecode manipulation (javassist).
* No special jdbc configuration necessary (ie no wrapped jdbc driver). * No special jdbc configuration necessary (ie no wrapped jdbc driver).
* The agent is also the server (unlike commercial tooling). This way there is no overhead in interprocess communication. * The agent is also the server (ui backend).
# Usage # Usage
* Agent that instruments loaded classes: -javaagent:<path>/perfix.jar * Agent that instruments loaded classes: -javaagent:<path>/perfix.jar
@ -18,7 +18,8 @@ Pretty basic profiling tool for JVM's
<br/> * #invocations <br/> * #invocations
<br/> * total execution time for the method in nanoseconds (this is also the sorting order) <br/> * total execution time for the method in nanoseconds (this is also the sorting order)
<br/> * average time in nanoseconds per method (= total/#invocations) <br/> * average time in nanoseconds per method (= total/#invocations)
* The http server starts on port 2048 by default. Use -Dperfix.port=... to adjust. * The backend starts on port 2048 by default. Use -Dperfix.port=... to adjust.
* Start the UI using npm install followed by npm start. the UI starts on port 3000 by default.
# roadmap # roadmap
@ -26,6 +27,7 @@ Pretty basic profiling tool for JVM's
* Finish jdbc query logging (CallableStatement) * Finish jdbc query logging (CallableStatement)
* Implement an actual call stack the way commercial tools work * Implement an actual call stack the way commercial tools work
* Ability to dynamically turn off metrics to minimize cpu and memory overhead (when response time is below a set treshold) * Ability to dynamically turn off metrics to minimize cpu and memory overhead (when response time is below a set treshold)
* extend the user interface
# DISCLAIMER: # DISCLAIMER:
This has only been tested on oracle java8 in spring-boot using tomcat web-container This has only been tested on oracle java8 in spring-boot using tomcat web-container