Skip to content

Commit

Permalink
TRACING-4067: add documentation for kubelet stats receiver
Browse files Browse the repository at this point in the history
Signed-off-by: Israel Blancas <iblancasa@gmail.com>
  • Loading branch information
iblancasa committed Mar 22, 2024
1 parent 1e88ac9 commit 532e24e
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions modules/otel-collector-components.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,38 @@ The Jaeger receiver ingests traces in the Jaeger formats.
<4> The Jaeger Thrift Binary endpoint. If omitted, the default `+0.0.0.0:6832+` is used.
<5> The server-side TLS configuration. See the OTLP receiver configuration section for more details.

[id="kubeletstats-receiver_{context}"]
=== Kubelet Stats Receiver

The Kubelet Stats Receiver extracts metrics related to nodes, pods, containers, and volumes from the kubelet's API server. These metrics are then channeled through the metrics processing pipeline for additional analysis.

Add this to your OpenTelemetry Collector instance to set the `K8S_NODE_NAME` to authenticate to the API:
[source,yaml]
----
env:
- name: K8S_NODE_NAME
valueFrom:
fieldRef:
fieldPath: spec.nodeName
----

.OpenTelemetry Collector custom resource with an enabled Kubelet Stats receiver
[source,yaml]
----
config: |
receivers:
kubeletstats:
collection_interval: 20s
auth_type: "serviceAccount"
endpoint: "https://${env:K8S_NODE_NAME}:10250"
insecure_skip_verify: true
service:
pipelines:
metrics:
receivers: [kubeletstats]
----


[id="prometheus-receiver_{context}"]
=== Prometheus Receiver

Expand Down

0 comments on commit 532e24e

Please sign in to comment.