Skip to content

Commit d650488

Browse files
committed
OBSDOCS-1157: Fix instrumentation annotations in OTel docs
1 parent 5bb0ced commit d650488

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

modules/otel-config-instrumentation.adoc

Lines changed: 8 additions & 8 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}"]
@@ -284,7 +284,7 @@ include::snippets/technology-preview.adoc[leveloffset=+1]
284284

285285
|`version`
286286
|Apache HTTP Server version.
287-
|2.4
287+
|`2.4`
288288

289289
|===
290290

@@ -360,7 +360,9 @@ By default, this feature injects unsupported, upstream instrumentation libraries
360360
[source,yaml]
361361
----
362362
instrumentation.opentelemetry.io/inject-go: "true"
363+
instrumentation.opentelemetry.io/otel-go-auto-target-exe: "/<path>/<to>/<container>/<executable>" # <1>
363364
----
365+
<1> Sets the value for the required `OTEL_GO_AUTO_TARGET_EXE` environment variable.
364366

365367
.Additional permissions required for the Go auto-instrumentation in the OpenShift cluster
366368
[source,yaml]
@@ -459,11 +461,8 @@ By default, this feature injects unsupported, upstream instrumentation libraries
459461
[source,yaml]
460462
----
461463
instrumentation.opentelemetry.io/inject-nodejs: "true"
462-
instrumentation.opentelemetry.io/otel-go-auto-target-exe: "/path/to/container/executable"
463464
----
464465

465-
The `+instrumentation.opentelemetry.io/otel-go-auto-target-exe+` annotation sets the value for the required `OTEL_GO_AUTO_TARGET_EXE` environment variable.
466-
467466
[id="otel-configuration-of-python-auto-instrumentation_{context}"]
468467
== Configuration of the Python auto-instrumentation
469468

@@ -507,8 +506,9 @@ The instrumentation is run on the first container that is available by default a
507506
.Pod annotation
508507
[source,yaml]
509508
----
510-
instrumentation.opentelemetry.io/container-names: "<container_1>,<container_2>"
509+
instrumentation.opentelemetry.io/container-names: "<container_1>,<container_2>" # <1>
511510
----
511+
<1> Use this annotation when you want to inject a single instrumentation in multiple containers.
512512

513513
[NOTE]
514514
====
@@ -533,7 +533,7 @@ instrumentation.opentelemetry.io/<application_language>-container-names: "<conta
533533
|Language |Value for `<application_language>`
534534

535535
|ApacheHTTPD
536-
|`apache`
536+
|`apache-httpd`
537537

538538
|DotNet
539539
|`dotnet`
@@ -558,4 +558,4 @@ instrumentation.opentelemetry.io/<application_language>-container-names: "<conta
558558
[id="otel-using-instrumentation-cr-with-service-mesh_{context}"]
559559
== Using the instrumentation CR with Service Mesh
560560

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

0 commit comments

Comments
 (0)