From 96ee9456c2abf27f64afd6214aa331b3eaf2ce54 Mon Sep 17 00:00:00 2001 From: Sander Hautvast Date: Tue, 29 Dec 2020 18:25:19 +0100 Subject: [PATCH] updated readme --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4828692..14008a9 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ # perfix Pretty basic profiling tool for JVM's +__Screenshot__ ![screenshot](https://github.com/shautvast/perfix/blob/master/screenshot.png) # Highlights: * 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) * Minimalistic web interface. * 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). # Usage -* Agent that instruments loaded classes: -javaagent:/perfix.jar +* build the project using: mvn clean install +* copy perfix-agent-$VERSION.jar to /perfix.jar +* Configure your JVM: -javaagent:/perfix.jar * 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:
* #invocations
* total execution time for the method in nanoseconds (this is also the sorting order)
* average time in nanoseconds per method (= total/#invocations)