feat: Add OTel correlation metadata on emitted logs from Workflow and Activity context loggers (#1565)

Author: mjameswh

.github/workflows/ci.yml

@@ -38,7 +38,7 @@ jobs:
             container: quay.io/pypa/manylinux_2_24_aarch64
             out-file: libtemporal_sdk_typescript_bridge.so
           - platform: macos-x64
-            runner: macos-12
+            runner: macos-13
             target: x86_64-apple-darwin
             out-file: libtemporal_sdk_typescript_bridge.dylib
           - platform: macos-arm
@@ -221,7 +221,7 @@ jobs:
           - platform: linux-arm
             runner: buildjet-4vcpu-ubuntu-2204-arm
           - platform: macos-x64
-            runner: macos-12
+            runner: macos-13
           - platform: macos-arm
             runner: macos-14
           - platform: windows-x64
@@ -336,7 +336,7 @@ jobs:
           - platform: linux-arm
             runner: buildjet-4vcpu-ubuntu-2204-arm
           - platform: macos-x64
-            runner: macos-12
+            runner: macos-13
           - platform: macos-arm
             runner: macos-14
           - platform: windows-x64

packages/core-bridge/ts/index.ts

@@ -107,7 +107,7 @@ export interface ClientOptions {
  * @experimental
  */
 export interface ConsoleLogger {
-  console: {}; // eslint-disable-line @typescript-eslint/ban-types
+  console: {}; // eslint-disable-line @typescript-eslint/no-empty-object-type
 }
 
 /**
@@ -143,7 +143,13 @@ export interface OtelCollectorExporter {
     /**
      * URL of a gRPC OpenTelemetry collector.
      *
-     * @format Starts with "grpc://" or "http://" for an unsecured connection (typical), or "grpcs://" or "https://" for a TLS connection.
+     * Syntax should generally look like `http://server:4317` (the `grpc://` is also fine). Core's OTLP
+     * metric exporter does not support the 'OTLP/HTTP' protocol (e.g. `http://server:4318/v1/metrics`).
+     * For greater flexibility, you may setup an OTel collector running as a sidecar (e.g. to proxy
+     * OTLP/gRPC requests to a remote OTLP/HTTP endpoint).
+     *
+     * @format Starts with "grpc://" or "http://" for an unsecured connection (typical),
+     *         or "grpcs://" or "https://" for a TLS connection.
      * @note The `OTEL_EXPORTER_OTLP_ENDPOINT` environment variable, if set, will override this property.
      */
     url: string;
@@ -278,8 +284,8 @@ export type CompiledTelemetryOptions = {
   logging: {
     filter: string;
   } & (
-    | { console: {} /* eslint-disable-line @typescript-eslint/ban-types */ }
-    | { forward: {} /* eslint-disable-line @typescript-eslint/ban-types */ }
+    | { console: {} /* eslint-disable-line @typescript-eslint/no-empty-object-type */ }
+    | { forward: {} /* eslint-disable-line @typescript-eslint/no-empty-object-type */ }
   );
   metrics?: {
     temporality?: 'cumulative' | 'delta';

packages/interceptors-opentelemetry/src/worker/index.ts

@@ -2,7 +2,14 @@ import * as otel from '@opentelemetry/api';
 import { Resource } from '@opentelemetry/resources';
 import { ReadableSpan, SpanExporter } from '@opentelemetry/sdk-trace-base';
 import { Context as ActivityContext } from '@temporalio/activity';
-import { ActivityExecuteInput, ActivityInboundCallsInterceptor, InjectedSink, Next } from '@temporalio/worker';
+import {
+  ActivityExecuteInput,
+  ActivityInboundCallsInterceptor,
+  ActivityOutboundCallsInterceptor,
+  GetLogAttributesInput,
+  InjectedSink,
+  Next,
+} from '@temporalio/worker';
 import { instrument, extractContextFromHeaders } from '../instrumentation';
 import { OpenTelemetryWorkflowExporter, SerializableSpan, SpanName, SPAN_DELIMITER } from '../workflow';
 
@@ -33,6 +40,33 @@ export class OpenTelemetryActivityInboundInterceptor implements ActivityInboundC
   }
 }
 
+/**
+ * Intercepts calls to emit logs from an Activity.
+ *
+ * Attach OpenTelemetry context tracing attributes to emitted log messages, if appropriate.
+ */
+export class OpenTelemetryActivityOutboundInterceptor implements ActivityOutboundCallsInterceptor {
+  constructor(protected readonly ctx: ActivityContext) {}
+
+  public getLogAttributes(
+    input: GetLogAttributesInput,
+    next: Next<ActivityOutboundCallsInterceptor, 'getLogAttributes'>
+  ): Record<string, unknown> {
+    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);
+    }
+  }
+}
+
 /**
  * Takes an opentelemetry SpanExporter and turns it into an injected Workflow span exporter sink
  */

packages/interceptors-opentelemetry/src/workflow/index.ts

@@ -8,6 +8,7 @@ import {
   ContinueAsNew,
   ContinueAsNewInput,
   DisposeInput,
+  GetLogAttributesInput,
   Next,
   SignalInput,
   SignalWorkflowInput,
@@ -154,6 +155,24 @@ export class OpenTelemetryOutboundInterceptor implements WorkflowOutboundCallsIn
       },
     });
   }
+
+  public getLogAttributes(
+    input: GetLogAttributesInput,
+    next: Next<WorkflowOutboundCallsInterceptor, 'getLogAttributes'>
+  ): Record<string, unknown> {
+    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);
+    }
+  }
 }
 
 export class OpenTelemetryInternalsInterceptor implements WorkflowInternalsInterceptor {