@temporalio/interceptors-opentelemetry 1.17.3 → 1.17.5

package/lib/worker/index.d.ts

@@ -0,0 +1,69 @@
+import * as otel from '@opentelemetry/api';
+import type { Resource } from '@opentelemetry/resources';
+import type { SpanExporter, SpanProcessor } from '@opentelemetry/sdk-trace-base';
+import type * as nexus from 'nexus-rpc';
+import type { Context as ActivityContext } from '@temporalio/activity';
+import type { Next, ActivityInboundCallsInterceptor, ActivityOutboundCallsInterceptor, NexusInboundCallsInterceptor, NexusOutboundCallsInterceptor, NexusStartOperationInput, NexusStartOperationOutput, NexusCancelOperationInput, InjectedSink, GetLogAttributesInput, GetMetricTagsInput, ActivityExecuteInput } from '@temporalio/worker';
+import { type OpenTelemetryWorkflowExporter } from '../workflow/definitions';
+export interface InterceptorOptions {
+    readonly tracer?: otel.Tracer;
+}
+/**
+ * Intercepts calls to start an Activity.
+ *
+ * Wraps the operation in an opentelemetry Span and links it to a parent Span context if one is
+ * provided in the Activity input headers.
+ */
+export declare class OpenTelemetryActivityInboundInterceptor implements ActivityInboundCallsInterceptor {
+    protected readonly ctx: ActivityContext;
+    protected readonly tracer: otel.Tracer;
+    constructor(ctx: ActivityContext, options?: InterceptorOptions);
+    execute(input: ActivityExecuteInput, next: Next<ActivityInboundCallsInterceptor, 'execute'>): Promise<unknown>;
+}
+/**
+ * Intercepts calls to emit logs and metrics from an Activity.
+ *
+ * Attach OpenTelemetry context tracing attributes to emitted log messages and metrics, if appropriate.
+ */
+export declare class OpenTelemetryActivityOutboundInterceptor implements ActivityOutboundCallsInterceptor {
+    protected readonly ctx: ActivityContext;
+    constructor(ctx: ActivityContext);
+    getLogAttributes(input: GetLogAttributesInput, next: Next<ActivityOutboundCallsInterceptor, 'getLogAttributes'>): Record<string, unknown>;
+    getMetricTags(input: GetMetricTagsInput, next: Next<ActivityOutboundCallsInterceptor, 'getMetricTags'>): GetMetricTagsInput;
+}
+/**
+ * Intercepts inbound Nexus Operation calls on the worker.
+ *
+ * Wraps `startOperation` and `cancelOperation` in opentelemetry Spans, linking to a parent Span context
+ * if one is provided in the Nexus request headers.
+ */
+export declare class OpenTelemetryNexusInboundInterceptor implements NexusInboundCallsInterceptor {
+    protected readonly ctx: nexus.OperationContext;
+    protected readonly tracer: otel.Tracer;
+    constructor(ctx: nexus.OperationContext, options?: InterceptorOptions);
+    startOperation(input: NexusStartOperationInput, next: Next<NexusInboundCallsInterceptor, 'startOperation'>): Promise<NexusStartOperationOutput>;
+    cancelOperation(input: NexusCancelOperationInput, next: Next<NexusInboundCallsInterceptor, 'cancelOperation'>): Promise<void>;
+}
+/**
+ * Intercepts outbound calls from a Nexus Operation handler.
+ *
+ * Attaches OpenTelemetry context tracing attributes to emitted log messages and metrics.
+ */
+export declare class OpenTelemetryNexusOutboundInterceptor implements NexusOutboundCallsInterceptor {
+    protected readonly ctx: nexus.OperationContext;
+    constructor(ctx: nexus.OperationContext);
+    getLogAttributes(input: GetLogAttributesInput, next: Next<NexusOutboundCallsInterceptor, 'getLogAttributes'>): Record<string, unknown>;
+    getMetricTags(input: GetMetricTagsInput, next: Next<NexusOutboundCallsInterceptor, 'getMetricTags'>): GetMetricTagsInput;
+}
+/**
+ * Takes an opentelemetry SpanExporter and turns it into an injected Workflow span exporter sink
+ *
+ * @deprecated Do not directly pass a `SpanExporter`. Pass a `SpanProcessor` instead to ensure proper handling of async attributes.
+ */
+export declare function makeWorkflowExporter(spanExporter: SpanExporter, resource: Resource): InjectedSink<OpenTelemetryWorkflowExporter>;
+/**
+ * Takes an opentelemetry SpanProcessor and turns it into an injected Workflow span exporter sink.
+ *
+ * For backward compatibility, passing a `SpanExporter` directly is still supported.
+ */
+export declare function makeWorkflowExporter(spanProcessor: SpanProcessor, resource: Resource): InjectedSink<OpenTelemetryWorkflowExporter>;

package/lib/worker/index.js

