Enable setting the ipv4/ipv4 in localEndpoint for zipkin (#119)

Author: liyanhui1228

opencensus/trace/exporters/zipkin_exporter.py

@@ -71,13 +71,17 @@ def __init__(
             host_name=DEFAULT_HOST_NAME,
             port=DEFAULT_PORT,
             endpoint=DEFAULT_ENDPOINT,
-            transport=sync.SyncTransport):
+            transport=sync.SyncTransport,
+            ipv4=None,
+            ipv6=None):
         self.service_name = service_name
         self.host_name = host_name
         self.port = port
         self.endpoint = endpoint
         self.url = self.get_url
         self.transport = transport(self)
+        self.ipv4 = ipv4
+        self.ipv6 = ipv6
 
     @property
     def get_url(self):
@@ -126,10 +130,15 @@ def translate_to_zipkin(self, trace_id, spans):
         """
         local_endpoint = {
             'serviceName': self.service_name,
-            'ipv4': self.host_name,
             'port': self.port,
         }
 
+        if self.ipv4 is not None:
+            local_endpoint['ipv4'] = self.ipv4
+
+        if self.ipv6 is not None:
+            local_endpoint['ipv6'] = self.ipv6
+
         zipkin_spans = []
 
         for span in spans:

tests/unit/trace/exporters/test_zipkin_exporter.py

@@ -27,12 +27,14 @@ def test_constructor(self):
         host_name = '0.0.0.0'
         port = 2333
         endpoint = '/api/v2/test'
+        ipv4 = '127.0.0.1'
 
         exporter = zipkin_exporter.ZipkinExporter(
             service_name=service_name,
             host_name=host_name,
             port=port,
-            endpoint=endpoint)
+            endpoint=endpoint,
+            ipv4=ipv4)
 
         expected_url = 'http://0.0.0.0:2333/api/v2/test'
 
@@ -41,6 +43,7 @@ def test_constructor(self):
         self.assertEqual(exporter.port, port)
         self.assertEqual(exporter.endpoint, endpoint)
         self.assertEqual(exporter.url, expected_url)
+        self.assertEqual(exporter.ipv4, ipv4)
 
     def test_export(self):
         exporter = zipkin_exporter.ZipkinExporter(
@@ -144,23 +147,33 @@ def test_translate_to_zipkin_span_kind_none(self):
         }
 
         trace_id = '6e0c63257de34c92bf9efcd03927272e'
-        spans = [span1, span2, span3]
+        spans_ipv4 = [span1, span2]
+        spans_ipv6 = [span3]
 
-        local_endpoint = {
+        ipv4 = '127.0.0.1'
+        ipv6 = '2001:0db8:85a3:0000:0000:8a2e:0370:7334'
+
+        local_endpoint_ipv4 = {
+            'serviceName': 'my_service',
+            'ipv4': ipv4,
+            'port': 9411,
+        }
+
+        local_endpoint_ipv6 = {
             'serviceName': 'my_service',
-            'ipv4': 'localhost',
+            'ipv6': ipv6,
             'port': 9411,
         }
 
-        expected_zipkin_spans = [
+        expected_zipkin_spans_ipv4 = [
             {
                 'traceId': '6e0c63257de34c92bf9efcd03927272e',
                 'id': '1234567890',
                 'parentId': '1111111111',
                 'name': 'child_span',
                 'timestamp': 1502820146000000,
                 'duration': 10000000,
-                'localEndpoint': local_endpoint,
+                'localEndpoint': local_endpoint_ipv4,
                 'tags': {'test_key': 'test_value'},
             },
             {
@@ -170,27 +183,41 @@ def test_translate_to_zipkin_span_kind_none(self):
                 'name': 'child_span',
                 'timestamp': 1502820146000000,
                 'duration': 10000000,
-                'localEndpoint': local_endpoint,
+                'localEndpoint': local_endpoint_ipv4,
                 'tags': {'test_key': '1'},
             },
+        ]
+
+        expected_zipkin_spans_ipv6 = [
             {
                 'traceId': '6e0c63257de34c92bf9efcd03927272e',
                 'id': '1234567890',
                 'name': 'child_span',
                 'timestamp': 1502820146000000,
                 'duration': 10000000,
-                'localEndpoint': local_endpoint,
+                'localEndpoint': local_endpoint_ipv6,
                 'tags': {'test_key': 'False'},
                 'kind': 'SERVER',
-            }
+            },
         ]
 
-        exporter = zipkin_exporter.ZipkinExporter(service_name='my_service')
-        zipkin_spans = exporter.translate_to_zipkin(
+        # Test ipv4 local endpoint
+        exporter_ipv4 = zipkin_exporter.ZipkinExporter(
+            service_name='my_service', ipv4=ipv4)
+        zipkin_spans_ipv4 = exporter_ipv4.translate_to_zipkin(
+            trace_id=trace_id,
+            spans=spans_ipv4)
+
+        self.assertEqual(zipkin_spans_ipv4, expected_zipkin_spans_ipv4)
+
+        # Test ipv6 local endpoint
+        exporter_ipv6 = zipkin_exporter.ZipkinExporter(
+            service_name='my_service', ipv6=ipv6)
+        zipkin_spans_ipv6 = exporter_ipv6.translate_to_zipkin(
             trace_id=trace_id,
-            spans=spans)
+            spans=spans_ipv6)
 
-        self.assertEqual(zipkin_spans, expected_zipkin_spans)
+        self.assertEqual(zipkin_spans_ipv6, expected_zipkin_spans_ipv6)
 
 
 class MockTransport(object):