Skip to content

Commit

Permalink
Update Jaeger exporter span transformation (#1914)
Browse files Browse the repository at this point in the history 
Co-authored-by: Daniel Dyla <[email protected]>
  • Loading branch information
@srikanthccv @dyladan
srikanthccv and dyladan authored Feb 14, 2021
1 parent 11d9b19 commit 06c7ec7
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 54 deletions.
31 changes: 23 additions & 8 deletions packages/opentelemetry-exporter-jaeger/src/transform.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,19 +50,23 @@ export function spanToThrift(span: ReadableSpan): ThriftSpan {
const tags = Object.keys(span.attributes).map(
(name): Tag => ({ key: name, value: toTagValue(span.attributes[name]) })
);
tags.push({ key: 'status.code', value: span.status.code });
tags.push({ key: 'status.name', value: SpanStatusCode[span.status.code] });
if (span.status.message) {
tags.push({ key: 'status.message', value: span.status.message });
if (span.status.code !== SpanStatusCode.UNSET) {
tags.push({
key: 'otel.status_code',
value: SpanStatusCode[span.status.code],
});
if (span.status.message) {
tags.push({ key: 'otel.status_description', value: span.status.message });
}
}
// Ensure that if SpanStatus.Code is ERROR, that we set the "error" tag on the
// Jaeger span.
if (span.status.code === SpanStatusCode.ERROR) {
tags.push({ key: 'error', value: true });
}

if (span.kind !== undefined) {
tags.push({ key: 'span.kind', value: SpanKind[span.kind] });
if (span.kind !== undefined && span.kind !== SpanKind.INTERNAL) {
tags.push({ key: 'span.kind', value: SpanKind[span.kind].toLowerCase() });
}
Object.keys(span.resource.attributes).forEach(name =>
tags.push({
Expand All @@ -71,11 +75,22 @@ export function spanToThrift(span: ReadableSpan): ThriftSpan {
})
);

if (span.instrumentationLibrary) {
tags.push({
key: 'otel.library.name',
value: toTagValue(span.instrumentationLibrary.name),
});
tags.push({
key: 'otel.library.version',
value: toTagValue(span.instrumentationLibrary.version),
});
}

const spanTags: ThriftTag[] = ThriftUtils.getThriftTags(tags);

const logs = span.events.map(
(event): Log => {
const fields: Tag[] = [{ key: 'message.id', value: event.name }];
const fields: Tag[] = [{ key: 'event', value: event.name }];
const attrs = event.attributes;
if (attrs) {
Object.keys(attrs).forEach(attr =>
Expand Down Expand Up @@ -110,7 +125,7 @@ function spanLinksToThriftRefs(
return links
.map((link): ThriftReference | null => {
if (link.context.spanId === parentSpanId) {
const refType = ThriftReferenceType.CHILD_OF;
const refType = ThriftReferenceType.FOLLOWS_FROM;
const traceId = link.context.traceId;
const traceIdHigh = Utils.encodeInt64(traceId.slice(0, 16));
const traceIdLow = Utils.encodeInt64(traceId.slice(16));
Expand Down
73 changes: 27 additions & 46 deletions packages/opentelemetry-exporter-jaeger/test/transform.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,17 +104,7 @@ describe('transform', () => {
Utils.encodeInt64(hrTimeToMicroseconds(readableSpan.startTime))
);
assert.strictEqual(thriftSpan.tags.length, 9);
const [
tag1,
tag2,
tag3,
tag4,
tag5,
tag6,
tag7,
tag8,
tag9,
] = thriftSpan.tags;
const [tag1, tag2, tag3, tag4, tag5, tag6, tag7] = thriftSpan.tags;
assert.strictEqual(tag1.key, 'testBool');
assert.strictEqual(tag1.vType, 'BOOL');
assert.strictEqual(tag1.vBool, true);
Expand All @@ -124,31 +114,25 @@ describe('transform', () => {
assert.strictEqual(tag3.key, 'testNum');
assert.strictEqual(tag3.vType, 'DOUBLE');
assert.strictEqual(tag3.vDouble, 3.142);
assert.strictEqual(tag4.key, 'status.code');
assert.strictEqual(tag4.vType, 'DOUBLE');
assert.strictEqual(tag4.vDouble, api.SpanStatusCode.OK);
assert.strictEqual(tag5.key, 'status.name');
assert.strictEqual(tag4.key, 'otel.status_code');
assert.strictEqual(tag4.vType, 'STRING');
assert.strictEqual(tag4.vStr, 'OK');
assert.strictEqual(tag5.key, 'service');
assert.strictEqual(tag5.vType, 'STRING');
assert.strictEqual(tag5.vStr, 'OK');
assert.strictEqual(tag6.key, 'span.kind');
assert.strictEqual(tag6.vType, 'STRING');
assert.strictEqual(tag6.vStr, 'INTERNAL');
assert.strictEqual(tag7.key, 'service');
assert.strictEqual(tag7.vType, 'STRING');
assert.strictEqual(tag7.vStr, 'ui');
assert.strictEqual(tag8.key, 'version');
assert.strictEqual(tag8.vType, 'DOUBLE');
assert.strictEqual(tag8.vDouble, 1);
assert.strictEqual(tag9.key, 'cost');
assert.strictEqual(tag9.vType, 'DOUBLE');
assert.strictEqual(tag9.vDouble, 112.12);
assert.strictEqual(tag5.vStr, 'ui');
assert.strictEqual(tag6.key, 'version');
assert.strictEqual(tag6.vType, 'DOUBLE');
assert.strictEqual(tag6.vDouble, 1);
assert.strictEqual(tag7.key, 'cost');
assert.strictEqual(tag7.vType, 'DOUBLE');
assert.strictEqual(tag7.vDouble, 112.12);
assert.strictEqual(thriftSpan.references.length, 0);

assert.strictEqual(thriftSpan.logs.length, 1);
const [log1] = thriftSpan.logs;
assert.strictEqual(log1.fields.length, 2);
const [field1, field2] = log1.fields;
assert.strictEqual(field1.key, 'message.id');
assert.strictEqual(field1.key, 'event');
assert.strictEqual(field1.vType, 'STRING');
assert.strictEqual(field1.vStr, 'something happened');
assert.strictEqual(field2.key, 'error');
Expand Down Expand Up @@ -198,23 +182,20 @@ describe('transform', () => {
assert.deepStrictEqual(thriftSpan.parentSpanId, ThriftUtils.emptyBuffer);
assert.deepStrictEqual(thriftSpan.flags, 1);
assert.strictEqual(thriftSpan.references.length, 0);
assert.strictEqual(thriftSpan.tags.length, 5);
const [tag1, tag2, tag3, tag4, tag5] = thriftSpan.tags;
assert.strictEqual(tag1.key, 'status.code');
assert.strictEqual(tag1.vType, 'DOUBLE');
assert.strictEqual(tag1.vDouble, 2);
assert.strictEqual(tag2.key, 'status.name');
assert.strictEqual(thriftSpan.tags.length, 6);
const [tag1, tag2, tag3, tag4] = thriftSpan.tags;
assert.strictEqual(tag1.key, 'otel.status_code');
assert.strictEqual(tag1.vType, 'STRING');
assert.strictEqual(tag1.vStr, 'ERROR');
assert.strictEqual(tag2.key, 'otel.status_description');
assert.strictEqual(tag2.vType, 'STRING');
assert.strictEqual(tag2.vStr, 'ERROR');
assert.strictEqual(tag3.key, 'status.message');
assert.strictEqual(tag3.vType, 'STRING');
assert.strictEqual(tag3.vStr, 'data loss');
assert.strictEqual(tag4.key, 'error');
assert.strictEqual(tag4.vType, 'BOOL');
assert.strictEqual(tag4.vBool, true);
assert.strictEqual(tag5.key, 'span.kind');
assert.strictEqual(tag5.vType, 'STRING');
assert.strictEqual(tag5.vStr, 'CLIENT');
assert.strictEqual(tag2.vStr, 'data loss');
assert.strictEqual(tag3.key, 'error');
assert.strictEqual(tag3.vType, 'BOOL');
assert.strictEqual(tag3.vBool, true);
assert.strictEqual(tag4.key, 'span.kind');
assert.strictEqual(tag4.vType, 'STRING');
assert.strictEqual(tag4.vStr, 'client');
assert.strictEqual(thriftSpan.logs.length, 0);
});

Expand Down Expand Up @@ -261,7 +242,7 @@ describe('transform', () => {
assert.strictEqual(ref1.traceIdLow.toString('hex'), '92b449d5929fda1b');
assert.strictEqual(ref1.traceIdHigh.toString('hex'), 'a4cda95b652f4a15');
assert.strictEqual(ref1.spanId.toString('hex'), '3e0c63257de34c92');
assert.strictEqual(ref1.refType, ThriftReferenceType.CHILD_OF);
assert.strictEqual(ref1.refType, ThriftReferenceType.FOLLOWS_FROM);
});

it('should left pad trace ids', () => {
Expand Down

0 comments on commit 06c7ec7

Please sign in to comment.