Class: OpenTelemetryPlugin

opentelemetry.OpenTelemetryPlugin

A plugin that adds OpenTelemetry tracing.

Configures Client, Activity, and Workflow interceptors for trace propagation and injects a span exporter sink for Workflow spans.

Plugins is an experimental feature; APIs may change without notice.

Hierarchy

• SimplePlugin

  ↳ OpenTelemetryPlugin

Constructors

constructor

• new OpenTelemetryPlugin(otelOptions): OpenTelemetryPlugin

Parameters

Name	Type
otelOptions	OpenTelemetryPluginOptions

Returns

OpenTelemetryPlugin

Overrides

SimplePlugin.constructor

Properties

name

• Readonly name: string

The name of the plugin

Inherited from

SimplePlugin.name

---

otelOptions

• Readonly otelOptions: OpenTelemetryPluginOptions

Methods

configureBundler

▸ configureBundler(options): BundleOptions

Configures bundler options by merging plugin parameters with existing options.

Parameters

Name	Type	Description
options	BundleOptions	The existing bundle options

Returns

BundleOptions

Modified bundle options with plugin configuration applied

Inherited from

SimplePlugin.configureBundler

---

configureClient

▸ configureClient(options): ClientOptions

Configures client options by merging plugin parameters with existing options.

Parameters

Name	Type	Description
options	ClientOptions	The existing client options

Returns

ClientOptions

Modified client options with plugin configuration applied

Inherited from

SimplePlugin.configureClient

---

configureConnection

▸ configureConnection(options): ConnectionOptions

Configures connection options by merging plugin parameters with existing options. Special handling for function-based API keys.

Parameters

Name	Type	Description
options	ConnectionOptions	The existing connection options

Returns

ConnectionOptions

Modified connection options with plugin configuration applied

Inherited from

SimplePlugin.configureConnection

---

configureNativeConnection

▸ configureNativeConnection(options): NativeConnectionOptions

Configures native connection options by merging plugin parameters with existing options.

Parameters

Name	Type	Description
options	NativeConnectionOptions	The existing native connection options

Returns

NativeConnectionOptions

Modified native connection options with plugin configuration applied

Inherited from

SimplePlugin.configureNativeConnection

---

configureReplayWorker

▸ configureReplayWorker(options): ReplayWorkerOptions

Configures replay worker options by merging plugin parameters with existing options.

Parameters

Name	Type	Description
options	ReplayWorkerOptions	The existing replay worker options

Returns

ReplayWorkerOptions

Modified replay worker options with plugin configuration applied

Overrides

SimplePlugin.configureReplayWorker

---

configureWorker

▸ configureWorker(options): WorkerOptions

Configures worker options by merging plugin parameters with existing options. Activities and nexus services are appended, while other options are replaced.

Parameters

Name	Type	Description
options	WorkerOptions	The existing worker options

Returns

WorkerOptions

Modified worker options with plugin configuration applied

Overrides

SimplePlugin.configureWorker

---

runWorker

▸ runWorker(worker, next): Promise<void>

Runs the worker, optionally wrapping execution in a custom context.

Parameters

Name	Type	Description
worker	Worker	The worker instance to run
next	(w: Worker) => Promise<void>	Function to continue worker execution

Returns

Promise<void>

Promise that resolves when worker execution completes

Inherited from

SimplePlugin.runWorker