Add warning to OT shim log/log_event calls (open-telemetry#255)

codeboten · c24t · commit e53edd52c463 · 2019-10-31T12:04:01.000-07:00
diff --git a/ext/opentelemetry-ext-opentracing-shim/setup.cfg b/ext/opentelemetry-ext-opentracing-shim/setup.cfg
@@ -39,6 +39,7 @@ package_dir=
     =src
 packages=find_namespace:
 install_requires =
+    Deprecated >= 1.2.6
     opentracing
     opentelemetry-api
 
diff --git a/ext/opentelemetry-ext-opentracing-shim/src/opentelemetry/ext/opentracing_shim/__init__.py b/ext/opentelemetry-ext-opentracing-shim/src/opentelemetry/ext/opentracing_shim/__init__.py
@@ -15,6 +15,7 @@
 import logging
 
 import opentracing
+from deprecated import deprecated
 
 from opentelemetry.ext.opentracing_shim import util
 
@@ -77,6 +78,14 @@ def log_kv(self, key_values, timestamp=None):
         self._otel_span.add_event(event_name, event_timestamp, key_values)
         return self
 
+    @deprecated(reason="This method is deprecated in favor of log_kv")
+    def log(self, **kwargs):
+        super().log(**kwargs)
+
+    @deprecated(reason="This method is deprecated in favor of log_kv")
+    def log_event(self, event, payload=None):
+        super().log_event(event, payload=payload)
+
     def set_baggage_item(self, key, value):
         logger.warning(
             "Calling unimplemented method set_baggage_item() on class %s",
@@ -91,10 +100,6 @@ def get_baggage_item(self, key):
         )
         # TODO: Implement.
 
-    # TODO: Verify calls to deprecated methods `log_event()` and `log()` on
-    # base class work properly (it's probably fine because both methods call
-    # `log_kv()`).
-
 
 class ScopeShim(opentracing.Scope):
     """A `ScopeShim` wraps the OpenTelemetry functionality related to span
diff --git a/ext/opentelemetry-ext-opentracing-shim/tests/test_shim.py b/ext/opentelemetry-ext-opentracing-shim/tests/test_shim.py
@@ -406,6 +406,28 @@ def test_log_kv(self):
             # biggest possible loss of precision.
             self.assertAlmostEqual(result, now, places=6)
 
+    def test_log(self):
+        """Test the deprecated `log` method on `Span` objects."""
+
+        with self.shim.start_span("TestSpan") as span:
+            with self.assertWarns(DeprecationWarning):
+                span.log(event="foo", payload="bar")
+
+        self.assertEqual(span.unwrap().events[0].attributes["event"], "foo")
+        self.assertEqual(span.unwrap().events[0].attributes["payload"], "bar")
+        self.assertIsNotNone(span.unwrap().events[0].timestamp)
+
+    def test_log_event(self):
+        """Test the deprecated `log_event` method on `Span` objects."""
+
+        with self.shim.start_span("TestSpan") as span:
+            with self.assertWarns(DeprecationWarning):
+                span.log_event("foo", "bar")
+
+        self.assertEqual(span.unwrap().events[0].attributes["event"], "foo")
+        self.assertEqual(span.unwrap().events[0].attributes["payload"], "bar")
+        self.assertIsNotNone(span.unwrap().events[0].timestamp)
+
     def test_span_context(self):
         """Test construction of `SpanContextShim` objects."""
 
