Skip to content

OBSDOCS-1157: Fix instrumentation annotations in OTel docs #96097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −8
Open

OBSDOCS-1157: Fix instrumentation annotations in OTel docs #96097

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions modules/otel-config-instrumentation.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * observability/otel/otel-instrumentation.adoc
// * observability/otel/otel-configuration-of-instrumentation.adoc

:_mod-docs-content-type: REFERENCE
[id="otel-instrumentation-config_{context}"]
Expand Down Expand Up @@ -284,7 +284,7 @@ include::snippets/technology-preview.adoc[leveloffset=+1]

|`version`
|Apache HTTP Server version.
|2.4
|`2.4`

|===

Expand Down Expand Up @@ -360,7 +360,9 @@ By default, this feature injects unsupported, upstream instrumentation libraries
[source,yaml]
----
instrumentation.opentelemetry.io/inject-go: "true"
instrumentation.opentelemetry.io/otel-go-auto-target-exe: "/<path>/<to>/<container>/<executable>" # <1>
----
<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
[source,yaml]
Expand Down Expand Up @@ -459,11 +461,8 @@ By default, this feature injects unsupported, upstream instrumentation libraries
[source,yaml]
----
instrumentation.opentelemetry.io/inject-nodejs: "true"
instrumentation.opentelemetry.io/otel-go-auto-target-exe: "/path/to/container/executable"
----

The `+instrumentation.opentelemetry.io/otel-go-auto-target-exe+` annotation sets the value for the required `OTEL_GO_AUTO_TARGET_EXE` environment variable.

[id="otel-configuration-of-python-auto-instrumentation_{context}"]
== Configuration of the Python auto-instrumentation

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

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

|ApacheHTTPD
|`apache`
|`apache-httpd`

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

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