Skip to main content

Interface: TelemetryOptions

worker.TelemetryOptions

Properties

logging

Optional logging: LogExporterConfig

Control where to send log messages emitted by native code.

Log Forwarding

By default, logs emitted by the native side of the SDK are printed directly to the console, independently of RuntimeOptions.logger. To enable forwarding of those log messages to the TS side logger, add the forward property to the logging object.

For example:

Runtime.install({
logger: new DefaultLogger('INFO'),
telemetryOptions: {
logging: {
filter: { core: 'INFO', other: 'WARN' },
forward: {},
},
},
});

Note that when log forwarding is enabled, all log messages sent to the runtime logger are internally buffered for 100 ms, to allow global sorting of messages from different sources based on their absolute timestamps. This helps reduce incoherencies in the order of messages, notably those emitted through the Workflow Logging API vs those emitted through Core.

However, in some situations, log messages may still appear out of order, e.g. when a Workflow Activation takes longer than 100ms to complete or when log flow exceeds the buffer's capacity (2000 messages).


metrics

Optional metrics: MetricsExporterConfig

Control exporting NativeConnection and Worker metrics.

Turned off by default.


noTemporalPrefixForMetrics

Optional noTemporalPrefixForMetrics: boolean

If set to true, do not prefix metrics with temporal_.

Deprecated

Use metrics.metricPrefix instead


tracing

Optional tracing: unknown

Deprecated

Core SDK tracing is no longer supported. This option is ignored.


tracingFilter

Optional tracingFilter: string

A string in the env filter format specified here: https://docs.rs/tracing-subscriber/0.2.20/tracing_subscriber/struct.EnvFilter.html

Which determines what tracing data is collected in the Core SDK.

Deprecated

Use logging.filter instead