Repository navigation
docs: document the tracing plugin - #1157
Merged
Merged
Conversation
Add the reference of the tracing plugin in English and Chinese: the shenyu.tracing.* configuration and its defaults, the behaviour of the four samplers, the W3C context propagation on the inbound and the outbound side, the name, the attributes and the status of the gateway span, the correlation with the logs, the export to an OTLP backend, the notes about performance, security and the coexistence with a Java agent, and what is not supported yet.
dengliming
approved these changes
Oct 24, 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
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
Adds the reference page of the tracing plugin to the plugin center, in English and Chinese, so that the plugin which apache/shenyu ships can be configured from the website documentation.
What the page covers
shenyu.tracing.*configuration and its defaults, and the endpoint which the spans are exported toparent_based,always_on,always_off,ratio), including which of them override the decision of the clienttraceparentshenyu-agent-trace-idFiles
docs/plugin-center/observability/tracing-plugin.md(new, 403 lines)i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/observability/tracing-plugin.md(new, 322 lines)Verification
masterof apache/shenyu, which was merged in feat: add inbound distributed tracing span for gateway requests (#7615) shenyu#7619, #7655, #7682, #7705 and is proposed in test: cover the tracing of the gateway with an integrated test (#7617) shenyu#7784: the defaults, the sampler semantics, the attribute keys, the status rules, the endpoint handling and the list of unsupported features were compared withShenyuConfig,TracingPluginConfiguration,SpanAttributesBuilder,TraceContextExtractorandW3cTraceContextPropagatorNot covered
npm run buildof the site, because the generatedbuild/and.docusaurus/directories cannot be created in this environment; the pages follow the structure of the existingmetrics-plugin.mdandlogging-plugin.mdpages