wy471x opened a new pull request, #1157:
URL: https://github.com/apache/shenyu-website/pull/1157

   ## 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
   
   - every statement of the page was cross-checked against the implementation 
on the `master` of apache/shenyu, which was merged in apache/shenyu#7619, 
#7655, #7682, #7705 and is proposed in apache/shenyu#7784: the defaults, the 
sampler semantics, the attribute keys, the status rules, the endpoint handling 
and the list of unsupported features were compared with `ShenyuConfig`, 
`TracingPluginConfiguration`, `SpanAttributesBuilder`, `TraceContextExtractor` 
and `W3cTraceContextPropagator`
   - the front matter, the heading structure, the internal anchors and the code 
blocks were checked, and the sidebar and the navigation are generated from the 
directory, so no other file needs a change
   
   ## 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
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to