diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 6b3a8cd46c5c..fa8d49db8ae8 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -3223,8 +3223,8 @@ Topics: File: otel-collector-target-allocator - Name: Configuring the instrumentation File: otel-configuration-of-instrumentation - - Name: Sending traces and metrics to the Collector - File: otel-sending-traces-and-metrics-to-otel-collector + - Name: Sending traces, logs, and metrics to the Collector + File: otel-sending-traces-logs-and-metrics-to-otel-collector - Name: Configuring metrics for the monitoring stack File: otel-configuring-metrics-for-monitoring-stack - Name: Forwarding telemetry data diff --git a/modules/otel-config-instrumentation.adoc b/modules/otel-config-instrumentation.adoc index 447f2f868c04..c490f10ed330 100644 --- a/modules/otel-config-instrumentation.adoc +++ b/modules/otel-config-instrumentation.adoc @@ -6,7 +6,7 @@ [id="otel-instrumentation-config_{context}"] = OpenTelemetry instrumentation configuration options -The {OTELName} can inject and configure the OpenTelemetry auto-instrumentation libraries into your workloads. Currently, the project supports injection of the instrumentation libraries from Go, Java, Node.js, Python, .NET, and the Apache HTTP Server (`httpd`). +The {OTELName} injects and configures the OpenTelemetry auto-instrumentation libraries into your workloads. Currently, the {OTELName} supports injecting instrumentation libraries for Go, Java, Node.js, Python, .NET, and the Apache HTTP Server (`httpd`). [IMPORTANT] ==== @@ -44,14 +44,14 @@ spec: //[cols=",,",options="header",] -.Parameters used by the Operator to define the Instrumentation +.Parameters used by the Operator to define the instrumentation [options="header"] [cols="a, a, a"] |=== |Parameter |Description |Values |`env` -|Common environment variables to define across all the instrumentations. +|Definition of common environment variables for all instrumentation types. | |`exporter` @@ -94,6 +94,8 @@ spec: |Configuration for the Python instrumentation. | +Depending on the programming language, environment variables might not work for configuring telemetry. For the SDKs that do not support environment variable configuration, you must add a similar configuration directly in the code. For more information, see link:https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/[Environment Variable Specification] (OpenTelemetry Documentation). + |=== .Default protocol for auto-instrumentation @@ -345,7 +347,7 @@ By default, this feature injects unsupported, upstream instrumentation libraries instrumentation.opentelemetry.io/inject-go: "true" ---- -.Additional permissions required for the Go auto-instrumentation in the OpenShift cluster +.Permissions required for the Go auto-instrumentation in the OpenShift cluster [source,yaml] ---- apiVersion: security.openshift.io/v1 @@ -485,7 +487,7 @@ instrumentation.opentelemetry.io/inject-python: "true" [id="otel-multi-container-pods_{context}"] == Multi-container pods -The instrumentation is run on the first container that is available by default according to the pod specification. In some cases, you can also specify target containers for injection. +The instrumentation is injected to the first container that is available by default according to the pod specification. You can also specify the target container names for injection. .Pod annotation [source,yaml] diff --git a/observability/otel/otel-sending-traces-and-metrics-to-otel-collector.adoc b/observability/otel/otel-sending-traces-logs-and-metrics-to-otel-collector.adoc similarity index 54% rename from observability/otel/otel-sending-traces-and-metrics-to-otel-collector.adoc rename to observability/otel/otel-sending-traces-logs-and-metrics-to-otel-collector.adoc index 0c5f738d80e0..afc7f5ee1a22 100644 --- a/observability/otel/otel-sending-traces-and-metrics-to-otel-collector.adoc +++ b/observability/otel/otel-sending-traces-logs-and-metrics-to-otel-collector.adoc @@ -1,12 +1,12 @@ :_mod-docs-content-type: ASSEMBLY include::_attributes/common-attributes.adoc[] -[id="otel-sending-traces-and-metrics-to-otel-collector"] -= Sending traces and metrics to the OpenTelemetry Collector -:context: otel-sending-traces-and-metrics-to-otel-collector +[id="otel-sending-traces-logs-and-metrics-to-otel-collector"] += Sending traces, logs, and metrics to the OpenTelemetry Collector +:context: otel-sending-traces-logs-and-metrics-to-otel-collector toc::[] -You can set up and use the {OTELShortName} to send traces to the OpenTelemetry Collector or the TempoStack instance. +You can set up and use the {OTELShortName} to send traces, logs, and metrics to the OpenTelemetry Collector or the `TempoStack` instance. Sending traces and metrics to the OpenTelemetry Collector is possible with or without sidecar injection.