add pomerium_otel tracer extension #1
Merged
Conversation
This file contains 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
kralicky
force-pushed
the
tracer-extension
branch
from
ad21acb to
7bd943c
Compare
kralicky
force-pushed
the
tracer-extension
branch
from
a122641 to
2765bc8
Compare
4 tasks
kenjenkins
reviewed
Jan 9, 2025
| // the query parameters are standard and managed by oauth2 clients | ||
| const auto state = params.getFirstValue(Envoy::Http::LowerCaseString("state")); | ||
| if (state.has_value()) { | ||
| const std::string stateDecoded = |
There was a problem hiding this comment.
Is the format of the state value documented somewhere? It might be helpful to add a comment here describing the format and/or showing an example value.
There was a problem hiding this comment.
Only in the authenticate service here. I can definitely add some comments here and an example.
| name_substitutions); | ||
|
|
||
| if (auto tp = pomeriumTraceParentHeader().get(trace_context); | ||
| tp.has_value() && tp->size() == 55) { |
There was a problem hiding this comment.
I'd suggest adding a comment here about where the numbers 55, 3, 32 come from.
kenjenkins
approved these changes
Jan 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This adds a new tracer extension called pomerium_otel, which extends the default opentelemetry tracer and adds a couple of additional pomerium-specific features:
1. Trace ID overriding via header
When starting a span:
x-pomerium-traceparentorx-pomerium-traceidheader (set in the early header mutation extension), the randomly generated trace ID will be replaced with the trace ID contained in the header value.x-pomerium-sampling-decisionheader, the sampling decision will be forced on or off, depending on the value of the header ("1" or "0" respectively).2. Route decorator variables
If configured, Envoy will use a route's decorator as the span operation name for spans created from HTTP requests for that route. This extends the otel Span to override its setOperation with logic to substitute the strings
${path},${method},${host}, or${protocol}with the actual values for that request.