Merge pull request #96250 from openshift-cherrypick-robot/cherry-pick-95689-to-enterprise-4.19

[enterprise-4.19] OBSDOCS-1365: Improve docs for sending telemetry signals to the OpenTelemetry collector

Author: skopacz1

_topic_maps/_topic_map.yml

@@ -3224,8 +3224,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

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]
 ====
@@ -61,14 +61,14 @@ For more information about procol buffers, see link:https://protobuf.dev/overvie
 
 //[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`
@@ -111,6 +111,8 @@ For more information about procol buffers, see link:https://protobuf.dev/overvie
 |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
@@ -364,7 +366,7 @@ instrumentation.opentelemetry.io/otel-go-auto-target-exe: "/<path>/<to>/<contain
 ----
 <1> Sets the value for the required `OTEL_GO_AUTO_TARGET_EXE` environment variable.
 
-.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
@@ -501,7 +503,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]

observability/otel/otel-sending-traces-and-metrics-to-otel-collector.adoc renamed to 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.