metrics-clojure / docs / source / reporting.rst

Diff from to

docs/source/reporting.rst

 Reporting
 =========
 
-Currently ``metrics-clojure`` supports reporting metrics through the
-console (on standard error)::
+Once you've started tracking some metrics there are several ways you can read
+their values.
+
+More reporting methods will be added in the future.  Pull requests are welcome.
+
+Console
+-------
+
+metrics-clojure supports reporting metrics through the console (on standard
+error)::
 
     (use '[metrics.core :only (report-to-console)])
 
 This will tell ``metrics`` to print all metrics to the console every ten
 seconds.
 
-``metrics-clojure`` also supports [JMX reporting][jmx], since it's built into
+JMX and ``jvisualvm``
+---------------------
+
+metrics-clojure also supports `JMX reporting
+<http://metrics.codahale.com/manual.html#jmx-reporter>`_, since it's built into
 ``metrics`` itself.
 
-More reporting methods will be added in the future.  Pull requests are welcome.
-
-[jmx]: http://metrics.codahale.com/manual.html#jmx-reporter
+In a nutshell: you can open ``jvisualvm`` (which you probably already have as
+it's included in many Java distributions), connect to a process, and view
+metrics in the MBeans tab.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.