README

Introduction

The temporal/open-telemetry-interceptors package provides OpenTelemetry interceptors for tracing workflows and activities within the Temporal system using the OpenTelemetry SDK.

These interceptors capture and trace various actions and events, such as handling activities, starting workflows, sending signals, and executing workflow events. By integrating OpenTelemetry tracing, you gain visibility into the behavior and performance of your Temporal applications.

Get Started

Installation

Install the package using Composer:

composer require temporal/open-telemetry-interceptors

Basic Setup

Create a Pipeline Provider with Interceptors

use OpenTelemetry\API\Trace\Propagation\TraceContextPropagator;
use OpenTelemetry\SDK\Trace;
use Temporal\OpenTelemetry\Interceptor\OpenTelemetryActivityInboundInterceptor;
use Temporal\OpenTelemetry\Interceptor\OpenTelemetryWorkflowClientCallsInterceptor;
use Temporal\OpenTelemetry\Interceptor\OpenTelemetryWorkflowOutboundRequestInterceptor;
use Temporal\Interceptor\SimplePipelineProvider;

// Create a span processor
$spanProcessor = (new Trace\SpanProcessorFactory())->create(
    (new Trace\ExporterFactory())->create(),
);

// Create a tracer provider
$tracerProvider = new Trace\TracerProvider($spanProcessor);

// Create a tracer which wraps the OpenTelemetry tracer
$tracer = new Temporal\OpenTelemetry\Tracer(
    // Pass a unique name for your application
    $tracerProvider->getTracer('My super app'),
    TraceContextPropagator::getInstance(),
);

// Configure the interceptor pipeline
$provider = new SimplePipelineProvider([
    new OpenTelemetryActivityInboundInterceptor($tracer),
    new OpenTelemetryWorkflowClientCallsInterceptor($tracer),
    new OpenTelemetryWorkflowOutboundRequestInterceptor($tracer),
]);

Apply Interceptors to Workflow Client and Worker

// Add interceptors to the workflow client
$client = new Temporal\Client\WorkflowClient(
    ..., 
    interceptorProvider: $provider
);

// Add interceptors to the worker
$worker = new WorkerFactory(
   ...,
   pipelineProvider: $provider
);

Available Interceptors

This package provides three specialized interceptors:

OpenTelemetryActivityInboundInterceptor

Traces the execution of activities. This interceptor creates spans when an activity is handled.

OpenTelemetryWorkflowClientCallsInterceptor

Focuses on tracing client-side workflow operations. This interceptor creates spans when calling start(), signalWithStart(), or updateWithStart() methods and propagates the context to the workflow execution.

OpenTelemetryWorkflowOutboundRequestInterceptor

Captures outbound requests made by workflows. This includes spans for activities execution, child workflows, timers, signals to external workflows, and other outbound operations. It provides comprehensive tracing of how workflows interact with other components in the system.

Warning

This interceptor operates in blocking mode when sending telemetry, which may impact Workflow Worker bandwidth. Using a local collector is recommended to minimize network latency impact.

temporal / open-telemetry-interceptors

Maintainers

Details