Skip to content

chore: add configurator method docs - #2265

Merged
kaylareopelle merged 6 commits into
open-telemetry:mainfrom
RedZapdos123:chore/configurator-doc-method
Sep 3, 2026
Merged

chore: add configurator method docs#2265
kaylareopelle merged 6 commits into
open-telemetry:mainfrom
RedZapdos123:chore/configurator-doc-method

Conversation

@RedZapdos123

@RedZapdos123 RedZapdos123 commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Style/DocumentationMethod reports 5 informational offenses in sdk/lib/opentelemetry/sdk/configurator.rb for undocumented methods in NoopTextMapPropagator and the Configurator getters.

This PR adds minimal method documentation comments for those methods and keeps the change scoped to a single file. It does not change behavior.

Signed-off-by: Mridankan Mandal <xerontitan90@gmail.com>

@kaylareopelle kaylareopelle left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One concern related to error_handler. Everything else looks good to go! Thank you!

Comment thread sdk/lib/opentelemetry/sdk/configurator.rb
@RedZapdos123

Copy link
Copy Markdown
Contributor Author

Looked into the failing opentelemetry-sdk / ubuntu-24.04 check. It seems to be a separate flaky test in sdk/test/opentelemetry/sdk/trace/export/batch_span_processor_test.rb, not a regression from this PR.

Reproduced it under JRuby. The reports consistent label keys example can race with the worker thread so the queue overflow path is sometimes skipped and only one otel.bsp.dropped_spans metric entry is recorded. I opened #2321 to make that example deterministic by setting start_thread_on_boot: false.

@kaylareopelle
kaylareopelle merged commit 3ac9ed6 into open-telemetry:main Sep 3, 2026
65 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.

4 participants