@@ -0,0 +1,235 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenTelemetryNexusOutboundInterceptor = exports.OpenTelemetryNexusInboundInterceptor = exports.OpenTelemetryActivityOutboundInterceptor = exports.OpenTelemetryActivityInboundInterceptor = void 0;
+exports.makeWorkflowExporter = makeWorkflowExporter;
+const otel = __importStar(require("@opentelemetry/api"));
+const api_1 = require("@opentelemetry/api");
+const common_1 = require("@temporalio/common");
+const instrumentation_1 = require("../instrumentation");
+const definitions_1 = require("../workflow/definitions");
+/**
+ * Intercepts calls to start an Activity.
+ *
+ * Wraps the operation in an opentelemetry Span and links it to a parent Span context if one is
+ * provided in the Activity input headers.
+ */
+class OpenTelemetryActivityInboundInterceptor {
+    ctx;
+    tracer;
+    constructor(ctx, options) {
+        this.ctx = ctx;
+        this.tracer = options?.tracer ?? otel.trace.getTracer('@temporalio/interceptor-activity');
+    }
+    async execute(input, next) {
+        const context = (0, instrumentation_1.extractContextFromHeaders)(input.headers);
+        const spanName = `${definitions_1.SpanName.ACTIVITY_EXECUTE}${definitions_1.SPAN_DELIMITER}${this.ctx.info.activityType}`;
+        return await (0, instrumentation_1.instrument)({
+            tracer: this.tracer,
+            spanName,
+            fn: (span) => {
+                span.setAttribute(instrumentation_1.ACTIVITY_ID_ATTR_KEY, this.ctx.info.activityId);
+                if (this.ctx.info.inWorkflow) {
+                    span.setAttribute(instrumentation_1.WORKFLOW_ID_ATTR_KEY, this.ctx.info.workflowExecution.workflowId);
+                    span.setAttribute(instrumentation_1.RUN_ID_ATTR_KEY, this.ctx.info.workflowExecution.runId);
+                }
+                return next(input);
+            },
+            context,
+            acceptableErrors: (err) => err instanceof common_1.CompleteAsyncError,
+        });
+    }
+}
+exports.OpenTelemetryActivityInboundInterceptor = OpenTelemetryActivityInboundInterceptor;
+/**
+ * Intercepts calls to emit logs and metrics from an Activity.
+ *
+ * Attach OpenTelemetry context tracing attributes to emitted log messages and metrics, if appropriate.
+ */
+class OpenTelemetryActivityOutboundInterceptor {
+    ctx;
+    constructor(ctx) {
+        this.ctx = ctx;
+    }
+    getLogAttributes(input, next) {
+        const span = otel.trace.getSpan(otel.context.active());
+        const spanContext = span?.spanContext();
+        if (spanContext && otel.isSpanContextValid(spanContext)) {
+            return next({
+                trace_id: spanContext.traceId,
+                span_id: spanContext.spanId,
+                trace_flags: `0${spanContext.traceFlags.toString(16)}`,
+                ...input,
+            });
+        }
+        else {
+            return next(input);
+        }
+    }
+    getMetricTags(input, next) {
+        const span = otel.trace.getSpan(otel.context.active());
+        const spanContext = span?.spanContext();
+        if (spanContext && otel.isSpanContextValid(spanContext)) {
+            return next({
+                trace_id: spanContext.traceId,
+                span_id: spanContext.spanId,
+                trace_flags: `0${spanContext.traceFlags.toString(16)}`,
+                ...input,
+            });
+        }
+        else {
+            return next(input);
+        }
+    }
+}
+exports.OpenTelemetryActivityOutboundInterceptor = OpenTelemetryActivityOutboundInterceptor;
+/**
+ * Intercepts inbound Nexus Operation calls on the worker.
+ *
+ * Wraps `startOperation` and `cancelOperation` in opentelemetry Spans, linking to a parent Span context
+ * if one is provided in the Nexus request headers.
+ */
+class OpenTelemetryNexusInboundInterceptor {
+    ctx;
+    tracer;
+    constructor(ctx, options) {
+        this.ctx = ctx;
+        this.tracer = options?.tracer ?? otel.trace.getTracer('@temporalio/interceptor-nexus');
+    }
+    async startOperation(input, next) {
+        const context = (0, instrumentation_1.extractContextFromNexusHeaders)(input.ctx.headers);
+        const spanName = `${definitions_1.SpanName.NEXUS_START_OPERATION_EXECUTE}${definitions_1.SPAN_DELIMITER}${input.ctx.service}/${input.ctx.operation}`;
+        return await (0, instrumentation_1.instrument)({
+            tracer: this.tracer,
+            spanName,
+            fn: (span) => {
+                span.setAttribute(instrumentation_1.NEXUS_SERVICE_ATTR_KEY, input.ctx.service);
+                span.setAttribute(instrumentation_1.NEXUS_OPERATION_ATTR_KEY, input.ctx.operation);
+                return next(input);
+            },
+            context,
+        });
+    }
+    async cancelOperation(input, next) {
+        const context = (0, instrumentation_1.extractContextFromNexusHeaders)(input.ctx.headers);
+        const spanName = `${definitions_1.SpanName.NEXUS_CANCEL_OPERATION_EXECUTE}${definitions_1.SPAN_DELIMITER}${input.ctx.service}/${input.ctx.operation}`;
+        return await (0, instrumentation_1.instrument)({
+            tracer: this.tracer,
+            spanName,
+            fn: (span) => {
+                span.setAttribute(instrumentation_1.NEXUS_SERVICE_ATTR_KEY, input.ctx.service);
+                span.setAttribute(instrumentation_1.NEXUS_OPERATION_ATTR_KEY, input.ctx.operation);
+                return next(input);
+            },
+            context,
+        });
+    }
+}
+exports.OpenTelemetryNexusInboundInterceptor = OpenTelemetryNexusInboundInterceptor;
+/**
+ * Intercepts outbound calls from a Nexus Operation handler.
+ *
+ * Attaches OpenTelemetry context tracing attributes to emitted log messages and metrics.
+ */
+class OpenTelemetryNexusOutboundInterceptor {
+    ctx;
+    constructor(ctx) {
+        this.ctx = ctx;
+    }
+    getLogAttributes(input, next) {
+        const span = otel.trace.getSpan(otel.context.active());
+        const spanContext = span?.spanContext();
+        if (spanContext && otel.isSpanContextValid(spanContext)) {
+            return next({
+                trace_id: spanContext.traceId,
+                span_id: spanContext.spanId,
+                trace_flags: `0${spanContext.traceFlags.toString(16)}`,
+                ...input,
+            });
+        }
+        else {
+            return next(input);
+        }
+    }
+    getMetricTags(input, next) {
+        const span = otel.trace.getSpan(otel.context.active());
+        const spanContext = span?.spanContext();
+        if (spanContext && otel.isSpanContextValid(spanContext)) {
+            return next({
+                trace_id: spanContext.traceId,
+                span_id: spanContext.spanId,
+                trace_flags: `0${spanContext.traceFlags.toString(16)}`,
+                ...input,
+            });
+        }
+        else {
+            return next(input);
+        }
+    }
+}
+exports.OpenTelemetryNexusOutboundInterceptor = OpenTelemetryNexusOutboundInterceptor;
+function makeWorkflowExporter(processorOrExporter, resource) {
+    const givenSpanProcessor = isSpanProcessor(processorOrExporter);
+    return {
+        export: {
+            fn: (info, spanData) => {
+                const spans = spanData.map((serialized) => {
+                    Object.assign(serialized.attributes, info);
+                    // Spans are copied over from the isolate and are converted to ReadableSpan instances
+                    return extractReadableSpan(serialized, resource);
+                });
+                if (givenSpanProcessor) {
+                    spans.forEach((span) => processorOrExporter.onEnd(span));
+                }
+                else {
+                    // Ignore the export result for simplicity
+                    processorOrExporter.export(spans, () => undefined);
+                }
+            },
+        },
+    };
+}
+function isSpanProcessor(obj) {
+    return 'onEnd' in obj && typeof obj.onEnd === 'function';
+}
+/**
+ * Deserialize a serialized span created by the Workflow isolate
+ */
+function extractReadableSpan(serializable, resource) {
+    const { spanContext: { traceState, ...restSpanContext }, ...rest } = serializable;
+    const spanContext = {
+        // Reconstruct the TraceState from the serialized string.
+        traceState: traceState ? (0, api_1.createTraceState)(traceState) : undefined,
+        ...restSpanContext,
+    };
+    return {
+        spanContext() {
+            return spanContext;
+        },
+        resource,
+        ...rest,
+    };
+}
+//# sourceMappingURL=index.js.map

