@uoa/lambda-tracing 2.0.0-beta.6 → 2.0.0

package/UoaB3Propagator.ts

@@ -1,5 +1,7 @@
 /**
- * Class extended from OpenTelemetry B3MultiPropagator so that we can propagate & log the X-B3-Info header
+ * Class extended from OpenTelemetry B3MultiPropagator so that we can:
+ * 1. Propagate & log the X-B3-Info header
+ * 2. Propagate the correct X-B3-ParentSpanId
  *
  * See {@link https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-propagator-b3/src/B3MultiPropagator.ts}
  */
@@ -33,6 +35,9 @@ export const B3_INFO_KEY = createContextKey(
 export const B3_TRACE_ID_LENGTH_KEY = createContextKey(
     'B3 TraceId Header Length'
 );
+export const B3_PARENT_SPAN_ID_KEY = createContextKey(
+    'B3 Parent Span Id'
+);
 
 const VALID_SAMPLED_VALUES = new Set([true, 'true', 'True', '1', 1]);
 const VALID_UNSAMPLED_VALUES = new Set([false, 'false', 'False', '0', 0]);
@@ -74,6 +79,14 @@ function getSpanId(carrier: unknown, getter: TextMapGetter): string {
     return '';
 }
 
+function getParentSpanId(carrier: unknown, getter: TextMapGetter): string {
+    const parentSpanId = getHeaderValue(carrier, getter, X_B3_PARENT_SPAN_ID);
+    if (typeof parentSpanId === 'string') {
+        return parentSpanId;
+    }
+    return '';
+}
+
 function getDebug(carrier: unknown, getter: TextMapGetter): string | undefined {
     const debug = getHeaderValue(carrier, getter, X_B3_FLAGS);
     return debug === '1' ? '1' : undefined;
@@ -147,6 +160,9 @@ export class UoaB3Propagator implements TextMapPropagator {
 
         const traceId = getTraceId(carrier, getter);
         const spanId = getSpanId(carrier, getter);
+        const parentSpanId = getParentSpanId(carrier, getter);
+        context = context.setValue(B3_PARENT_SPAN_ID_KEY, parentSpanId);
+
         const traceFlags = getTraceFlags(carrier, getter) as TraceFlags;
         const debug = getDebug(carrier, getter);
         const info = getInfo(carrier, getter);

package/dist/UoaB3Propagator.d.ts

@@ -1,5 +1,7 @@
 /**
- * Class extended from OpenTelemetry B3MultiPropagator so that we can propagate & log the X-B3-Info header
+ * Class extended from OpenTelemetry B3MultiPropagator so that we can:
+ * 1. Propagate & log the X-B3-Info header
+ * 2. Propagate the correct X-B3-ParentSpanId
  *
  * See {@link https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-propagator-b3/src/B3MultiPropagator.ts}
  */
@@ -13,6 +15,7 @@ export declare const X_B3_INFO = "x-b3-info";
 export declare const B3_DEBUG_FLAG_KEY: symbol;
 export declare const B3_INFO_KEY: symbol;
 export declare const B3_TRACE_ID_LENGTH_KEY: symbol;
+export declare const B3_PARENT_SPAN_ID_KEY: symbol;
 export declare class UoaB3Propagator implements TextMapPropagator {
     inject(context: Context, carrier: any, setter: TextMapSetter<any>): void;
     extract(context: Context, carrier: any, getter: TextMapGetter<any>): Context;

package/dist/UoaB3Propagator.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UoaB3Propagator = exports.B3_TRACE_ID_LENGTH_KEY = exports.B3_INFO_KEY = exports.B3_DEBUG_FLAG_KEY = exports.X_B3_INFO = exports.X_B3_FLAGS = exports.X_B3_PARENT_SPAN_ID = exports.X_B3_SAMPLED = exports.X_B3_SPAN_ID = exports.X_B3_TRACE_ID = void 0;
+exports.UoaB3Propagator = exports.B3_PARENT_SPAN_ID_KEY = exports.B3_TRACE_ID_LENGTH_KEY = exports.B3_INFO_KEY = exports.B3_DEBUG_FLAG_KEY = exports.X_B3_INFO = exports.X_B3_FLAGS = exports.X_B3_PARENT_SPAN_ID = exports.X_B3_SAMPLED = exports.X_B3_SPAN_ID = exports.X_B3_TRACE_ID = void 0;
 /**
- * Class extended from OpenTelemetry B3MultiPropagator so that we can propagate & log the X-B3-Info header
+ * Class extended from OpenTelemetry B3MultiPropagator so that we can:
+ * 1. Propagate & log the X-B3-Info header
+ * 2. Propagate the correct X-B3-ParentSpanId
  *
  * See {@link https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-propagator-b3/src/B3MultiPropagator.ts}
  */
@@ -19,6 +21,7 @@ exports.X_B3_INFO = 'x-b3-info';
 exports.B3_DEBUG_FLAG_KEY = (0, api_1.createContextKey)('B3 Debug Flag');
 exports.B3_INFO_KEY = (0, api_1.createContextKey)('B3 Info Header');
 exports.B3_TRACE_ID_LENGTH_KEY = (0, api_1.createContextKey)('B3 TraceId Header Length');
+exports.B3_PARENT_SPAN_ID_KEY = (0, api_1.createContextKey)('B3 Parent Span Id');
 const VALID_SAMPLED_VALUES = new Set([true, 'true', 'True', '1', 1]);
 const VALID_UNSAMPLED_VALUES = new Set([false, 'false', 'False', '0', 0]);
 function parseHeader(header) {
@@ -54,6 +57,13 @@ function getSpanId(carrier, getter) {
     }
     return '';
 }
+function getParentSpanId(carrier, getter) {
+    const parentSpanId = getHeaderValue(carrier, getter, exports.X_B3_PARENT_SPAN_ID);
+    if (typeof parentSpanId === 'string') {
+        return parentSpanId;
+    }
+    return '';
+}
 function getDebug(carrier, getter) {
     const debug = getHeaderValue(carrier, getter, exports.X_B3_FLAGS);
     return debug === '1' ? '1' : undefined;
@@ -114,6 +124,8 @@ class UoaB3Propagator {
         context = context.setValue(exports.B3_TRACE_ID_LENGTH_KEY, traceIdLength);
         const traceId = getTraceId(carrier, getter);
         const spanId = getSpanId(carrier, getter);
+        const parentSpanId = getParentSpanId(carrier, getter);
+        context = context.setValue(exports.B3_PARENT_SPAN_ID_KEY, parentSpanId);
         const traceFlags = getTraceFlags(carrier, getter);
         const debug = getDebug(carrier, getter);
         const info = getInfo(carrier, getter);

package/dist/tracing.js

@@ -12,7 +12,7 @@ const provider = new sdk_trace_node_1.NodeTracerProvider({ sampler: new sdk_trac
 let infoHeader;
 function initializeTracing(serviceName) {
     const options = {
-        url: process.env.zipkinUrl ? process.env.zipkinUrl : 'http://zipkin-uoa-its-nonprod-external-2087446318.ap-southeast-2.elb.amazonaws.com:443/api/v2/spans',
+        url: process.env.zipkinUrl ? process.env.zipkinUrl : 'http://internal-zipkin-uoa-its-nonprod-internal-1407434909.ap-southeast-2.elb.amazonaws.com:443/api/v2/spans',
         serviceName: serviceName
     };
     provider.addSpanProcessor(new sdk_trace_node_1.BatchSpanProcessor(new zipkin_1.ZipkinExporter(options)));

package/dist/zipkin/transform.d.ts

@@ -1,7 +1,7 @@
 /**
  * Copied from https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-exporter-zipkin/src/transform.ts
  *
- * Modified to handle our traceId length being either 16 or 32 characters
+ * Modified to handle our traceId length being either 16 or 32 characters, and to send the correct Parent Span ID
  */
 import * as api from '@opentelemetry/api';
 import { ReadableSpan, TimedEvent } from '@opentelemetry/sdk-trace-base';

package/dist/zipkin/transform.js

@@ -42,7 +42,7 @@ exports._toZipkinAnnotations = exports._toZipkinTags = exports.toZipkinSpan = ex
 /**
  * Copied from https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-exporter-zipkin/src/transform.ts
  *
- * Modified to handle our traceId length being either 16 or 32 characters
+ * Modified to handle our traceId length being either 16 or 32 characters, and to send the correct Parent Span ID
  */
 const api = __importStar(require("@opentelemetry/api"));
 const core_1 = require("@opentelemetry/core");
@@ -55,7 +55,6 @@ const ZIPKIN_SPAN_KIND_MAPPING = {
     [api.SpanKind.CONSUMER]: zipkinTypes.SpanKind.CONSUMER,
     [api.SpanKind.PRODUCER]: zipkinTypes.SpanKind.PRODUCER,
     // When absent, the span is local.
-    //@ts-ignore
     [api.SpanKind.INTERNAL]: undefined,
 };
 exports.defaultStatusCodeTagName = 'otel.status_code';
@@ -67,9 +66,10 @@ exports.defaultStatusErrorTagName = 'error';
 function toZipkinSpan(span, serviceName, statusCodeTagName, statusErrorTagName) {
     const traceIdLength = api_1.context.active().getValue(UoaB3Propagator_1.B3_TRACE_ID_LENGTH_KEY);
     let traceId = span.spanContext().traceId.slice(span.spanContext().traceId.length - traceIdLength);
+    const parentSpanId = api_1.context.active().getValue(UoaB3Propagator_1.B3_PARENT_SPAN_ID_KEY);
     const zipkinSpan = {
         traceId: traceId,
-        parentId: span.parentSpanId,
+        parentId: parentSpanId || span.parentSpanId,
         name: span.name,
         id: span.spanContext().spanId,
         kind: ZIPKIN_SPAN_KIND_MAPPING[span.kind],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uoa/lambda-tracing",
-  "version": "2.0.0-beta.6",
+  "version": "2.0.0",
   "description": "Library for logging & distributed tracing in UoA Lambda projects",
   "repository": {
     "type": "git",

package/tracing.ts

@@ -11,7 +11,7 @@ let infoHeader: string | undefined;
 
 export function initializeTracing(serviceName: string) {
     const options = {
-        url: process.env.zipkinUrl ? process.env.zipkinUrl : 'http://zipkin-uoa-its-nonprod-external-2087446318.ap-southeast-2.elb.amazonaws.com:443/api/v2/spans',
+        url: process.env.zipkinUrl ? process.env.zipkinUrl : 'http://internal-zipkin-uoa-its-nonprod-internal-1407434909.ap-southeast-2.elb.amazonaws.com:443/api/v2/spans',
         serviceName: serviceName
     }
     provider.addSpanProcessor(new BatchSpanProcessor(new ZipkinExporter(options)));

package/zipkin/transform.ts

@@ -17,7 +17,7 @@
 /**
  * Copied from https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-exporter-zipkin/src/transform.ts
  *
- * Modified to handle our traceId length being either 16 or 32 characters
+ * Modified to handle our traceId length being either 16 or 32 characters, and to send the correct Parent Span ID
  */
 
 import * as api from '@opentelemetry/api';
@@ -26,7 +26,7 @@ import { hrTimeToMicroseconds } from '@opentelemetry/core';
 import * as zipkinTypes from './types';
 import { Resource } from '@opentelemetry/resources';
 import {context} from "@opentelemetry/api";
-import {B3_TRACE_ID_LENGTH_KEY} from "../UoaB3Propagator";
+import {B3_PARENT_SPAN_ID_KEY, B3_TRACE_ID_LENGTH_KEY} from "../UoaB3Propagator";
 
 const ZIPKIN_SPAN_KIND_MAPPING = {
     [api.SpanKind.CLIENT]: zipkinTypes.SpanKind.CLIENT,
@@ -34,7 +34,6 @@ const ZIPKIN_SPAN_KIND_MAPPING = {
     [api.SpanKind.CONSUMER]: zipkinTypes.SpanKind.CONSUMER,
     [api.SpanKind.PRODUCER]: zipkinTypes.SpanKind.PRODUCER,
     // When absent, the span is local.
-    //@ts-ignore
     [api.SpanKind.INTERNAL]: undefined,
 };
 
@@ -53,9 +52,10 @@ export function toZipkinSpan(
 ): zipkinTypes.Span {
     const traceIdLength: number = <number>context.active().getValue(B3_TRACE_ID_LENGTH_KEY);
     let traceId = span.spanContext().traceId.slice(span.spanContext().traceId.length - traceIdLength);
+    const parentSpanId = <string>context.active().getValue(B3_PARENT_SPAN_ID_KEY);
     const zipkinSpan: zipkinTypes.Span = {
         traceId: traceId,
-        parentId: span.parentSpanId,
+        parentId: parentSpanId || span.parentSpanId,
         name: span.name,
         id: span.spanContext().spanId,
         kind: ZIPKIN_SPAN_KIND_MAPPING[span.kind],