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 Gauge + +# Scaling State Backend Metrics + +Scaling state backend metrics allow operators to get insight into how the scaling state backend is functioning. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
MetricDescriptionUnitType
`sherpa.scale.state.memory.get_events`Time taken to list all stored scaling activities from the memory backendMillisecondsSummary
`sherpa.scale.state.memory.get_event`Time taken to get a stored scaling activity from the memory backendMillisecondsSummary
`sherpa.scale.state.memory.get_latest_events`Time taken to list the latest stored scaling activities from the memory backendMillisecondsSummary
`sherpa.scale.state.memory.get_latest_event`Time taken to get the latest scaling activity for a job group from the memory backendMillisecondsSummary
`sherpa.scale.state.memory.put_event`Time taken to put a scaling activity in the memory backendMillisecondsSummary
`sherpa.scale.state.memory.gc`Time taken to run the scaling state garbage collector for the memory backendMillisecondsSummary
`sherpa.scale.state.consul.get_events`Time taken to list all stored scaling activities from the Consul backendMillisecondsSummary
`sherpa.scale.state.consul.get_event`Time taken to get a stored scaling activity from the Consul backendMillisecondsSummary
`sherpa.scale.state.consul.get_latest_events`Time taken to list the latest stored scaling activities from the Consul backendMillisecondsSummary
`sherpa.scale.state.consul.get_latest_event`Time taken to get the latest scaling activity for a job group from the Consul backendMillisecondsSummary
`sherpa.scale.state.consul.put_event`Time taken to put a scaling activity in the Consul backendMillisecondsSummary
`sherpa.scale.state.consul.gc`Time taken to run the scaling state garbage collector for the Consul backendMillisecondsSummary