package/lib/worker/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/worker/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AA+OA,oDAwBC;AAvQD,yDAA2C;AAC3C,4CAAsD;AAKtD,+CAAwD;AAexD,wDAS4B;AAC5B,yDAKiC;AAMjC;;;;;GAKG;AACH,MAAa,uCAAuC;IAI7B;IAHF,MAAM,CAAc;IAEvC,YACqB,GAAoB,EACvC,OAA4B;QADT,QAAG,GAAH,GAAG,CAAiB;QAGvC,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,kCAAkC,CAAC,CAAC;IAC5F,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,KAA2B,EAAE,IAAsD;QAC/F,MAAM,OAAO,GAAG,IAAA,2CAAyB,EAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACzD,MAAM,QAAQ,GAAG,GAAG,sBAAQ,CAAC,gBAAgB,GAAG,4BAAc,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;QAC9F,OAAO,MAAM,IAAA,4BAAU,EAAC;YACtB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,QAAQ;YACR,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;gBACX,IAAI,CAAC,YAAY,CAAC,sCAAoB,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBAClE,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;oBAC7B,IAAI,CAAC,YAAY,CAAC,sCAAoB,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAkB,CAAC,UAAU,CAAC,CAAC;oBACrF,IAAI,CAAC,YAAY,CAAC,iCAAe,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAkB,CAAC,KAAK,CAAC,CAAC;gBAC7E,CAAC;gBACD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;YACrB,CAAC;YACD,OAAO;YACP,gBAAgB,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,YAAY,2BAAkB;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA5BD,0FA4BC;AAED;;;;GAIG;AACH,MAAa,wCAAwC;IACpB;IAA/B,YAA+B,GAAoB;QAApB,QAAG,GAAH,GAAG,CAAiB;IAAG,CAAC;IAEhD,gBAAgB,CACrB,KAA4B,EAC5B,IAAgE;QAEhE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QACvD,MAAM,WAAW,GAAG,IAAI,EAAE,WAAW,EAAE,CAAC;QACxC,IAAI,WAAW,IAAI,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC;YACxD,OAAO,IAAI,CAAC;gBACV,QAAQ,EAAE,WAAW,CAAC,OAAO;gBAC7B,OAAO,EAAE,WAAW,CAAC,MAAM;gBAC3B,WAAW,EAAE,IAAI,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;gBACtD,GAAG,KAAK;aACT,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IAEM,aAAa,CAClB,KAAyB,EACzB,IAA6D;QAE7D,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QACvD,MAAM,WAAW,GAAG,IAAI,EAAE,WAAW,EAAE,CAAC;QACxC,IAAI,WAAW,IAAI,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC;YACxD,OAAO,IAAI,CAAC;gBACV,QAAQ,EAAE,WAAW,CAAC,OAAO;gBAC7B,OAAO,EAAE,WAAW,CAAC,MAAM;gBAC3B,WAAW,EAAE,IAAI,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;gBACtD,GAAG,KAAK;aACT,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;CACF;AAtCD,4FAsCC;AAED;;;;;GAKG;AACH,MAAa,oCAAoC;IAI1B;IAHF,MAAM,CAAc;IAEvC,YACqB,GAA2B,EAC9C,OAA4B;QADT,QAAG,GAAH,GAAG,CAAwB;QAG9C,IAAI,CAAC,MAAM,GAAG,OAAO,EAAE,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,+BAA+B,CAAC,CAAC;IACzF,CAAC;IAED,KAAK,CAAC,cAAc,CAClB,KAA+B,EAC/B,IAA0D;QAE1D,MAAM,OAAO,GAAG,IAAA,gDAA8B,EAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAClE,MAAM,QAAQ,GAAG,GAAG,sBAAQ,CAAC,6BAA6B,GAAG,4BAAc,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,IAAI,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC;QACzH,OAAO,MAAM,IAAA,4BAAU,EAAC;YACtB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,QAAQ;YACR,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;gBACX,IAAI,CAAC,YAAY,CAAC,wCAAsB,EAAE,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBAC7D,IAAI,CAAC,YAAY,CAAC,0CAAwB,EAAE,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBACjE,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;YACrB,CAAC;YACD,OAAO;SACR,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,KAAgC,EAChC,IAA2D;QAE3D,MAAM,OAAO,GAAG,IAAA,gDAA8B,EAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAClE,MAAM,QAAQ,GAAG,GAAG,sBAAQ,CAAC,8BAA8B,GAAG,4BAAc,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,IAAI,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC;QAC1H,OAAO,MAAM,IAAA,4BAAU,EAAC;YACtB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,QAAQ;YACR,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE;gBACX,IAAI,CAAC,YAAY,CAAC,wCAAsB,EAAE,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBAC7D,IAAI,CAAC,YAAY,CAAC,0CAAwB,EAAE,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBACjE,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;YACrB,CAAC;YACD,OAAO;SACR,CAAC,CAAC;IACL,CAAC;CACF;AA7CD,oFA6CC;AAED;;;;GAIG;AACH,MAAa,qCAAqC;IACjB;IAA/B,YAA+B,GAA2B;QAA3B,QAAG,GAAH,GAAG,CAAwB;IAAG,CAAC;IAEvD,gBAAgB,CACrB,KAA4B,EAC5B,IAA6D;QAE7D,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QACvD,MAAM,WAAW,GAAG,IAAI,EAAE,WAAW,EAAE,CAAC;QACxC,IAAI,WAAW,IAAI,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC;YACxD,OAAO,IAAI,CAAC;gBACV,QAAQ,EAAE,WAAW,CAAC,OAAO;gBAC7B,OAAO,EAAE,WAAW,CAAC,MAAM;gBAC3B,WAAW,EAAE,IAAI,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;gBACtD,GAAG,KAAK;aACT,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IAEM,aAAa,CAClB,KAAyB,EACzB,IAA0D;QAE1D,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QACvD,MAAM,WAAW,GAAG,IAAI,EAAE,WAAW,EAAE,CAAC;QACxC,IAAI,WAAW,IAAI,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC;YACxD,OAAO,IAAI,CAAC;gBACV,QAAQ,EAAE,WAAW,CAAC,OAAO;gBAC7B,OAAO,EAAE,WAAW,CAAC,MAAM;gBAC3B,WAAW,EAAE,IAAI,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;gBACtD,GAAG,KAAK;aACT,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;CACF;AAtCD,sFAsCC;AAoBD,SAAgB,oBAAoB,CAClC,mBAAiD,EACjD,QAAkB;IAElB,MAAM,kBAAkB,GAAG,eAAe,CAAC,mBAAmB,CAAC,CAAC;IAEhE,OAAO;QACL,MAAM,EAAE;YACN,EAAE,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE;gBACrB,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;oBACxC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;oBAC3C,qFAAqF;oBACrF,OAAO,mBAAmB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;gBACnD,CAAC,CAAC,CAAC;gBAEH,IAAI,kBAAkB,EAAE,CAAC;oBACvB,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC3D,CAAC;qBAAM,CAAC;oBACN,0CAA0C;oBAC1C,mBAAmB,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;gBACrD,CAAC;YACH,CAAC;SACF;KACF,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,GAAiC;IACxD,OAAO,OAAO,IAAI,GAAG,IAAI,OAAO,GAAG,CAAC,KAAK,KAAK,UAAU,CAAC;AAC3D,CAAC;AAED;;GAEG;AACH,SAAS,mBAAmB,CAAC,YAA8B,EAAE,QAAkB;IAC7E,MAAM,EACJ,WAAW,EAAE,EAAE,UAAU,EAAE,GAAG,eAAe,EAAE,EAC/C,GAAG,IAAI,EACR,GAAG,YAAY,CAAC;IACjB,MAAM,WAAW,GAAqB;QACpC,yDAAyD;QACzD,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,IAAA,sBAAgB,EAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;QACjE,GAAG,eAAe;KACnB,CAAC;IACF,OAAO;QACL,WAAW;YACT,OAAO,WAAW,CAAC;QACrB,CAAC;QACD,QAAQ;QACR,GAAG,IAAI;KACR,CAAC;AACJ,CAAC"}

