|
6 | 6 | [id="otel-instrumentation-config_{context}"] |
7 | 7 | = OpenTelemetry instrumentation configuration options |
8 | 8 |
|
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, the {OTELName} supports injecting instrumentation libraries for Go, Java, Node.js, Python, .NET, and the Apache HTTP Server (`httpd`). |
10 | 10 |
|
11 | 11 | [IMPORTANT] |
12 | 12 | ==== |
@@ -44,14 +44,14 @@ spec: |
44 | 44 |
|
45 | 45 | //[cols=",,",options="header",] |
46 | 46 |
|
47 | | -.Parameters used by the Operator to define the Instrumentation |
| 47 | +.Parameters used by the Operator to define the instrumentation |
48 | 48 | [options="header"] |
49 | 49 | [cols="a, a, a"] |
50 | 50 | |=== |
51 | 51 | |Parameter |Description |Values |
52 | 52 |
|
53 | 53 | |`env` |
54 | | -|Common environment variables to define across all the instrumentations. |
| 54 | +|Definition of common environment variables for all instrumentation types. |
55 | 55 | | |
56 | 56 |
|
57 | 57 | |`exporter` |
|
94 | 94 | |Configuration for the Python instrumentation. |
95 | 95 | | |
96 | 96 |
|
| 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 | + |
97 | 99 | |=== |
98 | 100 |
|
99 | 101 | .Default protocol for auto-instrumentation |
@@ -345,7 +347,7 @@ By default, this feature injects unsupported, upstream instrumentation libraries |
345 | 347 | instrumentation.opentelemetry.io/inject-go: "true" |
346 | 348 | ---- |
347 | 349 |
|
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 |
349 | 351 | [source,yaml] |
350 | 352 | ---- |
351 | 353 | apiVersion: security.openshift.io/v1 |
@@ -485,7 +487,7 @@ instrumentation.opentelemetry.io/inject-python: "true" |
485 | 487 | [id="otel-multi-container-pods_{context}"] |
486 | 488 | == Multi-container pods |
487 | 489 |
|
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. |
489 | 491 |
|
490 | 492 | .Pod annotation |
491 | 493 | [source,yaml] |
|
0 commit comments