Change status codes from grpc status codes, remove setting status in instrumentations except on ERROR (#1282)

Author: lzchen

docs/examples/auto-instrumentation/README.rst

@@ -112,7 +112,7 @@ similar to:
         "start_time": "2020-04-30T17:28:57.886397Z",
         "end_time": "2020-04-30T17:28:57.886490Z",
         "status": {
-            "canonical_code": "OK"
+            "status_code": "OK"
         },
         "attributes": {
             "component": "http",
@@ -164,7 +164,7 @@ similar to:
         "start_time": "2020-04-30T17:10:02.400604Z",
         "end_time": "2020-04-30T17:10:02.401858Z",
         "status": {
-            "canonical_code": "OK"
+            "status_code": "OK"
         },
         "attributes": {
             "component": "http",

docs/examples/django/README.rst

@@ -77,7 +77,7 @@ output similar to this one:
         "start_time": "2020-04-26T01:49:57.205833Z",
         "end_time": "2020-04-26T01:49:57.206214Z",
         "status": {
-            "canonical_code": "OK"
+            "status_code": "OK"
         },
         "attributes": {
             "component": "http",

docs/getting-started.rst

@@ -49,7 +49,7 @@ We can run it, and see the traces print to your console:
         "start_time": "2020-05-07T14:39:52.906272Z",
         "end_time": "2020-05-07T14:39:52.906343Z",
         "status": {
-            "canonical_code": "OK"
+            "status_code": "OK"
         },
         "attributes": {},
         "events": [],
@@ -67,7 +67,7 @@ We can run it, and see the traces print to your console:
         "start_time": "2020-05-07T14:39:52.906230Z",
         "end_time": "2020-05-07T14:39:52.906601Z",
         "status": {
-            "canonical_code": "OK"
+            "status_code": "OK"
         },
         "attributes": {},
         "events": [],
@@ -85,7 +85,7 @@ We can run it, and see the traces print to your console:
         "start_time": "2020-05-07T14:39:52.906157Z",
         "end_time": "2020-05-07T14:39:52.906743Z",
         "status": {
-            "canonical_code": "OK"
+            "status_code": "OK"
         },
         "attributes": {},
         "events": [],

exporter/opentelemetry-exporter-datadog/src/opentelemetry/exporter/datadog/exporter.py

@@ -23,7 +23,6 @@
 import opentelemetry.trace as trace_api
 from opentelemetry.sdk.trace import sampling
 from opentelemetry.sdk.trace.export import SpanExporter, SpanExportResult
-from opentelemetry.trace.status import StatusCanonicalCode
 
 # pylint:disable=relative-beyond-top-level
 from .constants import (
@@ -145,7 +144,7 @@ def _translate_to_datadog(self, spans):
             datadog_span.start_ns = span.start_time
             datadog_span.duration_ns = span.end_time - span.start_time
 
-            if span.status.canonical_code is not StatusCanonicalCode.OK:
+            if not span.status.is_ok:
                 datadog_span.error = 1
                 if span.status.description:
                     exc_type, exc_val = _get_exc_info(span)

exporter/opentelemetry-exporter-jaeger/src/opentelemetry/exporter/jaeger/__init__.py

@@ -70,7 +70,7 @@
 from opentelemetry.exporter.jaeger.gen.agent import Agent as agent
 from opentelemetry.exporter.jaeger.gen.jaeger import Collector as jaeger
 from opentelemetry.sdk.trace.export import Span, SpanExporter, SpanExportResult
-from opentelemetry.trace.status import StatusCanonicalCode
+from opentelemetry.trace.status import StatusCode
 
 DEFAULT_AGENT_HOST_NAME = "localhost"
 DEFAULT_AGENT_PORT = 6831
@@ -224,7 +224,7 @@ def _translate_to_jaeger(spans: Span):
 
         tags.extend(
             [
-                _get_long_tag("status.code", status.canonical_code.value),
+                _get_long_tag("status.code", status.status_code.value),
                 _get_string_tag("status.message", status.description),
                 _get_string_tag("span.kind", span.kind.name),
             ]
@@ -245,7 +245,7 @@ def _translate_to_jaeger(spans: Span):
             )
 
         # Ensure that if Status.Code is not OK, that we set the "error" tag on the Jaeger span.
-        if status.canonical_code is not StatusCanonicalCode.OK:
+        if not status.is_ok:
             tags.append(_get_bool_tag("error", True))
 
         refs = _extract_refs_from_span(span)

exporter/opentelemetry-exporter-jaeger/tests/test_jaeger_exporter.py

@@ -25,7 +25,7 @@
 from opentelemetry.sdk import trace
 from opentelemetry.sdk.trace import Resource
 from opentelemetry.sdk.util.instrumentation import InstrumentationInfo
-from opentelemetry.trace.status import Status, StatusCanonicalCode
+from opentelemetry.trace.status import Status, StatusCode
 
 
 class TestJaegerSpanExporter(unittest.TestCase):
@@ -210,7 +210,7 @@ def test_translate_to_jaeger(self):
             jaeger.Tag(
                 key="status.code",
                 vType=jaeger.TagType.LONG,
-                vLong=StatusCanonicalCode.OK.value,
+                vLong=StatusCode.UNSET.value,
             ),
             jaeger.Tag(
                 key="status.message", vType=jaeger.TagType.STRING, vStr=None
@@ -249,7 +249,7 @@ def test_translate_to_jaeger(self):
             attributes={"key_resource": "some_resource"}
         )
         otel_spans[0].set_status(
-            Status(StatusCanonicalCode.UNKNOWN, "Example description")
+            Status(StatusCode.ERROR, "Example description")
         )
         otel_spans[0].end(end_time=end_times[0])
 
@@ -259,6 +259,7 @@ def test_translate_to_jaeger(self):
 
         otel_spans[2].start(start_time=start_times[2])
         otel_spans[2].resource = Resource({})
+        otel_spans[2].set_status(Status(StatusCode.OK, "Example description"))
         otel_spans[2].end(end_time=end_times[2])
         otel_spans[2].instrumentation_info = InstrumentationInfo(
             name="name", version="version"
@@ -304,7 +305,7 @@ def test_translate_to_jaeger(self):
                     jaeger.Tag(
                         key="status.code",
                         vType=jaeger.TagType.LONG,
-                        vLong=StatusCanonicalCode.UNKNOWN.value,
+                        vLong=StatusCode.ERROR.value,
                     ),
                     jaeger.Tag(
                         key="status.message",
@@ -380,12 +381,12 @@ def test_translate_to_jaeger(self):
                     jaeger.Tag(
                         key="status.code",
                         vType=jaeger.TagType.LONG,
-                        vLong=StatusCanonicalCode.OK.value,
+                        vLong=StatusCode.OK.value,
                     ),
                     jaeger.Tag(
                         key="status.message",
                         vType=jaeger.TagType.STRING,
-                        vStr=None,
+                        vStr="Example description",
                     ),
                     jaeger.Tag(
                         key="span.kind",

exporter/opentelemetry-exporter-opencensus/src/opentelemetry/exporter/opencensus/trace_exporter/__init__.py

@@ -93,7 +93,7 @@ def translate_to_collector(spans: Sequence[Span]):
         status = None
         if span.status is not None:
             status = trace_pb2.Status(
-                code=span.status.canonical_code.value,
+                code=span.status.status_code.value,
                 message=span.status.description,
             )
 

exporter/opentelemetry-exporter-opencensus/tests/test_otcollector_trace_exporter.py

@@ -148,15 +148,14 @@ def test_translate_to_collector(self):
         otel_spans[0].set_attribute("key_int", 333)
         otel_spans[0].set_status(
             trace_api.Status(
-                trace_api.status.StatusCanonicalCode.INTERNAL,
-                "test description",
+                trace_api.status.StatusCode.OK, "test description",
             )
         )
         otel_spans[0].end(end_time=end_times[0])
         otel_spans[1].start(start_time=start_times[1])
         otel_spans[1].set_status(
             trace_api.Status(
-                trace_api.status.StatusCanonicalCode.INTERNAL, {"test", "val"},
+                trace_api.status.StatusCode.ERROR, {"test", "val"},
             )
         )
         otel_spans[1].end(end_time=end_times[1])
@@ -197,8 +196,7 @@ def test_translate_to_collector(self):
             output_spans[2].parent_span_id, b"\x11\x11\x11\x11\x11\x11\x11\x11"
         )
         self.assertEqual(
-            output_spans[0].status.code,
-            trace_api.status.StatusCanonicalCode.INTERNAL.value,
+            output_spans[0].status.code, trace_api.status.StatusCode.OK.value,
         )
         self.assertEqual(output_spans[0].status.message, "test description")
         self.assertEqual(len(output_spans[0].tracestate.entries), 1)
@@ -270,7 +268,7 @@ def test_translate_to_collector(self):
         )
         self.assertEqual(
             output_spans[1].status.code,
-            trace_api.status.StatusCanonicalCode.INTERNAL.value,
+            trace_api.status.StatusCode.ERROR.value,
         )
         self.assertEqual(
             output_spans[2].links.link[0].type,

exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/trace_exporter/__init__.py

@@ -41,6 +41,7 @@
 from opentelemetry.proto.trace.v1.trace_pb2 import Status
 from opentelemetry.sdk.trace import Span as SDKSpan
 from opentelemetry.sdk.trace.export import SpanExporter, SpanExportResult
+from opentelemetry.trace.status import StatusCode
 
 logger = logging.getLogger(__name__)
 
@@ -198,9 +199,12 @@ def _translate_links(self, sdk_span: SDKSpan) -> None:
 
     def _translate_status(self, sdk_span: SDKSpan) -> None:
         if sdk_span.status is not None:
+            # TODO: Update this when the proto definitions are updated to include UNSET and ERROR
+            proto_status_code = Status.STATUS_CODE_OK
+            if sdk_span.status.status_code is StatusCode.ERROR:
+                proto_status_code = Status.STATUS_CODE_UNKNOWN_ERROR
             self._collector_span_kwargs["status"] = Status(
-                code=sdk_span.status.canonical_code.value,
-                message=sdk_span.status.description,
+                code=proto_status_code, message=sdk_span.status.description,
             )
 
     def _translate_data(

exporter/opentelemetry-exporter-zipkin/src/opentelemetry/exporter/zipkin/__init__.py

@@ -193,7 +193,7 @@ def _translate_to_zipkin(self, spans: Sequence[Span]):
 
             if span.status is not None:
                 zipkin_span["tags"]["otel.status_code"] = str(
-                    span.status.canonical_code.value
+                    span.status.status_code.value
                 )
                 if span.status.description is not None:
                     zipkin_span["tags"][