Add config support for "on_error" in Elasticsearch tracing #4066
Conversation
This file contains 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
This mirrors the functionality that is already present in many other instrumenters. Reasons for wanting this: You might want to ignore some errors in some expected scenarios such as Elasticsearch::Transport::Transport::Errors::NotFound or Elasticsearch::Transport::Transport::Errors::Conflict
bill-kolokithas
force-pushed
the
elasticsearch_on_error_support
branch
from
9398422
to
4e02912
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4066 +/- ##
=======================================
Coverage 97.72% 97.72%
=======================================
Files 1338 1338
Lines 80248 80269 +21
Branches 4016 4018 +2
=======================================
+ Hits 78420 78442 +22
+ Misses 1828 1827 -1 ☔ View full report in Codecov by Sentry. |
rtrieu
requested changes
Nov 5, 2024
docs/GettingStarted.md
Outdated
| @@ -677,6 +677,7 @@ Datadog.configure_onto(client.transport, **options) | |||
| | `service_name` | `DD_TRACE_ELASTICSEARCH_SERVICE_NAME` | `String` | Name of application running the `elasticsearch` instrumentation. May be overridden by `global_default_service_name`. [See _Additional Configuration_ for more details](#additional-configuration) | `elasticsearch` | | |||
| | `peer_service` | `DD_TRACE_ELASTICSEARCH_PEER_SERVICE` | `String` | Name of external service the application connects to | `nil` | | |||
| | `quantize` | | `Hash` | Hash containing options for quantization. May include `:show` with an Array of keys to not quantize (or `:all` to skip quantization), or `:exclude` with Array of keys to exclude entirely. | `{}` | | |||
| | `on_error` | | `Proc` | Custom error handler invoked when a request raises an error. Provided `span` and `error` as arguments. Sets error on the span by default. Useful for ignoring transient errors. | `proc { \|span, error\| span.set_error(error) unless span.nil? }` | | |||
There was a problem hiding this comment.
Suggested change
| | `on_error` | | `Proc` | Custom error handler invoked when a request raises an error. Provided `span` and `error` as arguments. Sets error on the span by default. Useful for ignoring transient errors. | `proc { \|span, error\| span.set_error(error) unless span.nil? }` | | |
| | `on_error` | | `Proc` | Custom error handler invoked when a request raises an error. Provides `span` and `error` as arguments. Sets error on the span by default. Useful for ignoring transient errors. | `proc { \|span, error\| span.set_error(error) unless span.nil? }` | |
rtrieu
approved these changes
Nov 6, 2024
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.
This mirrors the functionality that is already present in many other instrumenters.
Reasons for wanting this:
One might want to ignore some errors in some expected scenarios such as
Elasticsearch::Transport::Transport::Errors::NotFoundor
Elasticsearch::Transport::Transport::Errors::ConflictWhat does this PR do?
Adds
on_errorconfiguration support for Elasticsearch tracing and forwards it toTracing.traceMotivation:
We have flows where
NotFoundexceptions are expected and we make sure to handle them in the application.We don't want them to show up as errors in the dashboard though.
How to test the change?
Run provided tests with
bundle exec rake test:elasticsearch