feat(exporter-zipkin): per-span service name (#1789)

Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>
open-telemetry · Jan 15, 2021 · 471306f · 471306f
1 parent fd0d35d
commit 471306f
Show file tree

Hide file tree

Showing 2 changed files with 182 additions and 1 deletion.
diff --git a/packages/opentelemetry-exporter-zipkin/src/zipkin.ts b/packages/opentelemetry-exporter-zipkin/src/zipkin.ts
@@ -109,7 +109,11 @@ export class ZipkinExporter implements SpanExporter {
     const zipkinSpans = spans.map(span =>
       toZipkinSpan(
         span,
-        serviceName,
+        String(
+          span.attributes[SERVICE_RESOURCE.NAME] ||
+            span.resource.attributes[SERVICE_RESOURCE.NAME] ||
+            serviceName
+        ),
         this._statusCodeTagName,
         this._statusDescriptionTagName
       )

diff --git a/packages/opentelemetry-exporter-zipkin/test/node/zipkin.test.ts b/packages/opentelemetry-exporter-zipkin/test/node/zipkin.test.ts
@@ -482,6 +482,183 @@ describe('Zipkin Exporter - node', () => {
         });
       });
     });
+
+    it('should set serviceName per-span if resource has one', () => {
+      const resource_service_name = 'resource_service_name';
+      const resource_service_name_prime = 'resource_service_name_prime';
+
+      let requestBody: zipkinTypes.Span[];
+      const scope = nock('http://localhost:9411')
+        .post('/api/v2/spans', body => {
+          requestBody = body;
+          return true;
+        })
+        .replyWithError(new Error('My Socket Error'));
+
+      const parentSpanId = '5c1c63257de34c67';
+      const startTime = 1566156729709;
+      const duration = 2000;
+
+      const span1: ReadableSpan = {
+        name: 'my-span',
+        kind: api.SpanKind.INTERNAL,
+        parentSpanId,
+        spanContext: {
+          traceId: 'd4cda95b652f4a1592b449d5929fda1b',
+          spanId: '6e0c63257de34c92',
+          traceFlags: TraceFlags.NONE,
+        },
+        startTime: [startTime, 0],
+        endTime: [startTime + duration, 0],
+        ended: true,
+        duration: [duration, 0],
+        status: {
+          code: api.StatusCode.OK,
+        },
+        attributes: {
+          key1: 'value1',
+          key2: 'value2',
+        },
+        links: [],
+        events: [
+          {
+            name: 'my-event',
+            time: [startTime + 10, 0],
+            attributes: { key3: 'value3' },
+          },
+        ],
+        resource: new Resource({
+          [SERVICE_RESOURCE.NAME]: resource_service_name,
+        }),
+        instrumentationLibrary: { name: 'default', version: '0.0.1' },
+      };
+      const span2: ReadableSpan = {
+        name: 'my-span',
+        kind: api.SpanKind.SERVER,
+        spanContext: {
+          traceId: 'd4cda95b652f4a1592b449d5929fda1b',
+          spanId: '6e0c63257de34c92',
+          traceFlags: TraceFlags.NONE,
+        },
+        startTime: [startTime, 0],
+        endTime: [startTime + duration, 0],
+        ended: true,
+        duration: [duration, 0],
+        status: {
+          code: api.StatusCode.OK,
+        },
+        attributes: {},
+        links: [],
+        events: [],
+        resource: new Resource({
+          [SERVICE_RESOURCE.NAME]: resource_service_name_prime,
+        }),
+        instrumentationLibrary: { name: 'default', version: '0.0.1' },
+      };
+
+      const exporter = new ZipkinExporter({});
+
+      exporter.export([span1, span2], (result: ExportResult) => {
+        requestBody;
+        scope.done();
+        assert.equal(
+          requestBody[0].localEndpoint.serviceName,
+          resource_service_name
+        );
+        assert.equal(
+          requestBody[1].localEndpoint.serviceName,
+          resource_service_name_prime
+        );
+      });
+    });
+
+    it('should set serviceName per-span if span has attribute', () => {
+      const span_service_name = 'span_service_name';
+      const span_service_name_prime = 'span_service_name_prime';
+
+      let requestBody: any;
+      const scope = nock('http://localhost:9411')
+        .post('/api/v2/spans', body => {
+          requestBody = body;
+          return true;
+        })
+        .replyWithError(new Error('My Socket Error'));
+
+      const parentSpanId = '5c1c63257de34c67';
+      const startTime = 1566156729709;
+      const duration = 2000;
+
+      const span1: ReadableSpan = {
+        name: 'my-span',
+        kind: api.SpanKind.INTERNAL,
+        parentSpanId,
+        spanContext: {
+          traceId: 'd4cda95b652f4a1592b449d5929fda1b',
+          spanId: '6e0c63257de34c92',
+          traceFlags: TraceFlags.NONE,
+        },
+        startTime: [startTime, 0],
+        endTime: [startTime + duration, 0],
+        ended: true,
+        duration: [duration, 0],
+        status: {
+          code: api.StatusCode.OK,
+        },
+        attributes: {
+          key1: 'value1',
+          key2: 'value2',
+          [SERVICE_RESOURCE.NAME]: span_service_name,
+        },
+        links: [],
+        events: [
+          {
+            name: 'my-event',
+            time: [startTime + 10, 0],
+            attributes: { key3: 'value3' },
+          },
+        ],
+        resource: Resource.empty(),
+        instrumentationLibrary: { name: 'default', version: '0.0.1' },
+      };
+      const span2: ReadableSpan = {
+        name: 'my-span',
+        kind: api.SpanKind.SERVER,
+        spanContext: {
+          traceId: 'd4cda95b652f4a1592b449d5929fda1b',
+          spanId: '6e0c63257de34c92',
+          traceFlags: TraceFlags.NONE,
+        },
+        startTime: [startTime, 0],
+        endTime: [startTime + duration, 0],
+        ended: true,
+        duration: [duration, 0],
+        status: {
+          code: api.StatusCode.OK,
+        },
+        attributes: {
+          [SERVICE_RESOURCE.NAME]: span_service_name_prime,
+        },
+        links: [],
+        events: [],
+        resource: Resource.empty(),
+        instrumentationLibrary: { name: 'default', version: '0.0.1' },
+      };
+
+      const exporter = new ZipkinExporter({});
+
+      exporter.export([span1, span2], (result: ExportResult) => {
+        requestBody;
+        scope.done();
+        assert.equal(
+          requestBody[0].localEndpoint.serviceName,
+          span_service_name
+        );
+        assert.equal(
+          requestBody[1].localEndpoint.serviceName,
+          span_service_name_prime
+        );
+      });
+    });
   });
 
   describe('shutdown', () => {