[Core] Add method for setting span status

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, so we are adding a
utility method on the `OpenTelemetryTracer` class to enable this.

Signed-off-by: Paul Van Eck <[email protected]>

Author: pvaneck

sdk/core/azure-core/azure/core/tracing/opentelemetry.py

@@ -12,6 +12,7 @@
     Span,
     SpanKind as OpenTelemetrySpanKind,
     Link as OpenTelemetryLink,
+    StatusCode,
 )
 from opentelemetry.trace.propagation import get_current_span as get_current_span_otel
 from opentelemetry.propagate import extract, inject
@@ -161,6 +162,27 @@ def use_span(cls, span: Span, *, end_on_exit: bool = True) -> Iterator[Span]:
         ) as active_span:
             yield active_span
 
+    @staticmethod
+    def set_span_status(span: Span, status: str, description: Optional[str] = None) -> None:
+        """Set the status of a span.
+
+        :param span: The span to set the status on
+        :type span: ~opentelemetry.trace.Span
+        :param status: The status to set. Valid values are "OK", "ERROR", or "UNSET".
+        :type status: str
+        :param description: An optional description of the status. Only valid when status is "ERROR".
+        :type description: str
+        """
+        status = status.upper()
+        if status == "OK":
+            span.set_status(StatusCode.OK)
+        elif status == "ERROR":
+            span.set_status(StatusCode.ERROR, description=description)
+        elif status == "UNSET":
+            span.set_status(StatusCode.UNSET)
+        else:
+            raise ValueError(f"Invalid status value: {status}. Valid values are 'OK', 'ERROR', or 'UNSET'.")
+
     def _parse_links(self, links: Optional[Sequence[Link]]) -> Optional[Sequence[OpenTelemetryLink]]:
         if not links:
             return None

sdk/core/azure-core/tests/test_tracer_otel.py

@@ -354,3 +354,39 @@ def test_tracer_caching_different_args():
 
     assert tracer1 is tracer2
     assert tracer1 is not tracer3
+
+
+def test_tracer_set_span_status(tracing_helper):
+    """Test that the tracer's set_span_status method works correctly."""
+    tracer = get_tracer()
+    assert tracer
+
+    # Test OK status
+    with tracer.start_as_current_span(name="ok-span") as span:
+        tracer.set_span_status(span, "OK")
+
+    # Test ERROR status with description
+    with tracer.start_as_current_span(name="error-span") as span:
+        tracer.set_span_status(span, "ERROR", "This is an error")
+
+    # Test UNSET status
+    with tracer.start_as_current_span(name="unset-span") as span:
+        tracer.set_span_status(span, "unset")  # Testing case-insensitivity
+
+    # Test invalid status
+    with tracer.start_as_current_span(name="invalid-span") as span:
+        with pytest.raises(ValueError):
+            tracer.set_span_status(span, "INVALID")
+
+    # Verify status on finished spans
+    finished_spans = tracing_helper.exporter.get_finished_spans()
+    assert len(finished_spans) == 4
+
+    assert finished_spans[0].status.status_code == OtelStatusCode.OK
+    assert finished_spans[0].status.description is None
+
+    assert finished_spans[1].status.status_code == OtelStatusCode.ERROR
+    assert finished_spans[1].status.description == "This is an error"
+
+    assert finished_spans[2].status.status_code == OtelStatusCode.UNSET
+    assert finished_spans[2].status.description is None