docs: add details of available policy backend metrics.

jrasell · Nov 4, 2019 · 6c04ad7 · 6c04ad7
1 parent 840b537
commit 6c04ad7
Showing 1 changed file with 97 additions and 0 deletions.
diff --git a/docs/configuration/telemetry.md b/docs/configuration/telemetry.md
@@ -76,3 +76,100 @@ Runtime metrics allow operators to get insight into how the Sherpa server proces
     <td>Gauge</td>
   </tr>
 </table>
+
+# Policy Backend Metrics
+
+Policy backend metrics allow operators to get insight into how the policy storage 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.policy.memory.get_policies`</td>
+    <td>Time taken to list all stored scaling policies from the memory backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.policy.memory.get_job_policy`</td>
+    <td>Time taken to get a job scaling policy from the memory backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.policy.memory.get_job_group_policy`</td>
+    <td>Time taken to get a job group scaling policy from the memory backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.policy.memory.put_job_policy`</td>
+    <td>Time taken to put a job scaling policy in the memory backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.policy.memory.put_job_group_policy`</td>
+    <td>Time taken to put a job group scaling policy in the memory backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.policy.memory.delete_job_policy`</td>
+    <td>Time taken to delete a job scaling policy from the memory backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.policy.memory.delete_job_group_policy`</td>
+    <td>Time taken to delete a job group scaling policy from the memory backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.policy.consul.get_policies`</td>
+    <td>Time taken to list all stored scaling policies from the Consul backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.policy.consul.get_job_policy`</td>
+    <td>Time taken to get a job scaling policy from the Consul backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.policy.consul.get_job_group_policy`</td>
+    <td>Time taken to get a job group scaling policy from the Consul backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.policy.consul.put_job_policy`</td>
+    <td>Time taken to put a job scaling policy in the Consul backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.policy.consul.put_job_group_policy`</td>
+    <td>Time taken to put a job group scaling policy in the Consul backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.policy.consul.delete_job_policy`</td>
+    <td>Time taken to delete a job scaling policy from the Consul backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+  <tr>
+    <td>`sherpa.policy.consul.delete_job_group_policy`</td>
+    <td>Time taken to delete a job group scaling policy from the Consul backend</td>
+    <td>Milliseconds</td>
+    <td>Summary</td>
+  </tr>
+</table>