Skip to content
This repository has been archived by the owner on Sep 9, 2020. It is now read-only.

Commit

Permalink
docs: add details of available autoscaler metrics.
Browse files Browse the repository at this point in the history
  • Loading branch information
jrasell committed Nov 4, 2019
1 parent e4aff64 commit 4efaba7
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions docs/configuration/telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,58 @@ Runtime metrics allow operators to get insight into how the Sherpa server proces
<td>Gauge</td>
</tr>
</table>

# Autoscale Metrics

Autoscale metrics allow operators to get insight into how the autoscaler 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.autoscale.{job}.evaluation`</td>
<td>The time taken to perform the autoscaling evaluation for the job named {job}</td>
<td>Milliseconds</td>
<td>Summary</td>
</tr>
<tr>
<td>`sherpa.autoscale.evaluation.error`</td>
<td>Number of autoscaling evaluation errors across all jobs</td>
<td>Number of errors</td>
<td>Counter</td>
</tr>
<tr>
<td>`sherpa.autoscale.{job}.evaluation.error`</td>
<td>Number of autoscaling evaluation errors for the job named {job}</td>
<td>Number of errors</td>
<td>Counter</td>
</tr>
<tr>
<td>`sherpa.autoscale.trigger.error`</td>
<td>Number of autoscaling scale trigger errors across all jobs</td>
<td>Number of errors</td>
<td>Counter</td>
</tr>
<tr>
<td>`sherpa.autoscale.{job}.trigger.error`</td>
<td>Number of autoscaling scale trigger errors for the job named {job}</td>
<td>Number of errors</td>
<td>Counter</td>
</tr>
<tr>
<td>`sherpa.autoscale.trigger.success`</td>
<td>Number of autoscaling scale trigger successes across all jobs</td>
<td>Number of successes</td>
<td>Counter</td>
</tr>
<tr>
<td>`sherpa.autoscale.{job}.trigger.success`</td>
<td>Number of autoscaling scale trigger successes for the job named {job}</td>
<td>Number of successes</td>
<td>Counter</td>
</tr>
</table>

0 comments on commit 4efaba7

Please sign in to comment.