Skip to content

OBSDOCS-1157: Fix bug #81817

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

Closed
wants to merge 1 commit into from
Closed

OBSDOCS-1157: Fix bug #81817

Show file tree
Hide file tree
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
19 changes: 10 additions & 9 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 All @@ -18,9 +18,9 @@ The {OTELName} Operator only supports the injection mechanism of the instrumenta
[id="otel-instrumentation-options_{context}"]
== Instrumentation options

Instrumentation options are specified in the `OpenTelemetryCollector` custom resource.
Instrumentation options are specified in the `Instrumentation` custom resource.

.Sample `OpenTelemetryCollector` custom resource file
.Sample `Instrumentation` custom resource file
[source,yaml]
----
apiVersion: opentelemetry.io/v1alpha1
Expand Down Expand Up @@ -101,7 +101,7 @@ spec:
[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.

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

|`configPath`
|Location of the Apache HTTP Server configuration.
|/usr/local/apache2/conf
|`/usr/local/apache2/conf`

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

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

|===

Expand Down Expand Up @@ -194,7 +194,9 @@ instrumentation.opentelemetry.io/inject-dotnet: "true"
[source,yaml]
----
instrumentation.opentelemetry.io/inject-go: "true"
instrumentation.opentelemetry.io/otel-go-auto-target-exe: "/path/to/container/executable" # <1>
----
<1> The `+instrumentation.opentelemetry.io/otel-go-auto-target-exe+` annotation 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 @@ -280,8 +282,6 @@ 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 @@ -337,8 +337,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> 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".

[NOTE]
====
Expand Down
4 changes: 2 additions & 2 deletions observability/otel/otel-configuration-of-instrumentation.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ include::_attributes/common-attributes.adoc[]

toc::[]

The {OTELName} Operator uses an `Instrumentation` custom resource (CR) for configuring the instrumentation.

:FeatureName: OpenTelemetry instrumentation injection
include::snippets/technology-preview.adoc[leveloffset=+1]

The {OTELName} Operator uses a custom resource definition (CRD) file that defines the configuration of the instrumentation.

include::modules/otel-config-instrumentation.adoc[leveloffset=+1]