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

Update README.md

Browse source
This commit is contained in:
Sander Hautvast 2018-05-17 15:49:05 +02:00 • committed by GitHub
parent 7875c68ec3
commit e858077b52
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -2,13 +2,15 @@
Pretty basic profiling tool for JVM's Pretty basic profiling tool for JVM's
# Highlights: # Highlights:
* Provides method and SQL statement execution time.
* Meant for development time (after process stops, data is gone). * Meant for development time (after process stops, data is gone).
* Minimal memory footprint (agent is 2.5 mb). * Minimalistic commandline interface (ssh).
* Minimalistic commandline interface.
* Execution time is measured in nanoseconds, reported in milliseconds (this way the totals and averages are most precise, but also human readable). * Execution time is measured in nanoseconds, reported in milliseconds (this way the totals and averages are most precise, but also human readable).
* 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 (unlike commercial tooling). This way there is no overhead in interprocess communication.
* Minimal memory footprint (agent is 2.5 mb).
* Overhead (in method execution time) not clear yet. I wouldn't use it in production.
# Usage # Usage
* Agent that instruments loaded classes: -javaagent:<path>/perfix.jar * Agent that instruments loaded classes: -javaagent:<path>/perfix.jar
@ -17,11 +19,10 @@ 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 (ssh) server starts on port 2048 by default. Use -Dperfix.port=... to adjust. * The ssh server starts on port 2048 by default. Use -Dperfix.port=... to adjust.
# roadmap # roadmap
* Overhead (in method execution time) not clear yet. I wouldn't use it in production.
* Finish jdbc query logging * Finish jdbc query logging
* Make output format configurable * Make output format configurable
* Implement password login (now any) * Implement password login (now any)