@@ -20,7 +20,7 @@ see how all the monitoring responds to an active workload.
20
20
If you're looking to start migrating from Prometheus to OpenTelemetry, or if
21
21
you're interested in using the OpenTelemetry Collector to collect Prometheus
22
22
metrics, see
23
- [ Prometheus Receiver] ( .. /collector/components/#prometheus-receiver) .
23
+ [ Prometheus Receiver] ( /docs/platforms/kubernetes /collector/components/#prometheus-receiver) .
24
24
25
25
## Overview
26
26
@@ -41,12 +41,13 @@ metrics for nodes, pods, and containers. The deployment installation of the
41
41
collector will be used to collect metrics for the cluster and events.
42
42
43
43
To install the collector, we'll use the
44
- [ OpenTelemetry Collector Helm chart] ( ../helm/collector/ ) , which comes with a few
45
- configuration options that will make configure the collector easier. If you're
46
- unfamiliar with Helm, check out [ the Helm project site] ( https://helm.sh/ ) . If
47
- you're interested in using a Kubernetes operator, see
48
- [ OpenTelemetry Operator] ( ../operator/ ) , but this guide will focus on the Helm
49
- chart.
44
+ [ OpenTelemetry Collector Helm chart] ( /docs/platforms/kubernetes/helm/collector/ ) ,
45
+ which comes with a few configuration options that will make configure the
46
+ collector easier. If you're unfamiliar with Helm, check out
47
+ [ the Helm project site] ( https://helm.sh/ ) . If you're interested in using a
48
+ Kubernetes operator, see
49
+ [ OpenTelemetry Operator] ( /docs/platforms/kubernetes/operator/ ) , but this guide
50
+ will focus on the Helm chart.
50
51
51
52
## Preparation
52
53
@@ -81,12 +82,12 @@ This instance of the collector will use the following components:
81
82
82
83
- [ OTLP Receiver] ( https://github.com/open-telemetry/opentelemetry-collector/tree/main/receiver/otlpreceiver ) :
83
84
to collect application traces, metrics and logs.
84
- - [ Kubernetes Attributes Processor] ( .. /collector/components/#kubernetes-attributes-processor) :
85
+ - [ Kubernetes Attributes Processor] ( /docs/platforms/kubernetes /collector/components/#kubernetes-attributes-processor) :
85
86
to add Kubernetes metadata to incoming application telemetry.
86
- - [ Kubeletstats Receiver] ( ../ collector/components/#kubeletstats-receiver) : to
87
- pull node, pod, and container metrics from the API server on a kubelet.
88
- - [ Filelog Receiver] ( ../ collector/components/#filelog-receiver) : to collect
89
- Kubernetes logs and application logs written to stdout/stderr.
87
+ - [ Kubeletstats Receiver] ( /docs/platforms/kubernetes/ collector/components/#kubeletstats-receiver) :
88
+ to pull node, pod, and container metrics from the API server on a kubelet.
89
+ - [ Filelog Receiver] ( /docs/platforms/kubernetes/ collector/components/#filelog-receiver) :
90
+ to collect Kubernetes logs and application logs written to stdout/stderr.
90
91
91
92
Let's break these down.
92
93
@@ -108,7 +109,7 @@ Kubernetes metadata using the `k8sattributes` processor.
108
109
### Kubernetes Attributes Processor
109
110
110
111
The
111
- [ Kubernetes Attributes Processor] ( .. /collector/components/#kubernetes-attributes-processor)
112
+ [ Kubernetes Attributes Processor] ( /docs/platforms/kubernetes /collector/components/#kubernetes-attributes-processor)
112
113
is a highly recommended component in any collector receive telemetry from
113
114
Kubernetes pods. This processor automatically discovers Kubernetes pods,
114
115
extracts their metadata such as pod name or node name, and adds the extracted
@@ -119,8 +120,9 @@ Kubernetes telemetry, such as pod metrics and traces.
119
120
120
121
### Kubeletstats Receiver
121
122
122
- The [ Kubeletstats Receiver] ( ../collector/components/#kubeletstats-receiver ) is
123
- the receiver that gathers metrics about the node. It will gather metrics like
123
+ The
124
+ [ Kubeletstats Receiver] ( /docs/platforms/kubernetes/collector/components/#kubeletstats-receiver )
125
+ is the receiver that gathers metrics about the node. It will gather metrics like
124
126
container memory usage, pod cpu usage, and node network errors. All of the
125
127
telemetry includes Kubernetes metadata like pod name or node name. Since we're
126
128
using the Kubernetes Attributes Processor, we'll be able to correlate our
@@ -129,10 +131,12 @@ Kubeletstats Receiver.
129
131
130
132
### Filelog Receiver
131
133
132
- The [ Filelog Receiver] ( ../collector/components/#filelog-receiver ) will collect
133
- logs written to stdout/stderr by tailing the logs Kubernetes writes to
134
- ` /var/log/pods/*/*/*.log ` . Like most log tailers, the filelog receiver provides
135
- a robust set of actions that allow you to parse the file however you need.
134
+ The
135
+ [ Filelog Receiver] ( /docs/platforms/kubernetes/collector/components/#filelog-receiver )
136
+ will collect logs written to stdout/stderr by tailing the logs Kubernetes writes
137
+ to ` /var/log/pods/*/*/*.log ` . Like most log tailers, the filelog receiver
138
+ provides a robust set of actions that allow you to parse the file however you
139
+ need.
136
140
137
141
Someday you may need to configure a Filelog Receiver on your own, but for this
138
142
walkthrough the OpenTelemetry Helm Chart will handle all the complex
@@ -205,25 +209,25 @@ data.
205
209
206
210
This instance of the Collector will use the following components:
207
211
208
- - [ Kubernetes Cluster Receiver] ( .. /collector/components/#kubernetes-cluster-receiver) :
212
+ - [ Kubernetes Cluster Receiver] ( /docs/platforms/kubernetes /collector/components/#kubernetes-cluster-receiver) :
209
213
to collect cluster-level metrics and entity events.
210
- - [ Kubernetes Objects Receiver] ( .. /collector/components/#kubernetes-objects-receiver) :
214
+ - [ Kubernetes Objects Receiver] ( /docs/platforms/kubernetes /collector/components/#kubernetes-objects-receiver) :
211
215
to collect objects, such as events, from the Kubernetes API server.
212
216
213
217
Let's break these down.
214
218
215
219
### Kubernetes Cluster Receiver
216
220
217
221
The
218
- [ Kubernetes Cluster Receiver] ( .. /collector/components/#kubernetes-cluster-receiver)
222
+ [ Kubernetes Cluster Receiver] ( /docs/platforms/kubernetes /collector/components/#kubernetes-cluster-receiver)
219
223
is the Collector's solution for collecting metrics about the state of the
220
224
cluster as a whole. This receiver can gather metrics about node conditions, pod
221
225
phases, container restarts, available and desired deployments, and more.
222
226
223
227
### Kubernetes Objects Receiver
224
228
225
229
The
226
- [ Kubernetes Objects Receiver] ( .. /collector/components/#kubernetes-objects-receiver)
230
+ [ Kubernetes Objects Receiver] ( /docs/platforms/kubernetes /collector/components/#kubernetes-objects-receiver)
227
231
is the Collector's solution for collecting Kubernetes objects as logs. Although
228
232
any object can be collected, a common and important use case is to collect
229
233
Kubernetes events.
0 commit comments