Document custom error handlers - #2264
Open
RedZapdos123 wants to merge 1 commit into
Open
Conversation
RedZapdos123
requested review from
a team,
dazuma,
fbogsany,
kaylareopelle,
mwear,
robbkidd,
robertlaurin and
xuan-cao-swi
as code owners
July 24, 2026 20:02
|
|
Signed-off-by: Mridankan Mandal <xerontitan90@gmail.com>
RedZapdos123
force-pushed
the
docs/error-handler-1715
branch
from
July 24, 2026 20:06
5794df2 to
3f81159
Compare
Author
|
Following up on the notes in this PR description:
|
simi
approved these changes
Jul 25, 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.
Description:
Issue #1715 reported that OpenTelemetry Ruby supports custom error handlers, but the usage was not documented in an easy to find place.
This PR documents custom error handler configuration in the root README and adds YARD documentation for both
OpenTelemetry.error_handler=andOpenTelemetry::SDK::Configurator#error_handler=.It also adds a focused SDK regression test that verifies
config.error_handler=is installed during SDK configuration.Closes #1715.
Validations Run:
docker compose run --rm api bundle exec rake testdocker compose run --rm sdk bundle exec rake testdocker compose run --rm api bundle exec rubocop lib/opentelemetry.rbdocker compose run --rm sdk bundle exec rubocop lib/opentelemetry/sdk/configurator.rb test/opentelemetry/sdk_test.rbNotes:
Style/DocumentationMethodinformational offenses insdk/lib/opentelemetry/sdk/configurator.rb.bundle exec rake yardin bothapiandsdkstill reports pre-existing repository YARD warnings unrelated to this change.