docs: document custom error handlers - #2264
Conversation
|
|
Signed-off-by: Mridankan Mandal <xerontitan90@gmail.com>
5794df2 to
3f81159
Compare
|
Following up on the notes in this PR description:
|
Signed-off-by: Mridankan Mandal <xerontitan90@gmail.com>
|
Thank you for your contribution, @RedZapdos123! I appreciate your patience with our review. I had a hard time viewing the new documentation you added. Please see the comments in my review. |
Signed-off-by: Mridankan Mandal <xerontitan90@gmail.com>
|
@RedZapdos123 - There merge conflicts, I believe after #2265 was merged. Please take a look when you can. |
Signed-off-by: Mridankan Mandal <xerontitan90@gmail.com>
|
Resolved the merge conflict. |
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.