-
Notifications
You must be signed in to change notification settings - Fork 440
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: OpenTelemetry Collector metrics (#1215)
Co-authored-by: Tom Kerkhove <[email protected]> Co-authored-by: Zbynek Roubalik <[email protected]>
- Loading branch information
1 parent
87d4351
commit accd230
Showing
3 changed files
with
46 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
+++ | ||
title= "Integrate with OpenTelemetry Collector (Experimental)" | ||
description= "Detail of integrating OpenTelemetry Collector in KEDA" | ||
weight = 100 | ||
+++ | ||
|
||
## Push Metrics to OpenTelemetry Collector (Experimental) | ||
|
||
### Operator | ||
|
||
The KEDA Operator supports outputting metrics to the OpenTelemetry collector using HTTP. The parameter `--enable-opentelemetry-metrics=true` needs to be set. KEDA will push metrics to the OpenTelemetry collector specified by the `OTEL_EXPORTER_OTLP_ENDPOINT` environment variable. Other environment variables in OpenTelemetry are also supported (https://opentelemetry.io/docs/concepts/sdk-configuration/otlp-exporter-configuration/). Here is an example configuration of the operator: | ||
``` | ||
apiVersion: apps/v1 | ||
kind: Deployment | ||
metadata: | ||
name: keda-operator | ||
... | ||
containers: | ||
- name: keda-operator | ||
image: ghcr.io/kedacore/keda:latest | ||
command: | ||
- /keda | ||
args: | ||
--enable-opentelemetry-metrics=true | ||
... | ||
... | ||
env: | ||
- name: OTEL_EXPORTER_OTLP_ENDPOINT | ||
value: "http://opentelemetry-collector.default.svc.cluster.local:4318" | ||
``` | ||
The following metrics are being gathered: | ||
|
||
| Metric | Description | | ||
| ------ | ----------- | | ||
| `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.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. | |