From 08a150f1ebc97047226b58d5e5fa5316b413b79e Mon Sep 17 00:00:00 2001
From: Michael Baird <mbaird@umbel.com>
Date: Mon, 22 May 2017 11:31:28 -0500
Subject: [PATCH] StatsD documentation

---
 docs/administration.md | 55 ++++++++++++++++++++++++++++++++++++++++++
 docs/configuration.md  | 33 +++++++++++++++++++++++++
 2 files changed, 88 insertions(+)

diff --git a/docs/administration.md b/docs/administration.md
index 26c7ed7ba..94eea518c 100644
--- a/docs/administration.md
+++ b/docs/administration.md
@@ -97,3 +97,58 @@ Note: This will only work when the replication factor is >= 2
 - Modify the cluster config file to replace the previous node address with the new node address.
 - Restart the cluster
 - Wait for the 1st sync (10 minutes) to validate Index connections
+
+#### Metrics
+
+Pilosa can be configured to emit metrics on its internal processes in 2 formats, Expvar or StatsD.  Metric recording is disabled by default and enabled through the configuration file.  
+Through the configuration file choose the metric type, host to receive events, and polling interval for runtime metrics.
+
+##### Tags
+StatsD Tags are in DataDog format (key:value), and we tag the following:
+
+- NodeID
+- Index
+- Frame
+- View
+- Slice
+
+##### Events
+We currently track the following events
+
+<strong id="index">Index:</strong> The creation of a new Index.
+
+<strong id="frame">Frame:</strong> The creation of a new Frame.
+
+<strong id="maxSlice">MaxSlice:</strong> The Creation of a new Slice.
+
+<strong id="setbit">SetBit:</strong> Count of set bits on a row and column.
+
+<strong id="clearbit">ClearBit:</strong> Count of cleared bits a previously set bit on a row and column.
+
+<strong id="importbit">ImportBit:</strong> During a bulk data import this records the count of bits created.
+
+<strong id="setrowattrs">SetRowAttrs:</strong> Count of Attributes set per row
+
+<strong id="setcollumnattrs">SetColumnAttrs:</strong> Count of Attributes set per collumn.
+
+<strong id="bitmap">Bitmap:</strong> Count of Bitmap queries run.
+
+<strong id="topn">TopN:</strong> Count of TopN queries run.
+
+<strong id="union">Union:</strong> Count of Union queries.
+
+<strong id="intersection">Intersection:</strong> Count of Intersection queries.
+
+<strong id="difference">Difference:</strong> Count of Difference queries.
+
+<strong id="count">Count:</strong> Count of Count queries.
+
+<strong id="range">Range:</strong> Count of Range queries.
+
+<strong id="snapshot">Snapshot:</strong> Event count when the snapshot process is triggered.
+
+<strong id="blockrepair">BlockRepair:</strong> Count of data blocks that were out of sync and repaired.
+
+<strong id="garbage_collection">Garbage Collection:</strong> Event count when Garbage Collection occurs, 
+
+<strong id="goroutines">Goroutines:</strong> Number of running Goroutines.
diff --git a/docs/configuration.md b/docs/configuration.md
index 12153dde1..9be899bf2 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -167,3 +167,36 @@ Any flag that has a value that is a comma separated list on the command line bec
     [profile]
     cpu-time = "30s"
     ```
+##### Metric Service
+* Description: which stats service to use (StatsD or ExpVar)
+* Flag: `--metric.service=statsd`
+* Env: `PILOSA_METRIC.SERVICE=statsd'
+* Config:
+
+    ```toml
+    [metric]
+    service = “statsd”
+    ```
+
+##### Metric Host
+* Description: where is the StatsD service hosted
+* Flag: `--metric.host=localhost:8125`
+* Env: `PILOSA_METRIC.HOST=localhost:8125'
+* Config:
+
+    ```toml
+    [metric]
+    host = "localhost:8125"
+    ```
+
+##### Metric Poll Interval
+
+* Description: Polling interval for runtime metrics.
+* Flag: `metric.poll-interval=”0m15s”`
+* Env: `PILOSA_METRIC.POLL_INTERVAL=0m15s`
+* Config:
+
+    ```toml
+    [metric]
+    poll-interval = "0m15s"
+    ```
\ No newline at end of file