Skip to main content

Class: OpenTelemetryInboundInterceptor

Experimental

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.

This interceptor is experimental and APIs may change without notice.

Implements​

Constructors​

Constructor​

new OpenTelemetryInboundInterceptor(): OpenTelemetryInboundInterceptor

Experimental

Returns​

OpenTelemetryInboundInterceptor

Methods​

execute()​

execute(input, next): Promise<unknown>

Experimental

Called when Workflow execute method is called

Parameters​

input​

WorkflowExecuteInput

next​

OmitLastParam<(input, next) => Promise<unknown>>

Returns​

Promise<unknown>

result of the Workflow execution

Implementation of​

WorkflowInboundCallsInterceptor.execute


handleQuery()​

handleQuery(input, next): Promise<unknown>

Experimental

Called when a Workflow is queried

Parameters​

input​

QueryInput

next​

OmitLastParam<(input, next) => Promise<unknown>>

Returns​

Promise<unknown>

result of the query

Implementation of​

WorkflowInboundCallsInterceptor.handleQuery


handleSignal()​

handleSignal(input, next): Promise<void>

Experimental

Called when signal is delivered to a Workflow execution

Parameters​

input​

SignalInput

next​

OmitLastParam<(input, next) => Promise<void>>

Returns​

Promise<void>

Implementation of​

WorkflowInboundCallsInterceptor.handleSignal


handleUpdate()​

handleUpdate(input, next): Promise<unknown>

Experimental

Called when Update handler is called

Parameters​

input​

UpdateInput

next​

OmitLastParam<(input, next) => Promise<unknown>>

Returns​

Promise<unknown>

result of the Update

Implementation of​

WorkflowInboundCallsInterceptor.handleUpdate


validateUpdate()​

validateUpdate(input, next): void

Experimental

Called when update validator called

Parameters​

input​

UpdateInput

next​

OmitLastParam<(input, next) => void>

Returns​

void

Implementation of​

WorkflowInboundCallsInterceptor.validateUpdate