From a3d84c9091829b4be298c50e360ea6bf9b1ed1c8 Mon Sep 17 00:00:00 2001
From: James Rasell <jamesrasell@gmail.com>
Date: Mon, 4 Nov 2019 15:12:21 +0100
Subject: [PATCH] docs: add details of available scaling state backend metrics.

---
 docs/configuration/telemetry.md | 85 +++++++++++++++++++++++++++++++++
 1 file changed, 85 insertions(+)

diff --git a/docs/configuration/telemetry.md b/docs/configuration/telemetry.md
index 4383b56..220b431 100644
--- a/docs/configuration/telemetry.md
+++ b/docs/configuration/telemetry.md
@@ -76,3 +76,88 @@ Runtime metrics allow operators to get insight into how the Sherpa server proces
     <td>Gauge</td>
   </tr>
 </table>
+
+# Scaling State Backend Metrics
+
+Scaling state backend metrics allow operators to get insight into how the scaling state backend is functioning.
+
+<table class="table table-bordered table-striped">
+  <tr>
+    <th>Metric</th>
+    <th>Description</th>
+    <th>Unit</th>
+    <th>Type</th>
+  </tr>
+  <tr>
+    <td>`sherpa.scale.state.memory.get_events`</td>
+    <td>Time taken to list all stored scaling activities from the memory backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.scale.state.memory.get_event`</td>
+    <td>Time taken to get a stored scaling activity from the memory backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.scale.state.memory.get_latest_events`</td>
+    <td>Time taken to list the latest stored scaling activities from the memory backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.scale.state.memory.get_latest_event`</td>
+    <td>Time taken to get the latest scaling activity for a job group from the memory backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.scale.state.memory.put_event`</td>
+    <td>Time taken to put a scaling activity in the memory backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.scale.state.memory.gc`</td>
+    <td>Time taken to run the scaling state garbage collector for the memory backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.scale.state.consul.get_events`</td>
+    <td>Time taken to list all stored scaling activities from the Consul backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.scale.state.consul.get_event`</td>
+    <td>Time taken to get a stored scaling activity from the Consul backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.scale.state.consul.get_latest_events`</td>
+    <td>Time taken to list the latest stored scaling activities from the Consul backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.scale.state.consul.get_latest_event`</td>
+    <td>Time taken to get the latest scaling activity for a job group from the Consul backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.scale.state.consul.put_event`</td>
+    <td>Time taken to put a scaling activity in the Consul backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.scale.state.consul.gc`</td>
+    <td>Time taken to run the scaling state garbage collector for the Consul backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+</table>