docs: add OTLP exporter configuration examples#1262
Open
S-anskriti wants to merge 3 commits intojenkinsci:mainfrom
Open
docs: add OTLP exporter configuration examples#1262S-anskriti wants to merge 3 commits intojenkinsci:mainfrom
S-anskriti wants to merge 3 commits intojenkinsci:mainfrom
Conversation
Expand the OTLP exporter configuration section with practical examples covering: - gRPC (default) vs HTTP/Protobuf transport - Sending only specific signals (traces/metrics/logs) - Bearer token authentication via environment variables - Custom TLS certificate configuration - Logging exporter for troubleshooting - service.name and resource attributes via OTEL_RESOURCE_ATTRIBUTES Contributes to jenkinsci#1026
Expand the OTLP exporter configuration section with practical examples covering: - gRPC (default) vs HTTP/Protobuf transport - Sending only specific signals (traces/metrics/logs) - Bearer token authentication via environment variables - Custom TLS certificate configuration - Logging exporter for troubleshooting - service.name and resource attributes via OTEL_RESOURCE_ATTRIBUTES Contributes to jenkinsci#1026
Expand the environment variables section with practical examples covering: - gRPC (default) vs HTTP/Protobuf transport - Sending only specific signals (traces/metrics/logs) - Bearer token authentication via environment variables - Custom TLS certificate configuration - Logging exporter for troubleshooting - service.name and resource attributes via OTEL_RESOURCE_ATTRIBUTES Contributes to jenkinsci#1026
| otel.exporter.otlp.protocol=http/protobuf | ||
| ``` | ||
|
|
||
| ## OTLP exporter configuration options |
Contributor
There was a problem hiding this comment.
The Configuration with environment variables conflicts with the configuration made in the plugin. These environment variables can be used for a rare configuration not supported in the plugin. Adding this to the documentation can mislead users.
kuisathaverat
requested changes
Mar 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Expands the OTLP exporter configuration section in
docs/setup-and-configuration.mdwith practical, copy-paste-readyexamples that were previously missing.
Motivation
Issue #1026 highlights that the OTLP exporter configuration options
are unclear. Users know the plugin supports OTLP but have no concrete
examples showing how to configure gRPC vs HTTP, per-signal exporters,
authentication, or TLS — leading to repeated support questions.
Changes
Added a new "OTLP exporter configuration" subsection covering:
OTEL_EXPORTER_OTLP_HEADERSOTEL_EXPORTER_OTLP_CERTIFICATEservice.nameand resource attributes viaOTEL_RESOURCE_ATTRIBUTESwith a note on precedence rules
Testing
Documentation only — no functional changes.
Related issues
Contributes to #1026
Note: I am a GSoC 2026 applicant interested in the
Use OpenTelemetry for Jenkins Jobs on ci.jenkins.io
project.