Add setStatus in Span

opentelemetry-api/src/opentelemetry/trace/__init__.py

@@ -139,6 +139,33 @@ class SpanKind(enum.Enum):
     CONSUMER = 4
 
 
+class SpanStatus:
+    """Represents the status of a finished Span """
+
+    def get_canonical_code(self) -> int:
+        """Gets the status CanonicalCode.
+        StatusCanonicalCode represents the canonical set of status codes of a finished Span, following the Standard GRPC codes
+        https://github.com/grpc/grpc/blob/master/doc/statuscodes.md
+
+        Returns:
+            A number representing the CanonicalCode
+        """
+
+    def get_description(self) -> str:
+        """Gets the status description.
+
+        Returns:
+           Returns the description of the Status.
+        """
+
+    def get_is_ok(self) -> bool:
+        """Gets the status is ok flag.
+
+        Returns:
+           Returns false if this Status represents an error, else returns true.
+        """
+
+
 class Span:
     """A span represents a single operation within a trace."""
 
@@ -226,6 +253,10 @@ def is_recording_events(self) -> bool:
         events with the add_event operation and attributes using set_attribute.
         """
 
+    def set_status(self, status: SpanStatus) -> None:
+        """Sets the Status of the Span. If used, this will override the default Span status, which is OK.
+        """
+
 
 class TraceOptions(int):
     """A bitmask that represents options specific to the trace.

opentelemetry-sdk/src/opentelemetry/sdk/trace/__init__.py

@@ -94,6 +94,32 @@ def shutdown(self) -> None:
             sp.shutdown()
 
 
+class SpanStatus(trace_api.SpanStatus):
+    """See `opentelemetry.trace.SpanStatus`.
+
+    Represents the status of a finished Span
+
+    Args:
+        canonical_code: Represents the canonical set of status codes of a finished Span, following the Standard GRPC codes
+        description: Description of this Status
+        is_ok: Use to determine if the span was an error or not
+    """
+
+    def __init__(self, canonical_code=0, description=None, is_ok=True):
+        self.canonical_code = canonical_code
+        self.description = description
+        self.is_ok = is_ok
+
+    def get_canonical_code(self) -> bool:
+        return self.canonical_code
+
+    def get_description(self) -> bool:
+        return self.description
+
+    def get_is_ok(self) -> bool:
+        return self.is_ok
+
+
 class Span(trace_api.Span):
     """See `opentelemetry.trace.Span`.
 
@@ -132,6 +158,7 @@ def __init__(
         links: typing.Sequence[trace_api.Link] = None,  # TODO
         kind: trace_api.SpanKind = trace_api.SpanKind.INTERNAL,
         span_processor: SpanProcessor = SpanProcessor(),
+        status: SpanStatus = SpanStatus(),
     ) -> None:
 
         self.name = name
@@ -141,6 +168,7 @@ def __init__(
         self.trace_config = trace_config
         self.resource = resource
         self.kind = kind
+        self.status = status
 
         self.span_processor = span_processor
         self._lock = threading.Lock()
@@ -285,6 +313,9 @@ def update_name(self, name: str) -> None:
     def is_recording_events(self) -> bool:
         return True
 
+    def set_status(self, status: trace_api.SpanStatus) -> None:
+        self.status = status
+
 
 def generate_span_id() -> int:
     """Get a new random span ID.

opentelemetry-sdk/tests/trace/test_trace.py

@@ -235,6 +235,16 @@ def test_start_span(self):
         span.start()
         self.assertEqual(start_time, span.start_time)
 
+        # default status
+        self.assertEqual(span.status.get_is_ok(), True)
+        self.assertEqual(span.status.get_canonical_code(), 0)
+        self.assertEqual(span.status.get_description(), None)
+
+        # status
+        new_status = trace.SpanStatus(2, "Test description", False)
+        span.set_status(new_status)
+        self.assertEqual(span.status, new_status)
+
     def test_span_override_start_and_end_time(self):
         """Span sending custom start_time and end_time values"""
         span = trace.Span("name", mock.Mock(spec=trace_api.SpanContext))