package/lib/workflow/context-manager.d.ts

@@ -0,0 +1,10 @@
+import { type AsyncLocalStorage } from 'async_hooks';
+import * as otel from '@opentelemetry/api';
+export declare class ContextManager implements otel.ContextManager {
+    protected storage: AsyncLocalStorage<otel.Context>;
+    active(): otel.Context;
+    bind<T>(context: otel.Context, target: T): T;
+    enable(): this;
+    disable(): this;
+    with<A extends unknown[], F extends (...args: A) => ReturnType<F>>(context: otel.Context, fn: F, thisArg?: ThisParameterType<F>, ...args: A): ReturnType<F>;
+}

package/lib/workflow/context-manager.js

@@ -0,0 +1,67 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContextManager = void 0;
+const otel = __importStar(require("@opentelemetry/api"));
+class ContextManager {
+    // The workflow sandbox provides AsyncLocalStorage through globalThis.
+    storage = new globalThis.AsyncLocalStorage();
+    active() {
+        return this.storage.getStore() || otel.ROOT_CONTEXT;
+    }
+    bind(context, target) {
+        if (typeof target !== 'function') {
+            throw new TypeError(`Only function binding is supported, got ${typeof target}`);
+        }
+        // Stolen from https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-context-async-hooks/src/AbstractAsyncHooksContextManager.ts
+        const contextWrapper = (...args) => {
+            return this.with(context, () => target.apply(this, args));
+        };
+        Object.defineProperty(contextWrapper, 'length', {
+            enumerable: false,
+            configurable: true,
+            writable: false,
+            value: target.length,
+        });
+        /**
+         * It isn't possible to tell Typescript that contextWrapper is the same as T
+         * so we forced to cast as any here.
+         */
+        return contextWrapper;
+    }
+    enable() {
+        return this;
+    }
+    disable() {
+        this.storage.disable();
+        return this;
+    }
+    with(context, fn, thisArg, ...args) {
+        const cb = thisArg == null ? fn : fn.bind(thisArg);
+        return this.storage.run(context, cb, ...args);
+    }
+}
+exports.ContextManager = ContextManager;
+//# sourceMappingURL=context-manager.js.map

