Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates docs to match PR #5174 #1258

Closed
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 20 additions & 8 deletions content/docs/2.13/operate/prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,30 @@ weight = 100
The KEDA Operator exposes Prometheus metrics which can be scraped on port `8080` at `/metrics`. The following metrics are being gathered:

- `keda_build_info` - Info metric, with static information about KEDA build like: version, git commit and Golang runtime info.
- `keda_scaler_active` - This metric marks whether the particular scaler is active (value == 1) or in-active (value == 0).
- `keda_internal_scale_loop_latency_seconds` - Total deviation (in seconds) between the expected execution time and the actual execution time for the scaling loop. This latency could be produced due to accumulated scalers latencies or high load. This is an internal metric.
- `keda_resource_handled_total` - Total number of KEDA custom resources per namespace for each custom resource type (CRD) handled by the operator.
- `keda_scaled_object_errors_total` - The number of errors that have occurred for each ScaledObject.
- `keda_scaled_object_paused` - This metric indicates whether a ScaledObject is paused (value == 1) or un-paused (value == 0).
- `keda_scaler_active` - This metric marks whether the particular scaler is active (value == 1) or in-active (value == 0).
- `keda_scaler_errors_total` - The total number of errors encountered for each scaler.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the keda_scaler_errors_total existed before, I'd suggest keda_scaler_detail_errors_total instead kedacore/keda#5687 (comment)

Suggested change
- `keda_scaler_errors_total` - The total number of errors encountered for each scaler.
- `keda_scaler_detail_errors_total` - The total number of errors encountered for each scaler.

- `keda_scaler_metrics_latency_seconds` - The latency of retrieving current metric from each scaler, in seconds.
- `keda_scaler_metrics_value` - The current value for each scaler's metric that would be used by the HPA in computing the target average.
- `keda_scaler_metrics_latency` - The latency of retrieving current metric from each scaler.
- `keda_scaler_errors` - The number of errors that have occurred for each scaler.
- `keda_scaler_errors_total` - The total number of errors encountered for all scalers.
- `keda_scaled_object_errors` - The number of errors that have occurred for each ScaledObject.
- `keda_resource_totals` - Total number of KEDA custom resources per namespace for each custom resource type (CRD).
- `keda_trigger_totals` - Total number of triggers per trigger type.
- `keda_internal_scale_loop_latency` - Total deviation (in milliseconds) between the expected execution time and the actual execution time for the scaling loop. This latency could be produced due to accumulated scalers latencies or high load. This is an internal metric.
- `keda_scaler_paused` - This metric marks whether the particular scaler is paused (value == 1) or not paused (value == 0).
- `keda_trigger_handled_total` - Total number of triggers per trigger type handled by the operator.
- Metrics exposed by the `Operator SDK` framework as explained [here](https://sdk.operatorframework.io/docs/building-operators/golang/advanced-topics/#metrics).

#### Deprecated metrics

The following metrics are exposed as well, but are deprecated and will be removed in a future release.

- `keda_internal_scale_loop_latency` - Replaced by `keda_internal_scale_loop_latency_seconds`.
- `keda_resource_totals` - Replaced by `keda_resource_handled_total`.
- `keda_scaled_object_errors` - Replaced by `keda_scaled_object_errors_total`.
- `keda_scaler_errors_total` - The unlabeled version is deprecated. Sum the `keda_scaler_errors_total`.
- `keda_scaler_errors` - Replaced by `keda_scaler_errors_total` (labeled).
- `keda_scaler_metrics_latency` - Replaced by `keda_scaler_metrics_latency_seconds`.
- `keda_trigger_totals` - Replaced by `trigger_handled_total`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit:

Suggested change
- `keda_trigger_totals` - Replaced by `trigger_handled_total`.
- `keda_trigger_totals` - Replaced by `keda_trigger_handled_total`.


### Admission Webhooks

The KEDA Webhooks expose Prometheus metrics which can be scraped on port `8080` at `/metrics`. The following metrics are being gathered:
Expand Down