Class: LangSmithPlugin

langsmith.LangSmithPlugin

Temporal plugin that adds LangSmith observability to a Client + Worker.

Example

import { traceable } from 'langsmith/traceable';
import { LangSmithPlugin } from '@temporalio/langsmith';

const plugin = new LangSmithPlugin({ addTemporalRuns: true });
const worker = await Worker.create({ workflowsPath, taskQueue: 'tq', plugins: [plugin] });

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

Hierarchy

• SimplePlugin

  ↳ LangSmithPlugin

Constructors

constructor

• new LangSmithPlugin(options?): LangSmithPlugin

Parameters

Name	Type
options?	LangSmithPluginOptions

Returns

LangSmithPlugin

Overrides

SimplePlugin.constructor

Properties

name

• Readonly name: string

The name of the plugin

Inherited from

SimplePlugin.name

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

Overrides

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

Overrides

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>

Flush the LangSmith client on worker shutdown so traces that were emitted just before exit are delivered. Wraps the worker run loop and flushes in a finally, swallowing flush errors (shutdown must not fail on telemetry).

Parameters

Name	Type
worker	Worker
next	(worker: Worker) => Promise<void>

Returns

Promise<void>

Overrides

SimplePlugin.runWorker