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

updated readme

Browse source
This commit is contained in:
Sander Hautvast 2020-12-29 18:25:19 +01:00
parent 87995efa63
commit 96ee9456c2
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -1,11 +1,12 @@
# perfix # perfix
Pretty basic profiling tool for JVM's Pretty basic profiling tool for JVM's
__Screenshot__
![screenshot](https://github.com/shautvast/perfix/blob/master/screenshot.png) ![screenshot](https://github.com/shautvast/perfix/blob/master/screenshot.png)
# Highlights: # Highlights:
* Meant for development time (after process stops, data is gone). * Meant for development time (after process stops, data is gone).
* Minimal memory footprint (agent ~ 1 mb). * Minimal memory footprint (agent ~ 900 kb).
* Easy setup (2 commandline arguments for java process) * Easy setup (2 commandline arguments for java process)
* Minimalistic web interface. * Minimalistic web interface.
* Execution time is measured in nanoseconds * Execution time is measured in nanoseconds
@ -14,9 +15,11 @@ Pretty basic profiling tool for JVM's
* The agent is also the server (ui backend). * The agent is also the server (ui backend).
# Usage # Usage
* Agent that instruments loaded classes: -javaagent:<path>/perfix.jar * build the project using: mvn clean install
* copy perfix-agent-$VERSION.jar to <path>/perfix.jar
* Configure your JVM: -javaagent:<path>/perfix.jar
* Include classes for instrumentation with -Dperfix.includes=com.project. ...etc (includes subpackages) * Include classes for instrumentation with -Dperfix.includes=com.project. ...etc (includes subpackages)
* Web page to report executed methods and sql query excutions: * Head to http://localhost:2048 for reports executed methods and sql query excutions:
<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)