Skip to content

Commit 27923fa

Browse files
committed
OBSDOCS-1157: Fix bug in file observability/otel/otel-configuration-of-instrumentation.adoc
1 parent 658df14 commit 27923fa

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

modules/otel-config-instrumentation.adoc

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * observability/otel/otel-instrumentation.adoc
3+
// * observability/otel/otel-configuration-of-instrumentation.adoc
44

55
:_mod-docs-content-type: REFERENCE
66
[id="otel-instrumentation-config_{context}"]
@@ -18,9 +18,9 @@ The {OTELName} Operator only supports the injection mechanism of the instrumenta
1818
[id="otel-instrumentation-options_{context}"]
1919
== Instrumentation options
2020

21-
Instrumentation options are specified in the `OpenTelemetryCollector` custom resource.
21+
Instrumentation options are specified in the `Instrumentation` custom resource.
2222

23-
.Sample `OpenTelemetryCollector` custom resource file
23+
.Sample `Instrumentation` custom resource file
2424
[source,yaml]
2525
----
2626
apiVersion: opentelemetry.io/v1alpha1
@@ -101,7 +101,7 @@ spec:
101101
[id="otel-using-instrumentation-cr-with-service-mesh_{context}"]
102102
== Using the instrumentation CR with Service Mesh
103103

104-
When using the instrumentation custom resource (CR) with {SMProductName}, you must use the `b3multi` propagator.
104+
When using the `Instrumentation` custom resource (CR) with {SMProductName}, you must use the `b3multi` propagator.
105105

106106
[id="otel-configuration-of-apache-http-server-auto-instrumentation_{context}"]
107107
=== Configuration of the Apache HTTP Server auto-instrumentation
@@ -118,7 +118,7 @@ When using the instrumentation custom resource (CR) with {SMProductName}, you mu
118118

119119
|`configPath`
120120
|Location of the Apache HTTP Server configuration.
121-
|/usr/local/apache2/conf
121+
|`/usr/local/apache2/conf`
122122

123123
|`env`
124124
|Environment variables specific to the Apache HTTP Server.
@@ -134,7 +134,7 @@ When using the instrumentation custom resource (CR) with {SMProductName}, you mu
134134

135135
|`version`
136136
|Apache HTTP Server version.
137-
|2.4
137+
|`2.4`
138138

139139
|===
140140

@@ -194,7 +194,9 @@ instrumentation.opentelemetry.io/inject-dotnet: "true"
194194
[source,yaml]
195195
----
196196
instrumentation.opentelemetry.io/inject-go: "true"
197+
instrumentation.opentelemetry.io/otel-go-auto-target-exe: "/path/to/container/executable" # <1>
197198
----
199+
<1> The `+instrumentation.opentelemetry.io/otel-go-auto-target-exe+` annotation sets the value for the required `OTEL_GO_AUTO_TARGET_EXE` environment variable.
198200

199201
.Additional permissions required for the Go auto-instrumentation in the OpenShift cluster
200202
[source,yaml]
@@ -280,8 +282,6 @@ instrumentation.opentelemetry.io/inject-nodejs: "true"
280282
instrumentation.opentelemetry.io/otel-go-auto-target-exe: "/path/to/container/executable"
281283
----
282284

283-
The `+instrumentation.opentelemetry.io/otel-go-auto-target-exe+` annotation sets the value for the required `OTEL_GO_AUTO_TARGET_EXE` environment variable.
284-
285285
[id="otel-configuration-of-python-auto-instrumentation_{context}"]
286286
=== Configuration of the Python auto-instrumentation
287287

@@ -337,8 +337,9 @@ The instrumentation is run on the first container that is available by default a
337337
.Pod annotation
338338
[source,yaml]
339339
----
340-
instrumentation.opentelemetry.io/container-names: "<container_1>,<container_2>"
340+
instrumentation.opentelemetry.io/container-names: "<container_1>,<container_2>" # <1>
341341
----
342+
<1> This annotation injects a single instrumentation in multiple containers. For instrumenting multiple containers with different instrumentations, see the section "Multi-container pods with multiple instrumentations".
342343

343344
[NOTE]
344345
====

observability/otel/otel-configuration-of-instrumentation.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9+
The {OTELName} Operator uses a custom resource definition (CRD) file that defines the configuration of the instrumentation.
10+
911
:FeatureName: OpenTelemetry instrumentation injection
1012
include::snippets/technology-preview.adoc[leveloffset=+1]
1113

12-
The {OTELName} Operator uses a custom resource definition (CRD) file that defines the configuration of the instrumentation.
13-
1414
include::modules/otel-config-instrumentation.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)