feat(tracing): new headers propagation module for tracing plugins #12670
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
This was
linked to
issues
Feb 29, 2024
samugi
force-pushed
the
feat/tracing-headers-propagation-module-rework
branch
from
4ed3fd9 to
f2dd252
Compare
samugi
force-pushed
the
feat/tracing-headers-propagation-module-rework
branch
3 times, most recently
from
78378ce to
ca3b40a
Compare
samugi
commented
Mar 13, 2024
ADD-SP
requested changes
Mar 15, 2024
github-actions
bot
added
the
cherry-pick kong-ee
samugi
force-pushed
the
feat/tracing-headers-propagation-module-rework
branch
2 times, most recently
from
8e7c6ad to
c4aa1a3
Compare
ADD-SP
reviewed
Mar 20, 2024
thank you @ADD-SP, as those items are going to be separate from this PR I'm creating dedicated tasks - KAG-4104, KAG-4105 |
ADD-SP
approved these changes
Mar 21, 2024
StarlightIbuki
approved these changes
Mar 21, 2024
|
Verified with |
The new propagation module replaces the propagation.lua file, providing a more flexible and extensible way to handle tracing headers propagation from plugins (at the moment OpenTelemetry and Zipkin). It allows configuring the priority of tracing context extraction and what headers to extract and inject the tracing context from/to. It also allows clearing headers from the request after extraction to gain full control on what is propagated to the upstream. New configuration options: propagation.extract: Header formats used to extract tracing context from incoming requests. propagation.inject: Header formats used to inject tracing context. propagation.clear: Header names to clear after context extraction. Each header format is now defined in its own extractor and injector files so that individual logic for extracting and injecting the tracing context is isolated. This is meant to improve maintainability/testability and facilitate extending support to new header formats. apply PR suggestions (squash me) Co-authored-by: Qi <[email protected]>
samugi
force-pushed
the
feat/tracing-headers-propagation-module-rework
branch
from
79c8af5 to
b791241
Compare
samugi
removed
the
cherry-pick kong-ee
1 task
1 task
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.
Summary
The new propagation module replaces the
propagation.luafile, providing a more flexible and extensible way to handle tracing headers propagation from plugins (at the moment OpenTelemetry and Zipkin). It allows configuring the priority of tracing context extraction and what headers to extract and inject the tracing context from/to. It also allows clearing headers from the request after extraction to gain full control on what is propagated to the upstream.New configuration options:
propagation.extract: Header formats used to extract tracing context from incoming requests.
propagation.inject: Header formats used to inject tracing context.
propagation.clear: Header names to clear after context extraction.
Each header format is now defined in its own extractor and injector files so that individual logic for extracting and injecting the tracing context is isolated. This is meant to improve maintainability/testability and facilitate extending support to new header formats.
Checklist
changelog/unreleased/kongorskip-changeloglabel added on PR if changelog is unnecessary. README.mdIssue reference
KAG-1886 / KAG-1887