[Core] Add method for setting span error status #40703
Merged
Conversation
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
pvaneck
force-pushed
the
core-tracing-status
branch
from
a6f0e1a to
e63f6f6
Compare
API Change CheckAPIView identified API level changes in this PR and created the following API reviews |
pvaneck
requested review from
lmazuel,
annatisch,
johanste,
xiangyan99,
iscai-msft and
kashifkhan
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR adds a utility method (set_span_status) to the OpenTelemetryTracer class so that users can set span statuses without having to import opentelemetry types.
- Introduces a static method set_span_status in opentelemetry.py that maps string status values ("OK", "ERROR", "UNSET") to corresponding Opentelemetry StatusCode enums.
- Adds tests in test_tracer_otel.py to verify correct behavior for valid statuses and proper error handling for invalid statuses.
- Updates the CHANGELOG to document the new feature.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| sdk/core/azure-core/tests/test_tracer_otel.py | Added unit tests covering valid, case-insensitive, and invalid span status cases. |
| sdk/core/azure-core/azure/core/tracing/opentelemetry.py | Defined the new set_span_status method to simplify span status setting. |
| sdk/core/azure-core/CHANGELOG.md | Updated changelog to include the set_span_status feature. |
Comments suppressed due to low confidence (1)
sdk/core/azure-core/tests/test_tracer_otel.py:378
- [nitpick] Consider asserting the exception message to confirm that the raised ValueError contains the expected error message. This can help ensure that the error is being raised for the correct reason.
with pytest.raises(ValueError):
|
API change check APIView has identified API level changes in this PR and created following API reviews. |
Spans started by `OpenTelemetryTracer` in core return an OpenTelemetry span. The set_status on this method requires that a user imports `opentelemetry` types for `StatusCode` enums. We want to avoid SDK developers needing to import `opentelemetry` in order to set a span status, however it all cases so far where a user is setting a status, it's to set it to ERROR. Here, we are adding a utility method on the `OpenTelemetryTracer` class to enable setting an error status on a provided span. Signed-off-by: Paul Van Eck <[email protected]>
pvaneck
force-pushed
the
core-tracing-status
branch
from
e5bb939 to
6b81910
Compare
pvaneck
changed the title
|
will there be other methods that do need an import however, even if right now its largely the error scenario? |
kashifkhan
approved these changes
Apr 29, 2025
|
/check-enforcer override |
bambriz
pushed a commit
to bambriz/azure-sdk-for-python
that referenced
this pull request
May 5, 2025
Spans started by `OpenTelemetryTracer` in core return an OpenTelemetry span. The set_status on this method requires that a user imports `opentelemetry` types for `StatusCode` enums. We want to avoid SDK developers needing to import `opentelemetry` in order to set a span status, however in all cases so far where a user is setting a status, it's to set it to ERROR. Here, we are adding a utility method on the `OpenTelemetryTracer` class to enable setting an error status on a provided span. Signed-off-by: Paul Van Eck <[email protected]>
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.
Spans started by
OpenTelemetryTracerin core return an OpenTelemetry span. Theset_statuson this method requires that a user importsopentelemetrytypes forStatusCodeenums.We want to avoid SDK developers needing to import
opentelemetryin order to set a span status. However, in all cases so far, where a status on a span is being set, it's to set it toERROR. Here, we are adding a utility method on theOpenTelemetryTracerclass to enable setting an error status on a provided span.