The Go SDK provides support for distributed tracing through OpenTracing. Tracing allows you to view the call graph of a Workflow along with its Activities and any child Workflows.
Tracing can be configured by providing an opentracing.Tracer implementation in ClientOptions during client instantiation. For more details on how to configure and leverage tracing, see the OpenTracing documentation.
Temporal provides a standard way to propagate a custom context across a Workflow.
You can configure a context propagator in via the ClientOptions.
The context propagator extracts and passes on information present in
workflow.Context objects across the Workflow.
Once a context propagator is configured, you should be able to access the required values in the context objects as you would normally do in Go.
You can see how the Go SDK implements a tracing context propagator.
On the server side, Temporal provides a mechanism for propagating context across Workflow transitions called headers.
Client leverages headers to pass around additional context information.
HeaderReader and HeaderWriter are interfaces that allow reading and writing to the Temporal Server headers.
The SDK includes implementations for these interfaces.
HeaderWriter sets a value for a header.
Headers are held as a map, so setting a value for the same key will overwrite its previous value.
HeaderReader gets a value of a header.
It also can iterate through all headers and execute the provided handler function on each header, so that your code can operate on select headers you need.
You can propagate additional context through Workflow execution by using a context propagator.
A context propagator needs to implement the
ContextPropagator interface that includes the following four methods:
Injectreads select context keys from a Go context.Context object and writes them into the headers using the HeaderWriter interface.
InjectFromWorkflowoperates similar to
Injectbut reads form a workflow.Context object.
Extractpicks select headers and put their values into the context.Context object.
ExtractToWorkflowoperates similar to
Extractbut write to a workflow.Context object.
The tracing context propagator shows a sample implementation of a context propagator.
The context propagation sample configures a custom context propagator and shows context propagation of custom keys across a Workflow and an Activity. It also uses Jaeger for tracing.
Yes. Multiple context propagators help to structure code with each propagator having its own scope of responsibility.
- Passing Context with Temporal by SpiralScout