Skip to content

Commit 5273b53

Browse files
authored
[i18n] Update files under /docs/platforms/kubernetes to use absolute path (#7525)
Signed-off-by: Vitor Vasconcellos <vitor.vasconcellos@mercadolivre.com>
1 parent f08bf10 commit 5273b53

File tree

4 files changed

+59
-47
lines changed

4 files changed

+59
-47
lines changed

content/en/docs/platforms/kubernetes/collector/components.md

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,9 @@ interesting metadata. By default, data passing through the processor is
5656
associated to a pod via the incoming request's IP address, but different rules
5757
can be configured. Since the processor uses the Kubernetes API, it requires
5858
special permissions (see example below). If you're using the
59-
[OpenTelemetry Collector Helm chart](../../helm/collector/) you can use the
60-
[`kubernetesAttributes` preset](../../helm/collector/#kubernetes-attributes-preset)
59+
[OpenTelemetry Collector Helm chart](/docs/platforms/kubernetes/helm/collector/)
60+
you can use the
61+
[`kubernetesAttributes` preset](/docs/platforms/kubernetes/helm/collector/#kubernetes-attributes-preset)
6162
to get started.
6263

6364
The following attributes are added by default:
@@ -194,9 +195,10 @@ the node and the workloads running on the node.
194195
There are different methods for authentication, but typically a service account
195196
is used. The service account will also need proper permissions to pull data from
196197
the Kubelet (see below). If you're using the
197-
[OpenTelemetry Collector Helm chart](../../helm/collector/) you can use the
198-
[`kubeletMetrics` preset](../../helm/collector/#kubelet-metrics-preset) to get
199-
started.
198+
[OpenTelemetry Collector Helm chart](/docs/platforms/kubernetes/helm/collector/)
199+
you can use the
200+
[`kubeletMetrics` preset](/docs/platforms/kubernetes/helm/collector/#kubelet-metrics-preset)
201+
to get started.
200202

201203
By default, metrics will be collected for pods and nodes, but you can configure
202204
the receiver to collect container and volume metrics as well. The receiver also
@@ -269,8 +271,10 @@ any logs from Kubernetes.
269271
The Filelog Receiver is composed of Operators that are chained together to
270272
process a log. Each Operator performs a simple responsibility, such as parsing a
271273
timestamp or JSON. Configuring a Filelog Receiver is not trivial. If you're
272-
using the [OpenTelemetry Collector Helm chart](../../helm/collector/) you can
273-
use the [`logsCollection` preset](../../helm/collector/#logs-collection-preset)
274+
using the
275+
[OpenTelemetry Collector Helm chart](/docs/platforms/kubernetes/helm/collector/)
276+
you can use the
277+
[`logsCollection` preset](/docs/platforms/kubernetes/helm/collector/#logs-collection-preset)
274278
to get started.
275279

276280
Since Kubernetes logs normally fit a set of standard formats, a typical Filelog
@@ -354,9 +358,10 @@ the data.
354358
There are different methods for authentication, but typically a service account
355359
is used. The service account also needs proper permissions to pull data from the
356360
Kubernetes API server (see below). If you're using the
357-
[OpenTelemetry Collector Helm chart](../../helm/collector/) you can use the
358-
[`clusterMetrics` preset](../../helm/collector/#cluster-metrics-preset) to get
359-
started.
361+
[OpenTelemetry Collector Helm chart](/docs/platforms/kubernetes/helm/collector/)
362+
you can use the
363+
[`clusterMetrics` preset](/docs/platforms/kubernetes/helm/collector/#cluster-metrics-preset)
364+
to get started.
360365

361366
For node conditions, the receiver only collects `Ready` by default, but it can
362367
be configured to collect more. The receiver can also be configured to report a
@@ -483,10 +488,10 @@ all the data.
483488
Currently only a service account can be used for authentication. The service
484489
account also needs proper permissions to pull data from the Kubernetes API
485490
server (see below). If you're using the
486-
[OpenTelemetry Collector Helm chart](../../helm/collector/) and you want to
487-
ingest events, you can use the
488-
[`kubernetesEvents` preset](../../helm/collector/#cluster-metrics-preset) to get
489-
started.
491+
[OpenTelemetry Collector Helm chart](/docs/platforms/kubernetes/helm/collector/)
492+
and you want to ingest events, you can use the
493+
[`kubernetesEvents` preset](/docs/platforms/kubernetes/helm/collector/#cluster-metrics-preset)
494+
to get started.
490495

491496
For objects configuring for pulling, the receiver will use the Kubernetes API to
492497
periodically list all the objects in the Cluster. Each object will be converted
@@ -643,8 +648,9 @@ which means there are important details to consider when using it:
643648

644649
To make configuring the Prometheus receiver easier, the OpenTelemetry Operator
645650
includes an optional component called the
646-
[Target Allocator](../../operator/target-allocator). This component can be used
647-
to tell a collector which Prometheus endpoints it should scrape.
651+
[Target Allocator](/docs/platforms/kubernetes/operator/target-allocator). This
652+
component can be used to tell a collector which Prometheus endpoints it should
653+
scrape.
648654

649655
For more information on the design of the receiver, see
650656
[Design](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/prometheusreceiver/DESIGN.md).
@@ -664,9 +670,10 @@ may be worth it to disable these duplicate metrics.
664670

665671
In Kubernetes, the receiver needs access to the `hostfs` volume to work
666672
properly. If you're using the
667-
[OpenTelemetry Collector Helm chart](../../helm/collector/) you can use the
668-
[`hostMetrics` preset](../../helm/collector/#host-metrics-preset) to get
669-
started.
673+
[OpenTelemetry Collector Helm chart](/docs/platforms/kubernetes/helm/collector/)
674+
you can use the
675+
[`hostMetrics` preset](/docs/platforms/kubernetes/helm/collector/#host-metrics-preset)
676+
to get started.
670677

671678
The available scrapers are:
672679

content/en/docs/platforms/kubernetes/getting-started.md

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ see how all the monitoring responds to an active workload.
2020
If you're looking to start migrating from Prometheus to OpenTelemetry, or if
2121
you're interested in using the OpenTelemetry Collector to collect Prometheus
2222
metrics, see
23-
[Prometheus Receiver](../collector/components/#prometheus-receiver).
23+
[Prometheus Receiver](/docs/platforms/kubernetes/collector/components/#prometheus-receiver).
2424

2525
## Overview
2626

@@ -41,12 +41,13 @@ metrics for nodes, pods, and containers. The deployment installation of the
4141
collector will be used to collect metrics for the cluster and events.
4242

4343
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.
5051

5152
## Preparation
5253

@@ -81,12 +82,12 @@ This instance of the collector will use the following components:
8182

8283
- [OTLP Receiver](https://github.com/open-telemetry/opentelemetry-collector/tree/main/receiver/otlpreceiver):
8384
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):
8586
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.
9091

9192
Let's break these down.
9293

@@ -108,7 +109,7 @@ Kubernetes metadata using the `k8sattributes` processor.
108109
### Kubernetes Attributes Processor
109110

110111
The
111-
[Kubernetes Attributes Processor](../collector/components/#kubernetes-attributes-processor)
112+
[Kubernetes Attributes Processor](/docs/platforms/kubernetes/collector/components/#kubernetes-attributes-processor)
112113
is a highly recommended component in any collector receive telemetry from
113114
Kubernetes pods. This processor automatically discovers Kubernetes pods,
114115
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.
119120

120121
### Kubeletstats Receiver
121122

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
124126
container memory usage, pod cpu usage, and node network errors. All of the
125127
telemetry includes Kubernetes metadata like pod name or node name. Since we're
126128
using the Kubernetes Attributes Processor, we'll be able to correlate our
@@ -129,10 +131,12 @@ Kubeletstats Receiver.
129131

130132
### Filelog Receiver
131133

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.
136140

137141
Someday you may need to configure a Filelog Receiver on your own, but for this
138142
walkthrough the OpenTelemetry Helm Chart will handle all the complex
@@ -205,25 +209,25 @@ data.
205209

206210
This instance of the Collector will use the following components:
207211

208-
- [Kubernetes Cluster Receiver](../collector/components/#kubernetes-cluster-receiver):
212+
- [Kubernetes Cluster Receiver](/docs/platforms/kubernetes/collector/components/#kubernetes-cluster-receiver):
209213
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):
211215
to collect objects, such as events, from the Kubernetes API server.
212216

213217
Let's break these down.
214218

215219
### Kubernetes Cluster Receiver
216220

217221
The
218-
[Kubernetes Cluster Receiver](../collector/components/#kubernetes-cluster-receiver)
222+
[Kubernetes Cluster Receiver](/docs/platforms/kubernetes/collector/components/#kubernetes-cluster-receiver)
219223
is the Collector's solution for collecting metrics about the state of the
220224
cluster as a whole. This receiver can gather metrics about node conditions, pod
221225
phases, container restarts, available and desired deployments, and more.
222226

223227
### Kubernetes Objects Receiver
224228

225229
The
226-
[Kubernetes Objects Receiver](../collector/components/#kubernetes-objects-receiver)
230+
[Kubernetes Objects Receiver](/docs/platforms/kubernetes/collector/components/#kubernetes-objects-receiver)
227231
is the Collector's solution for collecting Kubernetes objects as logs. Although
228232
any object can be collected, a common and important use case is to collect
229233
Kubernetes events.

content/en/docs/platforms/kubernetes/operator/_index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,8 @@ EOF
8080

8181
By default, `opentelemetry-operator` uses the
8282
[`opentelemetry-collector` image](https://github.com/open-telemetry/opentelemetry-collector-releases/pkgs/container/opentelemetry-collector-releases%2Fopentelemetry-collector).
83-
When the operator is installed using [Helm charts](../helm/), the
83+
When the operator is installed using
84+
[Helm charts](/docs/platforms/kubernetes/helm/), the
8485
[`opentelemetry-collector-k8s` image](https://github.com/open-telemetry/opentelemetry-collector-releases/pkgs/container/opentelemetry-collector-releases%2Fopentelemetry-collector-k8s)
8586
is used. If you need a component not found in these releases, you may need to
8687
[build your own collector](/docs/collector/custom-collector/).

content/en/docs/platforms/kubernetes/operator/automatic.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ chart, there is an option to generate a self-signed cert instead.
3535
## Create an OpenTelemetry Collector (Optional)
3636

3737
It is a best practice to send telemetry from containers to an
38-
[OpenTelemetry Collector](../../collector/) instead of directly to a backend.
39-
The Collector helps simplify secret management, decouples data export problems
40-
(such as a need to do retries) from your apps, and lets you add additional data
41-
to your telemetry, such as with the
38+
[OpenTelemetry Collector](/docs/platforms/kubernetes/collector/) instead of
39+
directly to a backend. The Collector helps simplify secret management, decouples
40+
data export problems (such as a need to do retries) from your apps, and lets you
41+
add additional data to your telemetry, such as with the
4242
[k8sattributesprocessor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/k8sattributesprocessor)
4343
component. If you chose not to use a Collector, you can skip to the next
4444
section.

0 commit comments

Comments
 (0)