docs: document otel request/k8s tracing and log correlation - #499
Open
psanghvi17 wants to merge 3 commits into
Open
psanghvi17 wants to merge 3 commits into
psanghvi17 wants to merge 3 commits into
Conversation
Epinio server now supports OTLP trace export via the otelgin middleware, configurable through --otel-exporter-otlp-endpoint and --otel-exporter-otlp-protocol (or their OTEL_EXPORTER_OTLP_* env var equivalents).
The otel-exporter-otlp-protocol flag description was stale relative to the current server code. Also add a how-to page covering what gets traced, how to enable it, and the websocket exclusion.
✅ Deploy Preview for epinio-docs-staging ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This was referenced Sep 18, 2026
Extend the request-tracing how-to with the two follow-on pieces of the OpenTelemetry work: client spans for outbound Kubernetes API calls (EPINIO-689, parented under the triggering request span, baggage intentionally not propagated), and trace/span correlation fields on exported logs (EPINIO-690), plus the signal-specific endpoint env vars that enable traces and logs independently of each other.
psanghvi17
force-pushed
the
EPINIO-688-689-690-otel-docs
branch
from
September 18, 2026 04:43
ee6d0b7 to
a7e7f1b
Compare
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
1 participant
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
Documents the OpenTelemetry observability work across three Epinio PRs:
otelginotelhttpotelzapChanges
docs/reference/cli/epinio_server.mdwith the--otel-exporter-otlp-endpoint/--otel-exporter-otlp-protocolflags (generated from the CLI's own flag help text).docs/how-to/operator/operations/enable_request_tracing.mdinto a single how-to covering all three signals: enabling tracing, what gets traced (API requests + Kubernetes API calls), log/trace correlation, enabling traces or logs independently via their signal-specificOTEL_EXPORTER_OTLP_*_ENDPOINTenv vars, and collector-unavailable behavior.This addresses the outstanding review comment on epinio/epinio#3131 asking for documentation before merge.