diff --git a/README.md b/README.md index c38b6f8..211e41d 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,15 @@ Pretty basic profiling tool for JVM's # Highlights: +* Provides method and SQL statement execution time. * Meant for development time (after process stops, data is gone). -* Minimal memory footprint (agent is 2.5 mb). -* Minimalistic commandline interface. +* Minimalistic commandline interface (ssh). * 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 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. +* Minimal memory footprint (agent is 2.5 mb). +* Overhead (in method execution time) not clear yet. I wouldn't use it in production. # Usage * Agent that instruments loaded classes: -javaagent:/perfix.jar @@ -17,11 +19,10 @@ Pretty basic profiling tool for JVM's
* #invocations
* total execution time for the method in nanoseconds (this is also the sorting order)
* 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 -* Overhead (in method execution time) not clear yet. I wouldn't use it in production. * Finish jdbc query logging * Make output format configurable * Implement password login (now any)