Merge pull request #436 from johnl/435-timer-metric-docs-fix

Describe timer sample rate in metric_types docs. Fixes #435
statsd · Feb 6, 2015 · 68ceda4 · 68ceda4
2 parents 1568565 + 0375990
commit 68ceda4
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/docs/metric_types.md b/docs/metric_types.md
@@ -22,7 +22,7 @@ Tells StatsD that this counter is being sent sampled every 1/10th of the time.
 Timing
 ------
 
-    glork:320|ms
+    glork:320|ms|@0.1
 
 The glork took 320ms to complete this time. StatsD figures out percentiles,
 average (mean), standard deviation, sum, lower and upper bounds for the flush interval.
@@ -67,6 +67,10 @@ Examples:
         [ { metric: 'foo', bins: [] },
           { metric: '', bins: [ 50, 100, 150, 200, 'inf'] } ]
 
+Statsd also maintains a counter for each timer metric. The 3rd field
+specifies the sample rate for this counter (in this example @0.1). The field
+is optional and defaults to 1.
+
 Note:
 
 * first match for a metric wins.