You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/kubernetes/operator/README.md
+11-4Lines changed: 11 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
This guide describes how to:
4
4
5
5
- Install the [OpenTelemetry Operator](https://github.com/open-telemetry/opentelemetry-operator/) using the [kube-stack Helm chart](https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-kube-stack).
6
-
- Use the EDOT Collector to send Kubernetes logs, metrics, and application traces to an Elasticsearch cluster.
6
+
- Use the EDOT Collectors to send Kubernetes logs, metrics, and application traces to an Elasticsearch cluster.
7
7
- Use the operator for applications [auto-instrumentation](https://opentelemetry.io/docs/kubernetes/operator/automatic/) in all supported languages.
8
8
9
9
## Table of Contents
@@ -42,6 +42,11 @@ When [installing the release](#manual-deployment-of-all-components), ensure you
42
42
43
43
## Components description
44
44
45
+
Getting started with OpenTelemetry for Kubernetes observability requires an understanding of the following components, their functions, and interactions: OpenTelemetry Operator, Collectors, kube-stack Helm Chart, and auto-instrumentation resources.
46
+
47
+
<details>
48
+
<summary>Expand this section for a detailed description of these components.</summary>
49
+
45
50
### OpenTelemetry Operator
46
51
47
52
The OpenTelemetry Operator is a [Kubernetes Operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) implementation designed to manage OpenTelemetry resources in a Kubernetes environment. It defines and oversees the following Custom Resource Definitions (CRDs):
@@ -53,7 +58,7 @@ All signals including logs, metrics, and traces are processed by the collectors
53
58
54
59
### Kube-stack Helm Chart
55
60
56
-
The [kube-stack Helm chart](https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-kube-stack) is used to manage the installation of the operator (including its CRDs) and to configure a suite of collectors, which instrument various Kubernetes components to enable comprehensive observability and monitoring.
61
+
The [kube-stack Helm chart](https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-kube-stack) is used to manage the installation of the operator (including its CRDs), and to configure a suite of collectors, which instrument various Kubernetes components to enable comprehensive observability and monitoring.
57
62
58
63
The chart is installed with a provided default `values.yaml` file that can be customized when needed.
59
64
@@ -87,6 +92,8 @@ The Helm chart is configured to enable zero-code instrumentation using the [Oper
87
92
- Python
88
93
- .NET
89
94
95
+
</details>
96
+
90
97
## Deploy components using the guided onboarding
91
98
92
99
The guided onboarding simplifies deploying your Kubernetes components by setting up an [API Key](https://www.elastic.co/guide/en/kibana/current/api-keys.html) and the needed [Integrations](https://www.elastic.co/docs/current/en/integrations) in the background. Follow these steps to use the guided onboarding:
@@ -169,10 +176,10 @@ Regardless of the installation method followed, perform the following checks to
169
176
- Verify that the **[OTEL][Metrics Kubernetes] Cluster Overview** dashboard in **Kibana** is displaying data correctly.
170
177
171
178
4. **Log Data Availability in Kibana**
172
-
- In **Kibana Discovery**, confirm the availability of data under the `__logs-*__` data view.
179
+
- In **Kibana Discover**, confirm the availability of data under the `__logs-*__` data view.
173
180
174
181
5. **Metrics Data Availability in Kibana**
175
-
- In **Kibana Discovery**, ensure data is available under the `__metrics-*__` data view.
182
+
- In **Kibana Discover**, ensure data is available under the `__metrics-*__` data view.
0 commit comments