package/lib/workflow/context-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context-manager.js","sourceRoot":"","sources":["../../src/workflow/context-manager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,yDAA2C;AAE3C,MAAa,cAAc;IACzB,sEAAsE;IAC5D,OAAO,GAAoC,IAAK,UAAkB,CAAC,iBAAiB,EAAE,CAAC;IAEjG,MAAM;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,IAAI,CAAC,YAAY,CAAC;IACtD,CAAC;IAED,IAAI,CAAI,OAAqB,EAAE,MAAS;QACtC,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;YACjC,MAAM,IAAI,SAAS,CAAC,2CAA2C,OAAO,MAAM,EAAE,CAAC,CAAC;QAClF,CAAC;QAED,8JAA8J;QAC9J,MAAM,cAAc,GAAG,CAAC,GAAG,IAAe,EAAE,EAAE;YAC5C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QAC5D,CAAC,CAAC;QACF,MAAM,CAAC,cAAc,CAAC,cAAc,EAAE,QAAQ,EAAE;YAC9C,UAAU,EAAE,KAAK;YACjB,YAAY,EAAE,IAAI;YAClB,QAAQ,EAAE,KAAK;YACf,KAAK,EAAE,MAAM,CAAC,MAAM;SACrB,CAAC,CAAC;QACH;;;WAGG;QAEH,OAAO,cAAqB,CAAC;IAC/B,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO;QACL,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CACF,OAAqB,EACrB,EAAK,EACL,OAA8B,EAC9B,GAAG,IAAO;QAEV,MAAM,EAAE,GAAG,OAAO,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC;IAChD,CAAC;CACF;AAjDD,wCAiDC"}

