Skip to content

OBSDOCS-1365: Improve docs for sending telemetry signals to the OpenTelemetry collector #95689

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
Open

OBSDOCS-1365: Improve docs for sending telemetry signals to the OpenTelemetry collector #95689

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
4 changes: 2 additions & 2 deletions _topic_maps/_topic_map.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3223,8 +3223,8 @@ Topics:
File: otel-collector-target-allocator
- Name: Configuring the instrumentation
File: otel-configuration-of-instrumentation
- Name: Sending traces and metrics to the Collector
File: otel-sending-traces-and-metrics-to-otel-collector
- Name: Sending traces, logs, and metrics to the Collector
File: otel-sending-traces-logs-and-metrics-to-otel-collector
- Name: Configuring metrics for the monitoring stack
File: otel-configuring-metrics-for-monitoring-stack
- Name: Forwarding telemetry data
Expand Down
12 changes: 7 additions & 5 deletions modules/otel-config-instrumentation.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[id="otel-instrumentation-config_{context}"]
= OpenTelemetry instrumentation configuration options

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`).
The {OTELName} injects and configures the OpenTelemetry auto-instrumentation libraries into your workloads. Currently, it supports injecting instrumentation libraries for Go, Java, Node.js, Python, .NET, and the Apache HTTP Server (`httpd`).

[IMPORTANT]
====
Expand Down Expand Up @@ -44,14 +44,14 @@ spec:

//[cols=",,",options="header",]

.Parameters used by the Operator to define the Instrumentation
.Parameters used by the Operator to define the instrumentation
[options="header"]
[cols="a, a, a"]
|===
|Parameter |Description |Values

|`env`
|Common environment variables to define across all the instrumentations.
|Definition of common environment variables for all instrumentation types.
|

|`exporter`
Expand Down Expand Up @@ -94,6 +94,8 @@ spec:
|Configuration for the Python instrumentation.
|

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).

|===

.Default protocol for auto-instrumentation
Expand Down Expand Up @@ -345,7 +347,7 @@ By default, this feature injects unsupported, upstream instrumentation libraries
instrumentation.opentelemetry.io/inject-go: "true"
----

.Additional permissions required for the Go auto-instrumentation in the OpenShift cluster
.Permissions required for the Go auto-instrumentation in the OpenShift cluster
[source,yaml]
----
apiVersion: security.openshift.io/v1
Expand Down Expand Up @@ -485,7 +487,7 @@ instrumentation.opentelemetry.io/inject-python: "true"
[id="otel-multi-container-pods_{context}"]
== Multi-container pods

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.
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.

.Pod annotation
[source,yaml]
Expand Down
8 changes: 4 additions & 4 deletions ...traces-and-metrics-to-otel-collector.adoc → ...s-logs-and-metrics-to-otel-collector.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
:_mod-docs-content-type: ASSEMBLY
include::_attributes/common-attributes.adoc[]
[id="otel-sending-traces-and-metrics-to-otel-collector"]
= Sending traces and metrics to the OpenTelemetry Collector
:context: otel-sending-traces-and-metrics-to-otel-collector
[id="otel-sending-traces-logs-and-metrics-to-otel-collector"]
= Sending traces, logs, and metrics to the OpenTelemetry Collector
:context: otel-sending-traces-logs-and-metrics-to-otel-collector

toc::[]

You can set up and use the {OTELShortName} to send traces to the OpenTelemetry Collector or the TempoStack instance.
You can set up and use the {OTELShortName} to send traces, logs, and metrics to the OpenTelemetry Collector or the `TempoStack` instance.

Sending traces and metrics to the OpenTelemetry Collector is possible with or without sidecar injection.

Expand Down