api: rename Span::record_exception to Span::record_error
#756
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 change aligns the error recording methods with Rust's naming conventions which prefer the term `Error` over `Exception`. This also removes `Span::record_exception_with_stacktrace` as Rust's backtrace functionality is not yet stable. Users who wish to record this data can use `Span::add_event` directly.
Codecov Report
@@ Coverage Diff @@
## main #756 +/- ##
==========================================
- Coverage 70.22% 70.18% -0.05%
==========================================
Files 108 108
Lines 8804 8783 -21
==========================================
- Hits 6183 6164 -19
+ Misses 2621 2619 -2
Continue to review full report at Codecov.
|
djc
approved these changes
Mar 12, 2022
| self.with_inner_mut(|inner| inner.record_exception_with_stacktrace(err, stacktrace)) | ||
| /// Record an error as an event for this span. | ||
| /// | ||
| /// An additional call to [Span::set_status] is required if the status of the |
There was a problem hiding this comment.
Instead of calling this out in the docs, why don't we just fix it?
vibhavp
pushed a commit
to vibhavp/opentelemetry-rust
that referenced
this pull request
Mar 14, 2022
…lemetry#756) This change aligns the error recording methods with Rust's naming conventions which prefer the term `Error` over `Exception`. This also removes `Span::record_exception_with_stacktrace` as Rust's backtrace functionality is not yet stable. Users who wish to record this data can use `Span::add_event` directly.
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 change aligns the error recording methods with Rust's naming conventions which prefer the term
ErroroverException.This also removes
Span::record_exception_with_stacktraceas Rust's backtrace functionality is not yet stable. Users who wish to record this data can useSpan::add_eventdirectly.