Skip to content

Clarify which signal each duplicated otel_* config option applies to - #71158

Open
br413 wants to merge 1 commit into
apache:mainfrom
br413:docs/clarify-otel-metrics-traces-config-43366
Open

Clarify which signal each duplicated otel_* config option applies to#71158
br413 wants to merge 1 commit into
apache:mainfrom
br413:docs/clarify-otel-metrics-traces-config-43366

Conversation

@br413

@br413 br413 commented Aug 5, 2026

Copy link
Copy Markdown

Summary

The \otel_on, \otel_host, \otel_port, \otel_service, \otel_debugging_on, and \otel_ssl_active\ options appear in both the [metrics]\ and [traces]\ sections of the Configuration Reference. Their descriptions did not clearly state which signal each copy configures.

Three [metrics]\ descriptions were also incorrect: \otel_host\ and \otel_interval_milliseconds\ claimed to cover traces, and \otel_service\ described only traces.

This PR keeps both option sets (per @ferruzzi's resolution in #43366) and:

  • Names the signal each description configures
  • Cross-references [metrics]\ vs [traces]\ on \otel_on\
  • Restores literal markup (\True\, \False\, \config.yml\) in [traces]\ descriptions

Builds on the approach from closed #70837 (author unable to follow up).

closes: #43366

Test plan

  • CI static checks pass (config.yml only)
  • Generated configuration reference renders distinct metrics vs traces descriptions

Was generative AI tooling used to co-author this PR?
  • Yes
  • No

Each duplicated otel_* description now states which signal it configures, keeping both [metrics] and [traces] options intact per maintainer guidance. Also restores literal markup in [traces] descriptions.

Closes apache#43366
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Five "otel_*" options appear twice in the "Configuration Reference"

1 participant