From 5e83d56c9fc78be1ae1b522bcb47465bda9c75c9 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Sat, 2 May 2020 21:40:04 -0700 Subject: [PATCH 1/9] fix: ensure status is always string During some testing, found that the pymongo instrumentation was setting the status description field as a dict which made the otcollector fail to process any spans. Added a test and wrapped the description field in a `str`. --- .../ext/otcollector/trace_exporter/__init__.py | 2 +- .../tests/test_otcollector_trace_exporter.py | 10 ++++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/ext/opentelemetry-ext-otcollector/src/opentelemetry/ext/otcollector/trace_exporter/__init__.py b/ext/opentelemetry-ext-otcollector/src/opentelemetry/ext/otcollector/trace_exporter/__init__.py index fb6237e86d8..3aca62d6884 100644 --- a/ext/opentelemetry-ext-otcollector/src/opentelemetry/ext/otcollector/trace_exporter/__init__.py +++ b/ext/opentelemetry-ext-otcollector/src/opentelemetry/ext/otcollector/trace_exporter/__init__.py @@ -96,7 +96,7 @@ def translate_to_collector(spans: Sequence[Span]): if span.status is not None: status = trace_pb2.Status( code=span.status.canonical_code.value, - message=span.status.description, + message=str(span.status.description), ) collector_span = trace_pb2.Span( name=trace_pb2.TruncatableString(value=span.name), diff --git a/ext/opentelemetry-ext-otcollector/tests/test_otcollector_trace_exporter.py b/ext/opentelemetry-ext-otcollector/tests/test_otcollector_trace_exporter.py index 4a0a556137d..ecb6325ac7b 100644 --- a/ext/opentelemetry-ext-otcollector/tests/test_otcollector_trace_exporter.py +++ b/ext/opentelemetry-ext-otcollector/tests/test_otcollector_trace_exporter.py @@ -154,6 +154,11 @@ def test_translate_to_collector(self): ) 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"}, + ) + ) otel_spans[1].end(end_time=end_times[1]) otel_spans[2].start(start_time=start_times[2]) otel_spans[2].end(end_time=end_times[2]) @@ -263,6 +268,11 @@ def test_translate_to_collector(self): output_spans[0].links.link[0].type, trace_pb2.Span.Link.Type.TYPE_UNSPECIFIED, ) + self.assertEqual( + output_spans[1].status.code, + trace_api.status.StatusCanonicalCode.INTERNAL.value, + ) + self.assertEqual(output_spans[1].status.message, "{'val', 'test'}") self.assertEqual( output_spans[2].links.link[0].type, trace_pb2.Span.Link.Type.PARENT_LINKED_SPAN, From c43a31d11595328e71dd97381fb783f3f2f1d0a1 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Sat, 2 May 2020 21:56:41 -0700 Subject: [PATCH 2/9] fix test --- .../tests/test_otcollector_trace_exporter.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ext/opentelemetry-ext-otcollector/tests/test_otcollector_trace_exporter.py b/ext/opentelemetry-ext-otcollector/tests/test_otcollector_trace_exporter.py index ecb6325ac7b..7f9aaf9bd38 100644 --- a/ext/opentelemetry-ext-otcollector/tests/test_otcollector_trace_exporter.py +++ b/ext/opentelemetry-ext-otcollector/tests/test_otcollector_trace_exporter.py @@ -272,7 +272,7 @@ def test_translate_to_collector(self): output_spans[1].status.code, trace_api.status.StatusCanonicalCode.INTERNAL.value, ) - self.assertEqual(output_spans[1].status.message, "{'val', 'test'}") + self.assertIn("test", output_spans[1].status.message) self.assertEqual( output_spans[2].links.link[0].type, trace_pb2.Span.Link.Type.PARENT_LINKED_SPAN, From 8310a5daa3244fa92e8f0ef5a14d4ee206d2f72e Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Mon, 4 May 2020 14:48:49 -0700 Subject: [PATCH 3/9] log a warning if an invalid description is used --- .../otcollector/trace_exporter/__init__.py | 7 ++-- .../tests/test_otcollector_trace_exporter.py | 2 +- .../src/opentelemetry/trace/status.py | 9 ++++- opentelemetry-api/tests/trace/test_status.py | 35 +++++++++++++++++++ 4 files changed, 47 insertions(+), 6 deletions(-) create mode 100644 opentelemetry-api/tests/trace/test_status.py diff --git a/ext/opentelemetry-ext-otcollector/src/opentelemetry/ext/otcollector/trace_exporter/__init__.py b/ext/opentelemetry-ext-otcollector/src/opentelemetry/ext/otcollector/trace_exporter/__init__.py index 3aca62d6884..94fad31b184 100644 --- a/ext/opentelemetry-ext-otcollector/src/opentelemetry/ext/otcollector/trace_exporter/__init__.py +++ b/ext/opentelemetry-ext-otcollector/src/opentelemetry/ext/otcollector/trace_exporter/__init__.py @@ -94,10 +94,9 @@ def translate_to_collector(spans: Sequence[Span]): for span in spans: status = None if span.status is not None: - status = trace_pb2.Status( - code=span.status.canonical_code.value, - message=str(span.status.description), - ) + status = trace_pb2.Status(code=span.status.canonical_code.value,) + if isinstance(span.status.description, str): + status.message = span.status.description collector_span = trace_pb2.Span( name=trace_pb2.TruncatableString(value=span.name), kind=utils.get_collector_span_kind(span.kind), diff --git a/ext/opentelemetry-ext-otcollector/tests/test_otcollector_trace_exporter.py b/ext/opentelemetry-ext-otcollector/tests/test_otcollector_trace_exporter.py index 7f9aaf9bd38..f74c8bb7031 100644 --- a/ext/opentelemetry-ext-otcollector/tests/test_otcollector_trace_exporter.py +++ b/ext/opentelemetry-ext-otcollector/tests/test_otcollector_trace_exporter.py @@ -272,7 +272,7 @@ def test_translate_to_collector(self): output_spans[1].status.code, trace_api.status.StatusCanonicalCode.INTERNAL.value, ) - self.assertIn("test", output_spans[1].status.message) + self.assertEqual(output_spans[1].status.message, "") self.assertEqual( output_spans[2].links.link[0].type, trace_pb2.Span.Link.Type.PARENT_LINKED_SPAN, diff --git a/opentelemetry-api/src/opentelemetry/trace/status.py b/opentelemetry-api/src/opentelemetry/trace/status.py index 4ae2ad96d08..734714e10d6 100644 --- a/opentelemetry-api/src/opentelemetry/trace/status.py +++ b/opentelemetry-api/src/opentelemetry/trace/status.py @@ -13,8 +13,11 @@ # limitations under the License. import enum +import logging import typing +logger = logging.getLogger(__name__) + class StatusCanonicalCode(enum.Enum): """Represents the canonical set of status codes of a finished Span.""" @@ -167,7 +170,11 @@ def __init__( description: typing.Optional[str] = None, ): self._canonical_code = canonical_code - self._description = description + if description is not None and not isinstance(description, str): + logger.warning("Invalid status description type, expected str") + self._description = "" + else: + self._description = description @property def canonical_code(self) -> StatusCanonicalCode: diff --git a/opentelemetry-api/tests/trace/test_status.py b/opentelemetry-api/tests/trace/test_status.py new file mode 100644 index 00000000000..108dfb619ad --- /dev/null +++ b/opentelemetry-api/tests/trace/test_status.py @@ -0,0 +1,35 @@ +# Copyright The OpenTelemetry Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import unittest + +from opentelemetry.trace.status import Status, StatusCanonicalCode + + +class TestStatus(unittest.TestCase): + def test_constructor(self): + status = Status() + self.assertEqual(status.canonical_code, StatusCanonicalCode.OK) + self.assertEqual(status.description, None) + + status = Status(StatusCanonicalCode.UNAVAILABLE, "unavailable") + self.assertEqual( + status.canonical_code, StatusCanonicalCode.UNAVAILABLE + ) + self.assertEqual(status.description, "unavailable") + + def test_invalid_description(self): + status = Status(description={"test": "val"}) + self.assertEqual(status.canonical_code, StatusCanonicalCode.OK) + self.assertEqual(status.description, "") From 1bb637c27950ebb7d1ecc6a588b23041087d68d2 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Fri, 8 May 2020 10:02:16 -0700 Subject: [PATCH 4/9] no more need to check instance type --- .../ext/otcollector/trace_exporter/__init__.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/ext/opentelemetry-ext-otcollector/src/opentelemetry/ext/otcollector/trace_exporter/__init__.py b/ext/opentelemetry-ext-otcollector/src/opentelemetry/ext/otcollector/trace_exporter/__init__.py index 94fad31b184..914d97ec5a9 100644 --- a/ext/opentelemetry-ext-otcollector/src/opentelemetry/ext/otcollector/trace_exporter/__init__.py +++ b/ext/opentelemetry-ext-otcollector/src/opentelemetry/ext/otcollector/trace_exporter/__init__.py @@ -94,9 +94,11 @@ def translate_to_collector(spans: Sequence[Span]): for span in spans: status = None if span.status is not None: - status = trace_pb2.Status(code=span.status.canonical_code.value,) - if isinstance(span.status.description, str): - status.message = span.status.description + status = trace_pb2.Status( + code=span.status.canonical_code.value, + message=span.status.description, + ) + collector_span = trace_pb2.Span( name=trace_pb2.TruncatableString(value=span.name), kind=utils.get_collector_span_kind(span.kind), From fb3aea23263bf1f0c340af6eb15a6b6c2986354b Mon Sep 17 00:00:00 2001 From: alrex Date: Fri, 8 May 2020 10:03:30 -0700 Subject: [PATCH 5/9] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Mauricio Vásquez --- opentelemetry-api/tests/trace/test_status.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/opentelemetry-api/tests/trace/test_status.py b/opentelemetry-api/tests/trace/test_status.py index 108dfb619ad..693d6d1028c 100644 --- a/opentelemetry-api/tests/trace/test_status.py +++ b/opentelemetry-api/tests/trace/test_status.py @@ -21,7 +21,7 @@ class TestStatus(unittest.TestCase): def test_constructor(self): status = Status() self.assertEqual(status.canonical_code, StatusCanonicalCode.OK) - self.assertEqual(status.description, None) + self.assertIsNone(status.description) status = Status(StatusCanonicalCode.UNAVAILABLE, "unavailable") self.assertEqual( @@ -31,5 +31,5 @@ def test_constructor(self): def test_invalid_description(self): status = Status(description={"test": "val"}) - self.assertEqual(status.canonical_code, StatusCanonicalCode.OK) + self.assertIs(status.canonical_code, StatusCanonicalCode.OK) self.assertEqual(status.description, "") From 1823d62660d025c8785089fe679f3f4310e32e91 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Fri, 8 May 2020 10:09:11 -0700 Subject: [PATCH 6/9] add test for logged warning --- opentelemetry-api/tests/trace/test_status.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/opentelemetry-api/tests/trace/test_status.py b/opentelemetry-api/tests/trace/test_status.py index 693d6d1028c..62d371f7b3d 100644 --- a/opentelemetry-api/tests/trace/test_status.py +++ b/opentelemetry-api/tests/trace/test_status.py @@ -13,6 +13,7 @@ # limitations under the License. import unittest +from logging import WARNING from opentelemetry.trace.status import Status, StatusCanonicalCode @@ -30,6 +31,7 @@ def test_constructor(self): self.assertEqual(status.description, "unavailable") def test_invalid_description(self): - status = Status(description={"test": "val"}) - self.assertIs(status.canonical_code, StatusCanonicalCode.OK) - self.assertEqual(status.description, "") + with self.assertLogs(level=WARNING): + status = Status(description={"test": "val"}) + self.assertEqual(status.canonical_code, StatusCanonicalCode.OK) + self.assertEqual(status.description, "") From d46ac1f6acae2334566dab1e4ab1ea6d67762f97 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Mon, 11 May 2020 13:53:51 -0700 Subject: [PATCH 7/9] fix mypy --- opentelemetry-api/src/opentelemetry/trace/status.py | 2 +- opentelemetry-api/tests/trace/test_status.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/opentelemetry-api/src/opentelemetry/trace/status.py b/opentelemetry-api/src/opentelemetry/trace/status.py index 734714e10d6..4191369dfe9 100644 --- a/opentelemetry-api/src/opentelemetry/trace/status.py +++ b/opentelemetry-api/src/opentelemetry/trace/status.py @@ -170,9 +170,9 @@ def __init__( description: typing.Optional[str] = None, ): self._canonical_code = canonical_code + self._description = None if description is not None and not isinstance(description, str): logger.warning("Invalid status description type, expected str") - self._description = "" else: self._description = description diff --git a/opentelemetry-api/tests/trace/test_status.py b/opentelemetry-api/tests/trace/test_status.py index 62d371f7b3d..5c2be0e1e98 100644 --- a/opentelemetry-api/tests/trace/test_status.py +++ b/opentelemetry-api/tests/trace/test_status.py @@ -32,6 +32,6 @@ def test_constructor(self): def test_invalid_description(self): with self.assertLogs(level=WARNING): - status = Status(description={"test": "val"}) + status = Status(description={"test": "val"}) # type: ignore self.assertEqual(status.canonical_code, StatusCanonicalCode.OK) self.assertEqual(status.description, "") From c7f8d7ce4056cd64df28f3fa202fc92306bdad4c Mon Sep 17 00:00:00 2001 From: alrex Date: Thu, 14 May 2020 14:37:04 -0700 Subject: [PATCH 8/9] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Mauricio Vásquez --- opentelemetry-api/tests/trace/test_status.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/opentelemetry-api/tests/trace/test_status.py b/opentelemetry-api/tests/trace/test_status.py index 5c2be0e1e98..725e8b6a378 100644 --- a/opentelemetry-api/tests/trace/test_status.py +++ b/opentelemetry-api/tests/trace/test_status.py @@ -21,11 +21,11 @@ class TestStatus(unittest.TestCase): def test_constructor(self): status = Status() - self.assertEqual(status.canonical_code, StatusCanonicalCode.OK) + self.assertIs(status.canonical_code, StatusCanonicalCode.OK) self.assertIsNone(status.description) status = Status(StatusCanonicalCode.UNAVAILABLE, "unavailable") - self.assertEqual( + self.assertIs( status.canonical_code, StatusCanonicalCode.UNAVAILABLE ) self.assertEqual(status.description, "unavailable") @@ -33,5 +33,5 @@ def test_constructor(self): def test_invalid_description(self): with self.assertLogs(level=WARNING): status = Status(description={"test": "val"}) # type: ignore - self.assertEqual(status.canonical_code, StatusCanonicalCode.OK) + self.assertIs(status.canonical_code, StatusCanonicalCode.OK) self.assertEqual(status.description, "") From fe66e2a22e437a3d0342d1a647f917074b423252 Mon Sep 17 00:00:00 2001 From: Alex Boten Date: Thu, 14 May 2020 20:31:38 -0700 Subject: [PATCH 9/9] fix tests --- .../tests/test_otcollector_trace_exporter.py | 1 - opentelemetry-api/tests/trace/test_status.py | 8 +++----- 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/ext/opentelemetry-ext-otcollector/tests/test_otcollector_trace_exporter.py b/ext/opentelemetry-ext-otcollector/tests/test_otcollector_trace_exporter.py index f74c8bb7031..97d276af403 100644 --- a/ext/opentelemetry-ext-otcollector/tests/test_otcollector_trace_exporter.py +++ b/ext/opentelemetry-ext-otcollector/tests/test_otcollector_trace_exporter.py @@ -272,7 +272,6 @@ def test_translate_to_collector(self): output_spans[1].status.code, trace_api.status.StatusCanonicalCode.INTERNAL.value, ) - self.assertEqual(output_spans[1].status.message, "") self.assertEqual( output_spans[2].links.link[0].type, trace_pb2.Span.Link.Type.PARENT_LINKED_SPAN, diff --git a/opentelemetry-api/tests/trace/test_status.py b/opentelemetry-api/tests/trace/test_status.py index 725e8b6a378..6c086f3ae04 100644 --- a/opentelemetry-api/tests/trace/test_status.py +++ b/opentelemetry-api/tests/trace/test_status.py @@ -25,13 +25,11 @@ def test_constructor(self): self.assertIsNone(status.description) status = Status(StatusCanonicalCode.UNAVAILABLE, "unavailable") - self.assertIs( - status.canonical_code, StatusCanonicalCode.UNAVAILABLE - ) + self.assertIs(status.canonical_code, StatusCanonicalCode.UNAVAILABLE) self.assertEqual(status.description, "unavailable") def test_invalid_description(self): with self.assertLogs(level=WARNING): - status = Status(description={"test": "val"}) # type: ignore + status = Status(description={"test": "val"}) # type: ignore self.assertIs(status.canonical_code, StatusCanonicalCode.OK) - self.assertEqual(status.description, "") + self.assertEqual(status.description, None)