temporalio.contrib.opentelemetry.TracingInterceptor

class documentation

class TracingInterceptor(temporalio.client.Interceptor, temporalio.worker.Interceptor): (source)

Constructor: TracingInterceptor(tracer)

View In Hierarchy

Interceptor that supports client and worker OpenTelemetry span creation and propagation.

This should be created and used for interceptors on the temporalio.client.Client.connect call to apply to all client calls and worker calls using that client. To only apply to workers, set as worker creation option instead of in client.

To customize the header key, text map propagator, or payload converter, a subclass of this and TracingWorkflowInboundInterceptor should be created. In addition to customizing those attributes, the subclass of this class should return the workflow interceptor subclass from workflow_interceptor_class. That subclass should also set the custom attributes desired.

Method __init__ Initialize a OpenTelemetry tracing interceptor.
Method intercept_activity Implementation of temporalio.worker.Interceptor.intercept_activity.
Method intercept_client Implementation of temporalio.client.Interceptor.intercept_client.
Method workflow_interceptor_class Implementation of temporalio.worker.Interceptor.workflow_interceptor_class.
Instance Variable header_key Undocumented
Instance Variable payload_converter Undocumented
Instance Variable text_map_propagator Undocumented
Instance Variable tracer Undocumented
Method _completed_workflow_span Undocumented
Method _context_from_headers Undocumented
Method _context_to_headers Undocumented
Method _start_as_current_span Undocumented
def __init__(self, tracer: Optional[opentelemetry.trace.Tracer] = None): (source)

Initialize a OpenTelemetry tracing interceptor.

Parameters
tracer:Optional[opentelemetry.trace.Tracer]The tracer to use. Defaults to opentelemetry.trace.get_tracer.
def intercept_activity(self, next: temporalio.worker.ActivityInboundInterceptor) -> temporalio.worker.ActivityInboundInterceptor: (source)
overrides temporalio.worker.Interceptor.intercept_activity
def intercept_client(self, next: temporalio.client.OutboundInterceptor) -> temporalio.client.OutboundInterceptor: (source)
overrides temporalio.client.Interceptor.intercept_client
def workflow_interceptor_class(self, input: temporalio.worker.WorkflowInterceptorClassInput) -> Type[TracingWorkflowInboundInterceptor]: (source)
overrides temporalio.worker.Interceptor.workflow_interceptor_class
header_key: str = (source)

Undocumented

payload_converter = (source)

Undocumented

text_map_propagator: opentelemetry.propagators.textmap.TextMapPropagator = (source)

Undocumented

tracer = (source)

Undocumented

def _completed_workflow_span(self, params: _CompletedWorkflowSpanParams) -> _CarrierDict: (source)

Undocumented

def _context_from_headers(self, headers: Mapping[str, temporalio.api.common.v1.Payload]) -> Optional[opentelemetry.context.context.Context]: (source)

Undocumented

def _context_to_headers(self, headers: Mapping[str, temporalio.api.common.v1.Payload]) -> Mapping[str, temporalio.api.common.v1.Payload]: (source)

Undocumented

@contextmanager
def _start_as_current_span(self, name: str, *, attributes: opentelemetry.util.types.Attributes, input: Optional[_InputWithHeaders] = None, kind: opentelemetry.trace.SpanKind) -> Iterator[None]: (source)

Undocumented