package/lib/workflow/definitions.d.ts

@@ -0,0 +1,127 @@
+import type * as otel from '@opentelemetry/api';
+import type * as tracing from '@opentelemetry/sdk-trace-base';
+import type { InstrumentationLibrary } from '@opentelemetry/core';
+import type { Sink, Sinks } from '@temporalio/workflow';
+/**
+ * Serializable version of SpanContext where traceState is converted to a string.
+ */
+export type SerializableSpanContext = Omit<otel.SpanContext, 'traceState'> & {
+    traceState?: string;
+};
+/**
+ * Serializable version of the opentelemetry Span for cross isolate copying
+ */
+export interface SerializableSpan {
+    readonly name: string;
+    readonly kind: otel.SpanKind;
+    readonly spanContext: SerializableSpanContext;
+    readonly parentSpanId?: string;
+    readonly startTime: otel.HrTime;
+    readonly endTime: otel.HrTime;
+    readonly status: otel.SpanStatus;
+    readonly attributes: otel.Attributes;
+    readonly links: otel.Link[];
+    readonly events: tracing.TimedEvent[];
+    readonly duration: otel.HrTime;
+    readonly ended: boolean;
+    readonly droppedAttributesCount: number;
+    readonly droppedLinksCount: number;
+    readonly droppedEventsCount: number;
+    readonly instrumentationLibrary: InstrumentationLibrary;
+}
+export interface OpenTelemetryWorkflowExporter extends Sink {
+    export(span: SerializableSpan[]): void;
+}
+/**
+ * Required external dependencies for Workflow interceptor to export spans
+ */
+export interface OpenTelemetrySinks extends Sinks {
+    exporter: OpenTelemetryWorkflowExporter;
+}
+export declare enum SpanName {
+    /**
+     * Workflow is scheduled by a client
+     */
+    WORKFLOW_START = "StartWorkflow",
+    /**
+     * Workflow is signalled
+     */
+    WORKFLOW_SIGNAL = "SignalWorkflow",
+    /**
+     * Workflow is client calls signalWithStart
+     */
+    WORKFLOW_SIGNAL_WITH_START = "SignalWithStartWorkflow",
+    /**
+     * Workflow is queried
+     */
+    WORKFLOW_QUERY = "QueryWorkflow",
+    /**
+     * Workflow update is started by client
+     */
+    WORKFLOW_START_UPDATE = "StartWorkflowUpdate",
+    /**
+     * Workflow is started with an update
+     */
+    WORKFLOW_UPDATE_WITH_START = "UpdateWithStartWorkflow",
+    /**
+     * Workflow handles an incoming signal
+     */
+    WORKFLOW_HANDLE_SIGNAL = "HandleSignal",
+    /**
+     * Workflow handles an incoming query
+     */
+    WORKFLOW_HANDLE_QUERY = "HandleQuery",
+    /**
+     * Workflow handles an incoming update
+     */
+    WORKFLOW_HANDLE_UPDATE = "HandleUpdate",
+    /**
+     * Workflow validates an incoming update
+     */
+    WORKFLOW_VALIDATE_UPDATE = "ValidateUpdate",
+    /**
+     * Workflow is terminated
+     */
+    WORKFLOW_TERMINATE = "TerminateWorkflow",
+    /**
+     * Workflow is cancelled
+     */
+    WORKFLOW_CANCEL = "CancelWorkflow",
+    /**
+     * Workflow is described
+     */
+    WORKFLOW_DESCRIBE = "DescribeWorkflow",
+    /**
+     * Workflow run is executing
+     */
+    WORKFLOW_EXECUTE = "RunWorkflow",
+    /**
+     * Child Workflow is started (by parent Workflow)
+     */
+    CHILD_WORKFLOW_START = "StartChildWorkflow",
+    /**
+     * Activity is scheduled by a Workflow
+     */
+    ACTIVITY_START = "StartActivity",
+    /**
+     * Activity is executing
+     */
+    ACTIVITY_EXECUTE = "RunActivity",
+    /**
+     * Workflow is continuing as new
+     */
+    CONTINUE_AS_NEW = "ContinueAsNew",
+    /**
+     * Nexus operation is started
+     */
+    NEXUS_OPERATION_START = "StartNexusOperation",
+    /**
+     * Nexus operation is executing
+     */
+    NEXUS_START_OPERATION_EXECUTE = "RunStartNexusOperation",
+    /**
+     * Nexus operation cancel is executing
+     */
+    NEXUS_CANCEL_OPERATION_EXECUTE = "RunCancelNexusOperation"
+}
+export declare const SPAN_DELIMITER = ":";

