METRICS.md

Shell-operator metrics

Shell-operator exports Prometheus metrics to the /metrics path. The default port is 9115.

shell_operator_hook_errors{hook="hook-name"}

This is the counter of hooks’ execution errors. It only tracks errors of hooks with the disabled allowFailure (i.e. respective key is omitted in the configuration or the allowFailure: false parameter is set). This metric has a “hook” label with the name of a failed hook.

shell_operator_hook_allowed_errors{hook="hook-name"}

This is the counter of hooks’ execution errors. It only tracks errors of hooks that are allowed to exit with an error (the parameter allowFailure: true is set in the configuration). The metric has a “hook” label with the name of a failed hook.

shell_operator_tasks_queue_length

A gauge showing the length of the working queue. This metric can be used to warn about stuck hooks. It has no labels.

shell_operator_live_ticks

A counter that increases every 10 seconds. This metric can be used for alerting about a hung Shell-operator. It has no labels.