Make basictracer-py KV-compliant

Author: bhs

basictracer/span.py

@@ -44,14 +44,30 @@ def set_tag(self, key, value):
             self.tags[key] = value
         return super(BasicSpan, self).set_tag(key, value)
 
+    def log_kv(self, key_values, timestamp=None):
+        with self._lock:
+            self.logs.append(LogData(key_values, timestamp))
+        return super(BasicSpan, self).log_kv(key_values, timestamp)
+
     def log_event(self, event, payload=None):
+        key_values = {"event": event}
+        if payload is not None:
+            key_values["payload"] = payload
         with self._lock:
-            self.logs.append(LogData(event=event, payload=payload))
+            self.logs.append(LogData(key_values))
         return super(BasicSpan, self).log_event(event, payload)
 
     def log(self, **kwargs):
+        key_values = {}
+        if kwargs["event"] is not None:
+            key_values["event"] = kwargs["event"]
+        if kwargs["payload"] is not None:
+            key_values["payload"] = kwargs["payload"]
+        timestamp = None
+        if kwargs["timestamp"] is not None:
+            timestamp = kwargs["timestamp"]
         with self._lock:
-            self.logs.append(LogData(**kwargs))
+            self.logs.append(LogData(key_values, timestamp))
         return super(BasicSpan, self).log(**kwargs)
 
     def finish(self, finish_time=None):
@@ -72,12 +88,9 @@ def get_baggage_item(self, key):
 
 
 class LogData(object):
-
     def __init__(
             self,
-            event='',
-            timestamp=None,
-            payload=None):
-        self.event = event
+            key_values,
+            timestamp=None):
+        self.key_values = key_values
         self.timestamp = time.time() if timestamp is None else timestamp
-        self.payload = payload

setup.py

@@ -23,7 +23,7 @@
     install_requires=[
         'futures',
         'protobuf>=3.0.0b2.post2',
-        'opentracing>=1.1,<1.2'
+        'opentracing>=1.2,<1.3'
     ],
     extras_require={
         'tests': [

tests/test_span.py

@@ -21,3 +21,22 @@ def get_sampled_spans():
         return [span for span in recorder.get_spans() if span.context.sampled]
 
     assert len(get_sampled_spans()) == 0
+
+
+def test_span_log_kv():
+    recorder = InMemoryRecorder()
+    tracer = BasicTracer(recorder=recorder)
+
+    span = tracer.start_span('x')
+    span.log_kv({
+        'foo': 'bar',
+        'baz': 42,
+        })
+    span.finish()
+
+    finished_spans = recorder.get_spans()
+    assert len(finished_spans) == 1
+    assert len(finished_spans[0].logs) == 1
+    assert len(finished_spans[0].logs[0].key_values) == 2
+    assert finished_spans[0].logs[0].key_values['foo'] == 'bar'
+    assert finished_spans[0].logs[0].key_values['baz'] == 42