package/lib/workflow/definitions.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SPAN_DELIMITER = exports.SpanName = void 0;
+var SpanName;
+(function (SpanName) {
+    /**
+     * Workflow is scheduled by a client
+     */
+    SpanName["WORKFLOW_START"] = "StartWorkflow";
+    /**
+     * Workflow is signalled
+     */
+    SpanName["WORKFLOW_SIGNAL"] = "SignalWorkflow";
+    /**
+     * Workflow is client calls signalWithStart
+     */
+    SpanName["WORKFLOW_SIGNAL_WITH_START"] = "SignalWithStartWorkflow";
+    /**
+     * Workflow is queried
+     */
+    SpanName["WORKFLOW_QUERY"] = "QueryWorkflow";
+    /**
+     * Workflow update is started by client
+     */
+    SpanName["WORKFLOW_START_UPDATE"] = "StartWorkflowUpdate";
+    /**
+     * Workflow is started with an update
+     */
+    SpanName["WORKFLOW_UPDATE_WITH_START"] = "UpdateWithStartWorkflow";
+    /**
+     * Workflow handles an incoming signal
+     */
+    SpanName["WORKFLOW_HANDLE_SIGNAL"] = "HandleSignal";
+    /**
+     * Workflow handles an incoming query
+     */
+    SpanName["WORKFLOW_HANDLE_QUERY"] = "HandleQuery";
+    /**
+     * Workflow handles an incoming update
+     */
+    SpanName["WORKFLOW_HANDLE_UPDATE"] = "HandleUpdate";
+    /**
+     * Workflow validates an incoming update
+     */
+    SpanName["WORKFLOW_VALIDATE_UPDATE"] = "ValidateUpdate";
+    /**
+     * Workflow is terminated
+     */
+    SpanName["WORKFLOW_TERMINATE"] = "TerminateWorkflow";
+    /**
+     * Workflow is cancelled
+     */
+    SpanName["WORKFLOW_CANCEL"] = "CancelWorkflow";
+    /**
+     * Workflow is described
+     */
+    SpanName["WORKFLOW_DESCRIBE"] = "DescribeWorkflow";
+    /**
+     * Workflow run is executing
+     */
+    SpanName["WORKFLOW_EXECUTE"] = "RunWorkflow";
+    /**
+     * Child Workflow is started (by parent Workflow)
+     */
+    SpanName["CHILD_WORKFLOW_START"] = "StartChildWorkflow";
+    /**
+     * Activity is scheduled by a Workflow
+     */
+    SpanName["ACTIVITY_START"] = "StartActivity";
+    /**
+     * Activity is executing
+     */
+    SpanName["ACTIVITY_EXECUTE"] = "RunActivity";
+    /**
+     * Workflow is continuing as new
+     */
+    SpanName["CONTINUE_AS_NEW"] = "ContinueAsNew";
+    /**
+     * Nexus operation is started
+     */
+    SpanName["NEXUS_OPERATION_START"] = "StartNexusOperation";
+    /**
+     * Nexus operation is executing
+     */
+    SpanName["NEXUS_START_OPERATION_EXECUTE"] = "RunStartNexusOperation";
+    /**
+     * Nexus operation cancel is executing
+     */
+    SpanName["NEXUS_CANCEL_OPERATION_EXECUTE"] = "RunCancelNexusOperation";
+})(SpanName || (exports.SpanName = SpanName = {}));
+exports.SPAN_DELIMITER = ':';
+//# sourceMappingURL=definitions.js.map

