ext/Zipkin - Transform resource to tags when exporting (open-telemetry#707)

nirsky · alrex · toumorokoshi · web-flow · commit 97b7c22cdae7 · 2020-05-21T20:28:44.000-07:00
Implement the missing part of exporting the TraceProvider resource into Zipkin.
Same as in js. Resources are now included into span tags.

Co-authored-by: alrex &lt;aboten@lightstep.com&gt;
Co-authored-by: Yusuke Tsutsumi &lt;yusuke@tsutsumi.io&gt;
diff --git a/ext/opentelemetry-ext-zipkin/src/opentelemetry/ext/zipkin/__init__.py b/ext/opentelemetry-ext-zipkin/src/opentelemetry/ext/zipkin/__init__.py
@@ -175,7 +175,7 @@ def _translate_to_zipkin(self, spans: Sequence[Span]):
                 "duration": duration_mus,
                 "localEndpoint": local_endpoint,
                 "kind": SPAN_KIND_MAP[span.kind],
-                "tags": _extract_tags_from_span(span.attributes),
+                "tags": _extract_tags_from_span(span),
                 "annotations": _extract_annotations_from_events(span.events),
             }
 
@@ -196,11 +196,11 @@ def shutdown(self) -> None:
         pass
 
 
-def _extract_tags_from_span(attr):
-    if not attr:
-        return None
+def _extract_tags_from_dict(tags_dict):
     tags = {}
-    for attribute_key, attribute_value in attr.items():
+    if not tags_dict:
+        return tags
+    for attribute_key, attribute_value in tags_dict.items():
         if isinstance(attribute_value, (int, bool, float)):
             value = str(attribute_value)
         elif isinstance(attribute_value, str):
@@ -212,6 +212,13 @@ def _extract_tags_from_span(attr):
     return tags
 
 
+def _extract_tags_from_span(span: Span):
+    tags = _extract_tags_from_dict(getattr(span, "attributes", None))
+    if span.resource:
+        tags.update(_extract_tags_from_dict(span.resource.labels))
+    return tags
+
+
 def _extract_annotations_from_events(events):
     return (
         [
diff --git a/ext/opentelemetry-ext-zipkin/tests/test_zipkin_exporter.py b/ext/opentelemetry-ext-zipkin/tests/test_zipkin_exporter.py
@@ -19,6 +19,7 @@
 from opentelemetry import trace as trace_api
 from opentelemetry.ext.zipkin import ZipkinSpanExporter
 from opentelemetry.sdk import trace
+from opentelemetry.sdk.trace import Resource
 from opentelemetry.sdk.trace.export import SpanExportResult
 from opentelemetry.trace import TraceFlags
 
@@ -95,7 +96,7 @@ def test_constructor_explicit(self):
     # pylint: disable=too-many-locals
     def test_export(self):
 
-        span_names = ("test1", "test2", "test3")
+        span_names = ("test1", "test2", "test3", "test4")
         trace_id = 0x6E0C63257DE34C926F9EFCD03927272E
         span_id = 0x34BF92DEEFC58C92
         parent_id = 0x1111111111111111
@@ -106,12 +107,14 @@ def test_export(self):
             base_time,
             base_time + 150 * 10 ** 6,
             base_time + 300 * 10 ** 6,
+            base_time + 400 * 10 ** 6,
         )
-        durations = (50 * 10 ** 6, 100 * 10 ** 6, 200 * 10 ** 6)
+        durations = (50 * 10 ** 6, 100 * 10 ** 6, 200 * 10 ** 6, 300 * 10 ** 6)
         end_times = (
             start_times[0] + durations[0],
             start_times[1] + durations[1],
             start_times[2] + durations[2],
+            start_times[3] + durations[3],
         )
 
         span_context = trace_api.SpanContext(
@@ -158,6 +161,7 @@ def test_export(self):
                 name=span_names[1], context=parent_context, parent=None
             ),
             trace.Span(name=span_names[2], context=other_context, parent=None),
+            trace.Span(name=span_names[3], context=other_context, parent=None),
         ]
 
         otel_spans[0].start(start_time=start_times[0])
@@ -168,11 +172,21 @@ def test_export(self):
         otel_spans[0].end(end_time=end_times[0])
 
         otel_spans[1].start(start_time=start_times[1])
+        otel_spans[1].resource = Resource(
+            labels={"key_resource": "some_resource"}
+        )
         otel_spans[1].end(end_time=end_times[1])
 
         otel_spans[2].start(start_time=start_times[2])
+        otel_spans[2].set_attribute("key_string", "hello_world")
+        otel_spans[2].resource = Resource(
+            labels={"key_resource": "some_resource"}
+        )
         otel_spans[2].end(end_time=end_times[2])
 
+        otel_spans[3].start(start_time=start_times[3])
+        otel_spans[3].end(end_time=end_times[3])
+
         service_name = "test-service"
         local_endpoint = {"serviceName": service_name, "port": 9411}
 
@@ -208,7 +222,7 @@ def test_export(self):
                 "duration": durations[1] // 10 ** 3,
                 "localEndpoint": local_endpoint,
                 "kind": None,
-                "tags": None,
+                "tags": {"key_resource": "some_resource"},
                 "annotations": None,
             },
             {
@@ -219,7 +233,21 @@ def test_export(self):
                 "duration": durations[2] // 10 ** 3,
                 "localEndpoint": local_endpoint,
                 "kind": None,
-                "tags": None,
+                "tags": {
+                    "key_string": "hello_world",
+                    "key_resource": "some_resource",
+                },
+                "annotations": None,
+            },
+            {
+                "traceId": format(trace_id, "x"),
+                "id": format(other_id, "x"),
+                "name": span_names[3],
+                "timestamp": start_times[3] // 10 ** 3,
+                "duration": durations[3] // 10 ** 3,
+                "localEndpoint": local_endpoint,
+                "kind": None,
+                "tags": {},
                 "annotations": None,
             },
         ]
