From 8d433248711804f2e06e32e7b0cbe9957494978f Mon Sep 17 00:00:00 2001 From: t2t2 Date: Sat, 9 Oct 2021 16:57:36 +0300 Subject: [PATCH] fix(exporter-zipkin): correct status tags names (#2519) Co-authored-by: Valentin Marchaud --- .../src/transform.ts | 18 +++++++++-------- .../src/zipkin.ts | 4 ++-- .../test/common/transform.test.ts | 20 ++++++++----------- .../test/helper.ts | 2 +- .../test/node/zipkin.test.ts | 4 ++-- 5 files changed, 23 insertions(+), 25 deletions(-) diff --git a/packages/opentelemetry-exporter-zipkin/src/transform.ts b/packages/opentelemetry-exporter-zipkin/src/transform.ts index 64e4b48bbf..9ffd48ecce 100644 --- a/packages/opentelemetry-exporter-zipkin/src/transform.ts +++ b/packages/opentelemetry-exporter-zipkin/src/transform.ts @@ -29,8 +29,8 @@ const ZIPKIN_SPAN_KIND_MAPPING = { [api.SpanKind.INTERNAL]: undefined, }; -export const defaultStatusCodeTagName = 'ot.status_code'; -export const defaultStatusDescriptionTagName = 'ot.status_description'; +export const defaultStatusCodeTagName = 'otel.status_code'; +export const defaultStatusErrorTagName = 'error'; /** * Translate OpenTelemetry ReadableSpan to ZipkinSpan format @@ -40,7 +40,7 @@ export function toZipkinSpan( span: ReadableSpan, serviceName: string, statusCodeTagName: string, - statusDescriptionTagName: string + statusErrorTagName: string ): zipkinTypes.Span { const zipkinSpan: zipkinTypes.Span = { traceId: span.spanContext().traceId, @@ -55,7 +55,7 @@ export function toZipkinSpan( span.attributes, span.status, statusCodeTagName, - statusDescriptionTagName, + statusErrorTagName, span.resource ), annotations: span.events.length @@ -71,16 +71,18 @@ export function _toZipkinTags( attributes: api.SpanAttributes, status: api.SpanStatus, statusCodeTagName: string, - statusDescriptionTagName: string, + statusErrorTagName: string, resource: Resource ): zipkinTypes.Tags { const tags: { [key: string]: string } = {}; for (const key of Object.keys(attributes)) { tags[key] = String(attributes[key]); } - tags[statusCodeTagName] = String(api.SpanStatusCode[status.code]); - if (status.message) { - tags[statusDescriptionTagName] = status.message; + if (status.code !== api.SpanStatusCode.UNSET) { + tags[statusCodeTagName] = String(api.SpanStatusCode[status.code]); + } + if (status.code === api.SpanStatusCode.ERROR && status.message) { + tags[statusErrorTagName] = status.message; } Object.keys(resource.attributes).forEach( diff --git a/packages/opentelemetry-exporter-zipkin/src/zipkin.ts b/packages/opentelemetry-exporter-zipkin/src/zipkin.ts index ef43cff0f8..614d728cb5 100644 --- a/packages/opentelemetry-exporter-zipkin/src/zipkin.ts +++ b/packages/opentelemetry-exporter-zipkin/src/zipkin.ts @@ -22,7 +22,7 @@ import * as zipkinTypes from './types'; import { toZipkinSpan, defaultStatusCodeTagName, - defaultStatusDescriptionTagName, + defaultStatusErrorTagName, } from './transform'; import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions'; import { prepareGetHeaders } from './utils'; @@ -47,7 +47,7 @@ export class ZipkinExporter implements SpanExporter { this._serviceName = config.serviceName; this._statusCodeTagName = config.statusCodeTagName || defaultStatusCodeTagName; this._statusDescriptionTagName = - config.statusDescriptionTagName || defaultStatusDescriptionTagName; + config.statusDescriptionTagName || defaultStatusErrorTagName; this._isShutdown = false; if (typeof config.getExportRequestHeaders === 'function') { this._getHeaders = prepareGetHeaders(config.getExportRequestHeaders); diff --git a/packages/opentelemetry-exporter-zipkin/test/common/transform.test.ts b/packages/opentelemetry-exporter-zipkin/test/common/transform.test.ts index ca8d37aa75..3c7b5a5ddb 100644 --- a/packages/opentelemetry-exporter-zipkin/test/common/transform.test.ts +++ b/packages/opentelemetry-exporter-zipkin/test/common/transform.test.ts @@ -26,7 +26,7 @@ import * as assert from 'assert'; import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions'; import { defaultStatusCodeTagName, - defaultStatusDescriptionTagName, + defaultStatusErrorTagName, toZipkinSpan, _toZipkinAnnotations, _toZipkinTags, @@ -79,7 +79,7 @@ describe('transform', () => { span, 'my-service', defaultStatusCodeTagName, - defaultStatusDescriptionTagName + defaultStatusErrorTagName ); assert.deepStrictEqual(zipkinSpan, { kind: 'SERVER', @@ -101,7 +101,6 @@ describe('transform', () => { tags: { key1: 'value1', key2: 'value2', - [defaultStatusCodeTagName]: 'UNSET', [SemanticResourceAttributes.SERVICE_NAME]: 'zipkin-test', 'telemetry.sdk.language': language, 'telemetry.sdk.name': 'opentelemetry', @@ -125,7 +124,7 @@ describe('transform', () => { span, 'my-service', defaultStatusCodeTagName, - defaultStatusDescriptionTagName + defaultStatusErrorTagName ); assert.deepStrictEqual(zipkinSpan, { kind: 'SERVER', @@ -140,7 +139,6 @@ describe('transform', () => { name: span.name, parentId: undefined, tags: { - [defaultStatusCodeTagName]: 'UNSET', [SemanticResourceAttributes.SERVICE_NAME]: 'zipkin-test', 'telemetry.sdk.language': language, 'telemetry.sdk.name': 'opentelemetry', @@ -174,7 +172,7 @@ describe('transform', () => { span, 'my-service', defaultStatusCodeTagName, - defaultStatusDescriptionTagName + defaultStatusErrorTagName ); assert.deepStrictEqual(zipkinSpan, { kind: item.zipkin, @@ -189,7 +187,6 @@ describe('transform', () => { name: span.name, parentId: undefined, tags: { - [defaultStatusCodeTagName]: 'UNSET', [SemanticResourceAttributes.SERVICE_NAME]: 'zipkin-test', 'telemetry.sdk.language': language, 'telemetry.sdk.name': 'opentelemetry', @@ -220,14 +217,13 @@ describe('transform', () => { span.attributes, span.status, defaultStatusCodeTagName, - defaultStatusDescriptionTagName, + defaultStatusErrorTagName, DUMMY_RESOURCE ); assert.deepStrictEqual(tags, { key1: 'value1', key2: 'value2', - [defaultStatusCodeTagName]: 'UNSET', cost: '112.12', service: 'ui', version: '1', @@ -255,7 +251,7 @@ describe('transform', () => { span.attributes, span.status, defaultStatusCodeTagName, - defaultStatusDescriptionTagName, + defaultStatusErrorTagName, Resource.empty().merge( new Resource({ [SemanticResourceAttributes.SERVICE_NAME]: 'zipkin-test', @@ -292,7 +288,7 @@ describe('transform', () => { span.attributes, span.status, defaultStatusCodeTagName, - defaultStatusDescriptionTagName, + defaultStatusErrorTagName, Resource.empty().merge( new Resource({ [SemanticResourceAttributes.SERVICE_NAME]: 'zipkin-test', @@ -304,7 +300,7 @@ describe('transform', () => { key1: 'value1', key2: 'value2', [defaultStatusCodeTagName]: 'ERROR', - [defaultStatusDescriptionTagName]: status.message, + [defaultStatusErrorTagName]: status.message, [SemanticResourceAttributes.SERVICE_NAME]: 'zipkin-test', }); }); diff --git a/packages/opentelemetry-exporter-zipkin/test/helper.ts b/packages/opentelemetry-exporter-zipkin/test/helper.ts index b689631329..c2e13dcdd8 100644 --- a/packages/opentelemetry-exporter-zipkin/test/helper.ts +++ b/packages/opentelemetry-exporter-zipkin/test/helper.ts @@ -71,7 +71,7 @@ export function ensureSpanIsCorrect(span: Span) { localEndpoint: { serviceName: 'OpenTelemetry Service' }, tags: { component: 'foo', - 'ot.status_code': 'OK', + 'otel.status_code': 'OK', service: 'ui', version: '1', cost: '112.12', diff --git a/packages/opentelemetry-exporter-zipkin/test/node/zipkin.test.ts b/packages/opentelemetry-exporter-zipkin/test/node/zipkin.test.ts index 8749917fe9..d78b46159c 100644 --- a/packages/opentelemetry-exporter-zipkin/test/node/zipkin.test.ts +++ b/packages/opentelemetry-exporter-zipkin/test/node/zipkin.test.ts @@ -215,7 +215,7 @@ describe('Zipkin Exporter - node', () => { tags: { key1: 'value1', key2: 'value2', - 'ot.status_code': 'OK', + 'otel.status_code': 'OK', }, timestamp: startTime * MICROS_PER_SECS, traceId: span1.spanContext().traceId, @@ -230,7 +230,7 @@ describe('Zipkin Exporter - node', () => { }, name: span2.name, tags: { - 'ot.status_code': 'OK', + 'otel.status_code': 'OK', }, timestamp: hrTimeToMicroseconds([startTime, 0]), traceId: span2.spanContext().traceId,