storm-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [3/6] storm git commit: adding documentation for storm metrics
Date Fri, 06 Nov 2015 17:08:12 GMT
adding documentation for storm metrics


Branch: refs/heads/master
Commit: 8501184e39b565888995b4262c1758e334428eff
Parents: b98acd3
Author: Boyang Jerry Peng <>
Authored: Tue Nov 3 16:36:29 2015 -0600
Committer: Boyang Jerry Peng <>
Committed: Wed Nov 4 13:45:26 2015 -0600

 .../ | 70 ++++++++++++++++++++
 1 file changed, 70 insertions(+)
diff --git a/docs/documentation/ b/docs/documentation/
new file mode 100644
index 0000000..266285d
--- /dev/null
+++ b/docs/documentation/
@@ -0,0 +1,70 @@
+# Storm Metrics for Profiling Various Storm Internal Actions
+With the addition of these metrics, Storm users can collect, view, and analyze the performance
of various internal actions.  The actions that are profiled include thrift rpc calls and http
quests within the storm daemons. For instance, in the Storm Nimbus daemon, the following thrift
calls defined in the Nimbus$Iface are profiled:
+- submitTopology
+- submitTopologyWithOpts
+- killTopology
+- killTopologyWithOpts
+- activate
+- deactivate
+- rebalance
+- setLogConfig
+- getLogConfig
+Various HTTP GET and POST requests are marked for profiling as well such as the GET and POST
requests for the Storm UI daemon (ui/core.cj)
+To implement these metrics the following packages are used: 
+- io.dropwizard.metrics
+- metrics-clojure
+## How it works
+By using packages io.dropwizard.metrics and metrics-clojure (clojure wrapper for the metrics
Java API), we can mark functions to profile by declaring (defmeter num-some-func-calls) and
then adding the (mark! num-some-func-calls) to where the function is invoked. For example:
+    (defmeter num-some-func-calls)
+    (defn some-func [args]
+        (mark! num-some-func-calls)
+        (body))
+What essentially the mark! API call does is increment a counter that represents how many
times a certain action occured.  For instantanous measurements user can use gauges.  For example:

+    (defgauge nimbus:num-supervisors
+         (fn [] (.size (.supervisors (:storm-cluster-state nimbus) nil))))
+The above example will get the number of supervisors in the cluster.  This metric is not
accumlative like one previously discussed.
+A metrics reporting server needs to also be activated to collect the metrics. You can do
this by calling the following function:
+    (defn start-metrics-reporters []
+        (jmx/start (jmx/reporter {})))
+## How to collect the metrics
+Metrics can be reported via JMX or HTTP.  A user can use JConsole or VisualVM to connect
to the jvm process and view the stats.
+To view the metrics in a GUI use VisualVM or JConsole.  Screenshot of using VisualVm for
+![alt text](
+For detailed information regarding how to collect the metrics please reference: 
+If you want use JMX and view metrics through JConsole or VisualVM, remember launch JVM processes
your want to profile with the correct JMX configurations.  For example in Storm you would
add the following to conf/storm.yaml
+    nimbus.childopts: "-Xmx1024m"
+    ui.childopts: "-Xmx768m"
+    logviewer.childopts: "-Xmx128m"
+    drpc.childopts: "-Xmx768m"
+    supervisor.childopts: "-Xmx256m"
+For more information about io.dropwizard.metrics and metrics-clojure packages please reference
their original documentation:

View raw message