Skip to content

Commit 7959f76

Browse files
authored
Merge pull request #96246 from openshift-cherrypick-robot/cherry-pick-95689-to-enterprise-4.16
[enterprise-4.16] OBSDOCS-1365: Improve docs for sending telemetry signals to the OpenTelemetry collector
2 parents 920fdfb + d643cbc commit 7959f76

File tree

3 files changed

+13
-11
lines changed

3 files changed

+13
-11
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3086,8 +3086,8 @@ Topics:
30863086
File: otel-collector-target-allocator
30873087
- Name: Configuring the instrumentation
30883088
File: otel-configuration-of-instrumentation
3089-
- Name: Sending traces and metrics to the Collector
3090-
File: otel-sending-traces-and-metrics-to-otel-collector
3089+
- Name: Sending traces, logs, and metrics to the Collector
3090+
File: otel-sending-traces-logs-and-metrics-to-otel-collector
30913091
- Name: Configuring metrics for the monitoring stack
30923092
File: otel-configuring-metrics-for-monitoring-stack
30933093
- Name: Forwarding telemetry data

modules/otel-config-instrumentation.adoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="otel-instrumentation-config_{context}"]
77
= OpenTelemetry instrumentation configuration options
88

9-
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`).
9+
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`).
1010

1111
[IMPORTANT]
1212
====
@@ -61,14 +61,14 @@ For more information about procol buffers, see link:https://protobuf.dev/overvie
6161

6262
//[cols=",,",options="header",]
6363

64-
.Parameters used by the Operator to define the Instrumentation
64+
.Parameters used by the Operator to define the instrumentation
6565
[options="header"]
6666
[cols="a, a, a"]
6767
|===
6868
|Parameter |Description |Values
6969

7070
|`env`
71-
|Common environment variables to define across all the instrumentations.
71+
|Definition of common environment variables for all instrumentation types.
7272
|
7373

7474
|`exporter`
@@ -111,6 +111,8 @@ For more information about procol buffers, see link:https://protobuf.dev/overvie
111111
|Configuration for the Python instrumentation.
112112
|
113113

114+
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).
115+
114116
|===
115117

116118
.Default protocol for auto-instrumentation
@@ -364,7 +366,7 @@ instrumentation.opentelemetry.io/otel-go-auto-target-exe: "/<path>/<to>/<contain
364366
----
365367
<1> Sets the value for the required `OTEL_GO_AUTO_TARGET_EXE` environment variable.
366368

367-
.Additional permissions required for the Go auto-instrumentation in the OpenShift cluster
369+
.Permissions required for the Go auto-instrumentation in the OpenShift cluster
368370
[source,yaml]
369371
----
370372
apiVersion: security.openshift.io/v1
@@ -501,7 +503,7 @@ instrumentation.opentelemetry.io/inject-python: "true"
501503
[id="otel-multi-container-pods_{context}"]
502504
== Multi-container pods
503505

504-
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.
506+
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.
505507

506508
.Pod annotation
507509
[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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
:_mod-docs-content-type: ASSEMBLY
22
include::_attributes/common-attributes.adoc[]
3-
[id="otel-sending-traces-and-metrics-to-otel-collector"]
4-
= Sending traces and metrics to the OpenTelemetry Collector
5-
:context: otel-sending-traces-and-metrics-to-otel-collector
3+
[id="otel-sending-traces-logs-and-metrics-to-otel-collector"]
4+
= Sending traces, logs, and metrics to the OpenTelemetry Collector
5+
:context: otel-sending-traces-logs-and-metrics-to-otel-collector
66

77
toc::[]
88

9-
You can set up and use the {OTELShortName} to send traces to the OpenTelemetry Collector or the TempoStack instance.
9+
You can set up and use the {OTELShortName} to send traces, logs, and metrics to the OpenTelemetry Collector or the `TempoStack` instance.
1010

1111
Sending traces and metrics to the OpenTelemetry Collector is possible with or without sidecar injection.
1212

0 commit comments

Comments
 (0)