Skip to content

Commit

Permalink
fix: the name of the span events in record_exception should be 'excep…
Browse files Browse the repository at this point in the history
…tion' (#12505)

To be consistent with OpenTelemetry semantics (which are the ones on
which ET aligns), the span events created from a record_exception call
should be called 'exception'

## Checklist
- [X] PR author has checked that all the criteria below are met
- The PR description includes an overview of the change
- The PR description articulates the motivation for the change
- The change includes tests OR the PR description describes a testing
strategy
- The PR description notes risks associated with the change, if any
- Newly-added code is easy to change
- The change follows the [library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
- The change includes or references documentation updates if necessary
- Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist
- [x] Reviewer has checked that all the criteria below are met 
- Title is accurate
- All changes are related to the pull request's stated goal
- Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- Testing strategy adequately addresses listed risks
- Newly-added code is easy to change
- Release note makes sense to a user of the library
- If necessary, author has acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment
- Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)
  • Loading branch information
dubloom authored Feb 26, 2025
1 parent 2fcd411 commit 4c97677
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
2 changes: 1 addition & 1 deletion ddtrace/_trace/span.py
Original file line number Diff line number Diff line change
Expand Up @@ -593,7 +593,7 @@ def record_exception(
# User provided attributes must take precedence over attrs
attrs.update(attributes)

self._add_event(name="recorded exception", attributes=attrs, timestamp=timestamp)
self._add_event(name="exception", attributes=attrs, timestamp=timestamp)

def _pprint(self) -> str:
"""Return a human readable version of the span."""
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
fixes:
- |
tracing: Changes the name of the span event generated by a record_exception
call as it was not following OTEL semantics.

0 comments on commit 4c97677

Please sign in to comment.