Skip to content

Commit 75c2e1c

Browse files
committed
OBSDOCS-1365: Improve docs for sending telemetry signals to the OpenTelemetry collector
1 parent 895882e commit 75c2e1c

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
@@ -3223,8 +3223,8 @@ Topics:
32233223
File: otel-collector-target-allocator
32243224
- Name: Configuring the instrumentation
32253225
File: otel-configuration-of-instrumentation
3226-
- Name: Sending traces and metrics to the Collector
3227-
File: otel-sending-traces-and-metrics-to-otel-collector
3226+
- Name: Sending traces, logs, and metrics to the Collector
3227+
File: otel-sending-traces-logs-and-metrics-to-otel-collector
32283228
- Name: Configuring metrics for the monitoring stack
32293229
File: otel-configuring-metrics-for-monitoring-stack
32303230
- 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, it supports injecting instrumentation libraries for Go, Java, Node.js, Python, .NET, and the Apache HTTP Server (`httpd`).
1010

1111
[IMPORTANT]
1212
====
@@ -44,14 +44,14 @@ spec:
4444

4545
//[cols=",,",options="header",]
4646

47-
.Parameters used by the Operator to define the Instrumentation
47+
.Parameters used by the Operator to define the instrumentation
4848
[options="header"]
4949
[cols="a, a, a"]
5050
|===
5151
|Parameter |Description |Values
5252

5353
|`env`
54-
|Common environment variables to define across all the instrumentations.
54+
|Definition of common environment variables for all instrumentation types.
5555
|
5656

5757
|`exporter`
@@ -94,6 +94,8 @@ spec:
9494
|Configuration for the Python instrumentation.
9595
|
9696

97+
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).
98+
9799
|===
98100

99101
.Default protocol for auto-instrumentation
@@ -345,7 +347,7 @@ By default, this feature injects unsupported, upstream instrumentation libraries
345347
instrumentation.opentelemetry.io/inject-go: "true"
346348
----
347349

348-
.Additional permissions required for the Go auto-instrumentation in the OpenShift cluster
350+
.Permissions required for the Go auto-instrumentation in the OpenShift cluster
349351
[source,yaml]
350352
----
351353
apiVersion: security.openshift.io/v1
@@ -485,7 +487,7 @@ instrumentation.opentelemetry.io/inject-python: "true"
485487
[id="otel-multi-container-pods_{context}"]
486488
== Multi-container pods
487489

488-
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.
490+
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.
489491

490492
.Pod annotation
491493
[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)