From 10dc3a8bc031d5b355f62a698094a03eedb2a8ee Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Mon, 8 Mar 2021 13:14:30 -0800 Subject: [PATCH] expose StatusCode from opentelemetry.trace --- CHANGELOG.md | 2 ++ .../tests/test_otcollector_trace_exporter.py | 13 ++++--------- .../exporter/otlp/trace_exporter/__init__.py | 2 +- .../exporter/zipkin/encoder/__init__.py | 2 +- .../src/opentelemetry/trace/__init__.py | 1 + .../src/opentelemetry/instrumentation/utils.py | 2 +- .../tests/test_utils.py | 2 +- opentelemetry-sdk/tests/trace/test_trace.py | 18 ++++++------------ 8 files changed, 17 insertions(+), 25 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index bfac59d9cd0..25945bae51c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -40,6 +40,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ([#1663](https://github.com/open-telemetry/opentelemetry-python/pull/1663)) - Rename `JaegerSpanExporter` to `JaegerExporter` and rename `ZipkinSpanExporter` to `ZipkinExporter` ([#1664](https://github.com/open-telemetry/opentelemetry-python/pull/1664)) +- Expose `StatusCode` from the `opentelemetry.trace` module + ([#](https://github.com/open-telemetry/opentelemetry-python/pull/)) ### Removed - Removed unused `get_hexadecimal_trace_id` and `get_hexadecimal_span_id` methods. diff --git a/exporter/opentelemetry-exporter-opencensus/tests/test_otcollector_trace_exporter.py b/exporter/opentelemetry-exporter-opencensus/tests/test_otcollector_trace_exporter.py index 97b1a379126..1d9442dcef2 100644 --- a/exporter/opentelemetry-exporter-opencensus/tests/test_otcollector_trace_exporter.py +++ b/exporter/opentelemetry-exporter-opencensus/tests/test_otcollector_trace_exporter.py @@ -147,16 +147,12 @@ def test_translate_to_collector(self): otel_spans[0].set_attribute("key_float", 111.22) otel_spans[0].set_attribute("key_int", 333) otel_spans[0].set_status( - trace_api.Status( - trace_api.status.StatusCode.OK, "test description", - ) + trace_api.Status(trace_api.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.StatusCode.ERROR, {"test", "val"}, - ) + trace_api.Status(trace_api.StatusCode.ERROR, {"test", "val"},) ) otel_spans[1].end(end_time=end_times[1]) otel_spans[2].start(start_time=start_times[2]) @@ -196,7 +192,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.StatusCode.OK.value, + output_spans[0].status.code, trace_api.StatusCode.OK.value, ) self.assertEqual(output_spans[0].status.message, "test description") self.assertEqual(len(output_spans[0].tracestate.entries), 1) @@ -267,8 +263,7 @@ def test_translate_to_collector(self): trace_pb2.Span.Link.Type.TYPE_UNSPECIFIED, ) self.assertEqual( - output_spans[1].status.code, - trace_api.status.StatusCode.ERROR.value, + output_spans[1].status.code, trace_api.StatusCode.ERROR.value, ) self.assertEqual( output_spans[2].links.link[0].type, diff --git a/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/trace_exporter/__init__.py b/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/trace_exporter/__init__.py index a357734bc1c..44da4288cbb 100644 --- a/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/trace_exporter/__init__.py +++ b/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/trace_exporter/__init__.py @@ -47,7 +47,7 @@ ) from opentelemetry.sdk.trace import Span as ReadableSpan from opentelemetry.sdk.trace.export import SpanExporter, SpanExportResult -from opentelemetry.trace.status import StatusCode +from opentelemetry.trace import StatusCode logger = logging.getLogger(__name__) diff --git a/exporter/opentelemetry-exporter-zipkin/src/opentelemetry/exporter/zipkin/encoder/__init__.py b/exporter/opentelemetry-exporter-zipkin/src/opentelemetry/exporter/zipkin/encoder/__init__.py index 2b9e53af6e3..f1c30410ced 100644 --- a/exporter/opentelemetry-exporter-zipkin/src/opentelemetry/exporter/zipkin/encoder/__init__.py +++ b/exporter/opentelemetry-exporter-zipkin/src/opentelemetry/exporter/zipkin/encoder/__init__.py @@ -28,10 +28,10 @@ from opentelemetry.trace import ( Span, SpanContext, + StatusCode, format_span_id, format_trace_id, ) -from opentelemetry.trace.status import StatusCode EncodedLocalEndpointT = TypeVar("EncodedLocalEndpointT") diff --git a/opentelemetry-api/src/opentelemetry/trace/__init__.py b/opentelemetry-api/src/opentelemetry/trace/__init__.py index 6e32fb352d2..9ca199cf952 100644 --- a/opentelemetry-api/src/opentelemetry/trace/__init__.py +++ b/opentelemetry-api/src/opentelemetry/trace/__init__.py @@ -516,4 +516,5 @@ def use_span( "set_span_in_context", "use_span", "Status", + "StatusCode", ] diff --git a/opentelemetry-instrumentation/src/opentelemetry/instrumentation/utils.py b/opentelemetry-instrumentation/src/opentelemetry/instrumentation/utils.py index 49386f1dddd..dec070570fd 100644 --- a/opentelemetry-instrumentation/src/opentelemetry/instrumentation/utils.py +++ b/opentelemetry-instrumentation/src/opentelemetry/instrumentation/utils.py @@ -16,7 +16,7 @@ from wrapt import ObjectProxy -from opentelemetry.trace.status import StatusCode +from opentelemetry.trace import StatusCode def extract_attributes_from_object( diff --git a/opentelemetry-instrumentation/tests/test_utils.py b/opentelemetry-instrumentation/tests/test_utils.py index bcbf6eced00..273c6f085cc 100644 --- a/opentelemetry-instrumentation/tests/test_utils.py +++ b/opentelemetry-instrumentation/tests/test_utils.py @@ -16,7 +16,7 @@ from opentelemetry.instrumentation.utils import http_status_to_status_code from opentelemetry.test.test_base import TestBase -from opentelemetry.trace.status import StatusCode +from opentelemetry.trace import StatusCode class TestUtils(TestBase): diff --git a/opentelemetry-sdk/tests/trace/test_trace.py b/opentelemetry-sdk/tests/trace/test_trace.py index 2bcc1bdd19a..d4732cf02bd 100644 --- a/opentelemetry-sdk/tests/trace/test_trace.py +++ b/opentelemetry-sdk/tests/trace/test_trace.py @@ -37,7 +37,7 @@ from opentelemetry.sdk.trace.id_generator import RandomIdGenerator from opentelemetry.sdk.util import ns_to_iso_str from opentelemetry.sdk.util.instrumentation import InstrumentationInfo -from opentelemetry.trace.status import StatusCode +from opentelemetry.trace import StatusCode from opentelemetry.util.time import time_ns @@ -835,18 +835,14 @@ def test_start_span(self): self.assertEqual(start_time, span.start_time) self.assertIsNotNone(span.status) - self.assertIs( - span.status.status_code, trace_api.status.StatusCode.UNSET - ) + self.assertIs(span.status.status_code, trace_api.StatusCode.UNSET) # status new_status = trace_api.status.Status( - trace_api.status.StatusCode.ERROR, "Test description" + trace_api.StatusCode.ERROR, "Test description" ) span.set_status(new_status) - self.assertIs( - span.status.status_code, trace_api.status.StatusCode.ERROR - ) + self.assertIs(span.status.status_code, trace_api.StatusCode.ERROR) self.assertIs(span.status.description, "Test description") def test_start_accepts_context(self): @@ -906,14 +902,12 @@ def test_ended_span(self): self.assertEqual(root.name, "root") new_status = trace_api.status.Status( - trace_api.status.StatusCode.ERROR, "Test description" + trace_api.StatusCode.ERROR, "Test description" ) with self.assertLogs(level=WARNING): root.set_status(new_status) - self.assertEqual( - root.status.status_code, trace_api.status.StatusCode.UNSET - ) + self.assertEqual(root.status.status_code, trace_api.StatusCode.UNSET) def test_error_status(self): def error_status_test(context):