OtherOptions

OtherOptions = object

Defined in: sdks/js/node-sdk/dist/index.d.ts:140

Properties

disableAutoRegister?

optional disableAutoRegister?: boolean

Defined in: sdks/js/node-sdk/dist/index.d.ts:186

Disable automatic registration when creating a client

loggingLevel?

optional loggingLevel?: LogLevel

Defined in: sdks/js/node-sdk/dist/index.d.ts:148

Logging level. Also the level exported to OTLP when otelEndpoint is set.

nonce?

optional nonce?: bigint

Defined in: sdks/js/node-sdk/dist/index.d.ts:191

The nonce to use when generating an inbox ID (default: undefined = 1)

otelEndpoint?

optional otelEndpoint?: string

Defined in: sdks/js/node-sdk/dist/index.d.ts:164

OTLP endpoint (e.g. "http://collector:4317") for exporting telemetry spans and logs. When set, spans (and tracing events as correlated logs) are exported via OTLP to this endpoint, where a downstream OpenTelemetry Collector can derive metrics from the spans and forward the logs.

Call flushTelemetry on graceful shutdown to flush buffered spans.

otelSampleRatio?

optional otelSampleRatio?: number

Defined in: sdks/js/node-sdk/dist/index.d.ts:168

Fraction of root spans sampled, from 0 to 1.

otelServiceName?

optional otelServiceName?: string

Defined in: sdks/js/node-sdk/dist/index.d.ts:166

Service name attached to exported telemetry.

resourceAttributes?

optional resourceAttributes?: Record<string, string>

Defined in: sdks/js/node-sdk/dist/index.d.ts:174

Resource attributes attached to all exported telemetry spans (e.g. { "service.instance.id": "herald-7", "deployment.environment": "prod" }). Use these to attribute telemetry to its source.

stdoutLoggingLevel?

optional stdoutLoggingLevel?: LogLevel

Defined in: sdks/js/node-sdk/dist/index.d.ts:155

Level for the stdout console layer only. Defaults to loggingLevel. Set to LogLevel.Warn to quiet stdout below the OTLP export level — e.g. so a log shipper does not duplicate logs already exported via OTLP, while OTLP still receives loggingLevel.

structuredLogging?

optional structuredLogging?: boolean

Defined in: sdks/js/node-sdk/dist/index.d.ts:144

Enable structured JSON logging

unstableChangeCallbacks?

optional unstableChangeCallbacks?: object

Defined in: sdks/js/node-sdk/dist/index.d.ts:212

Unstable: notifications for group state changes, for clients that reconcile a group’s appData themselves.

Only appData exists today; callbacks for the other mutable fields will be added as further optional properties. Registered at client creation because the changes they report arrive from the stream and sync paths, where no SDK call is on the stack to carry them.

The appData callback is awaited before message processing continues, so a semantic merge — including republishing via updateAppData — can finish first. It fires for changes this client made as well as remote ones, so the merge must be idempotent.

appData?

optional appData?: (change) => Promise<void>

Parameters

change

AppDataChange

Returns

Promise<void>

waitForRegistrationVisible?

optional waitForRegistrationVisible?: VisibilityConfirmationOptions

Defined in: sdks/js/node-sdk/dist/index.d.ts:197

Options for waiting until client registration is visible on the network.

When set, registerIdentity waits until the backend can read the registration.

workerConfig?

optional workerConfig?: WorkerConfigOptions

Defined in: sdks/js/node-sdk/dist/index.d.ts:182

Tuning for the background worker scheduler (intervals, jitter, per-worker overrides, and disabled workers). All fields are optional; omitting this object preserves the default worker behavior.

Intervals are specified in nanoseconds.