package/lib/workflow/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/workflow/definitions.ts"],"names":[],"mappings":";;;AA6CA,IAAY,QAkGX;AAlGD,WAAY,QAAQ;IAClB;;OAEG;IACH,4CAAgC,CAAA;IAEhC;;OAEG;IACH,8CAAkC,CAAA;IAElC;;OAEG;IACH,kEAAsD,CAAA;IAEtD;;OAEG;IACH,4CAAgC,CAAA;IAEhC;;OAEG;IACH,yDAA6C,CAAA;IAE7C;;OAEG;IACH,kEAAsD,CAAA;IAEtD;;OAEG;IACH,mDAAuC,CAAA;IAEvC;;OAEG;IACH,iDAAqC,CAAA;IAErC;;OAEG;IACH,mDAAuC,CAAA;IAEvC;;OAEG;IACH,uDAA2C,CAAA;IAE3C;;OAEG;IACH,oDAAwC,CAAA;IAExC;;OAEG;IACH,8CAAkC,CAAA;IAElC;;OAEG;IACH,kDAAsC,CAAA;IAEtC;;OAEG;IACH,4CAAgC,CAAA;IAChC;;OAEG;IACH,uDAA2C,CAAA;IAC3C;;OAEG;IACH,4CAAgC,CAAA;IAChC;;OAEG;IACH,4CAAgC,CAAA;IAChC;;OAEG;IACH,6CAAiC,CAAA;IACjC;;OAEG;IACH,yDAA6C,CAAA;IAC7C;;OAEG;IACH,oEAAwD,CAAA;IACxD;;OAEG;IACH,sEAA0D,CAAA;AAC5D,CAAC,EAlGW,QAAQ,wBAAR,QAAQ,QAkGnB;AAEY,QAAA,cAAc,GAAG,GAAG,CAAC"}

package/lib/workflow/index.d.ts

@@ -0,0 +1,41 @@
+import './runtime';
+import * as otel from '@opentelemetry/api';
+import type { ActivityInput, ContinueAsNewInput, DisposeInput, GetLogAttributesInput, GetMetricTagsInput, LocalActivityInput, Next, QueryInput, SignalInput, SignalWorkflowInput, StartChildWorkflowExecutionInput, UpdateInput, WorkflowExecuteInput, WorkflowInboundCallsInterceptor, WorkflowInternalsInterceptor, WorkflowOutboundCallsInterceptor, StartNexusOperationInput, StartNexusOperationOutput } from '@temporalio/workflow';
+export * from './definitions';
+/**
+ * Intercepts calls to run a Workflow
+ *
+ * Wraps the operation in an opentelemetry Span and links it to a parent Span context if one is
+ * provided in the Workflow input headers.
+ *
+ * `@temporalio/workflow` must be provided by host package in order to function.
+ */
+export declare class OpenTelemetryInboundInterceptor implements WorkflowInboundCallsInterceptor {
+    protected readonly tracer: otel.Tracer;
+    execute(input: WorkflowExecuteInput, next: Next<WorkflowInboundCallsInterceptor, 'execute'>): Promise<unknown>;
+    handleSignal(input: SignalInput, next: Next<WorkflowInboundCallsInterceptor, 'handleSignal'>): Promise<void>;
+    handleUpdate(input: UpdateInput, next: Next<WorkflowInboundCallsInterceptor, 'handleUpdate'>): Promise<unknown>;
+    validateUpdate(input: UpdateInput, next: Next<WorkflowInboundCallsInterceptor, 'validateUpdate'>): void;
+    handleQuery(input: QueryInput, next: Next<WorkflowInboundCallsInterceptor, 'handleQuery'>): Promise<unknown>;
+}
+/**
+ * Intercepts outbound calls to schedule an Activity
+ *
+ * Wraps the operation in an opentelemetry Span and passes it to the Activity via headers.
+ *
+ * `@temporalio/workflow` must be provided by host package in order to function.
+ */
+export declare class OpenTelemetryOutboundInterceptor implements WorkflowOutboundCallsInterceptor {
+    protected readonly tracer: otel.Tracer;
+    scheduleActivity(input: ActivityInput, next: Next<WorkflowOutboundCallsInterceptor, 'scheduleActivity'>): Promise<unknown>;
+    scheduleLocalActivity(input: LocalActivityInput, next: Next<WorkflowOutboundCallsInterceptor, 'scheduleLocalActivity'>): Promise<unknown>;
+    startNexusOperation(input: StartNexusOperationInput, next: Next<WorkflowOutboundCallsInterceptor, 'startNexusOperation'>): Promise<StartNexusOperationOutput>;
+    startChildWorkflowExecution(input: StartChildWorkflowExecutionInput, next: Next<WorkflowOutboundCallsInterceptor, 'startChildWorkflowExecution'>): Promise<[Promise<string>, Promise<unknown>]>;
+    continueAsNew(input: ContinueAsNewInput, next: Next<WorkflowOutboundCallsInterceptor, 'continueAsNew'>): Promise<never>;
+    signalWorkflow(input: SignalWorkflowInput, next: Next<WorkflowOutboundCallsInterceptor, 'signalWorkflow'>): Promise<void>;
+    getLogAttributes(input: GetLogAttributesInput, next: Next<WorkflowOutboundCallsInterceptor, 'getLogAttributes'>): Record<string, unknown>;
+    getMetricTags(input: GetMetricTagsInput, next: Next<WorkflowOutboundCallsInterceptor, 'getMetricTags'>): GetMetricTagsInput;
+}
+export declare class OpenTelemetryInternalsInterceptor implements WorkflowInternalsInterceptor {
+    dispose(input: DisposeInput, next: Next<WorkflowInternalsInterceptor, 'dispose'>): Promise<void>;
+}