Skip to content

docs: document the tracing plugin - #1157

Merged
dengliming merged 1 commit into
apache:mainfrom
wy471x:docs/tracing-plugin
Oct 24, 2026
Merged

dengliming merged 1 commit into
apache:mainfrom
wy471x:docs/tracing-plugin

Conversation

@wy471x

@wy471x wy471x commented Oct 19, 2026

Copy link
Copy Markdown
Contributor

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

  • the shenyu.tracing.* configuration and its defaults, and the endpoint which the spans are exported to
  • the behaviour of the four samplers (parent_based, always_on, always_off, ratio), including which of them override the decision of the client
  • the W3C context propagation on the inbound and the outbound side, including the rejection of a repeated traceparent
  • the name, the attributes and the status of the gateway span, and the values which are deliberately not recorded
  • the correlation with the access log through shenyu-agent-trace-id
  • the export to an OpenTelemetry Collector, Jaeger and Tempo
  • performance and security notes, the coexistence with a Java agent, and what is not supported yet

Files

  • 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

Not covered

  • a local npm run build of the site, because the generated build/ and .docusaurus/ directories cannot be created in this environment; the pages follow the structure of the existing metrics-plugin.md and logging-plugin.md pages

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
dengliming merged commit d53b33d into apache:main Oct 24, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants