Skip to main content

EventEmitter

A typed event emitter. Handlers may be sync or async; async rejections and thrown errors are caught and logged rather than propagated. Parameterize with an event-to-args map for type-safe EventEmitter.on/EventEmitter.emit.

Constructor

closeEmitter

Close the emitter: drop all handlers and stop emitting. Waits up to 2 seconds for in-flight async handlers to settle before returning.

emit

event
string
required

listenerCount

event
string
required
returns
number

off

event
string
required
handler
EventHandler
required

on

event
string
required
handler
EventHandler
required
returns
EventHandler

once

event
string
required
handler
EventHandler
required
returns
EventHandler

removeAllListeners

event
string

MetricsOptions

Configure metrics export. See MetricsOptionsInit.

Constructor

enabled
boolean
Whether metrics collection is enabled. Defaults to true.
exportUrl
string | null
OTLP endpoint to export metrics to. Defaults to null (no external export).
exportHeaders
Record<string, string> | null
Headers sent with metric exports (e.g. auth). Defaults to null.

TracesOptions

Configure distributed tracing export. See TracesOptionsInit.

Constructor

enabled
boolean
Whether tracing is enabled. Defaults to true.
exportUrl
string | null
OTLP endpoint to export traces to. Defaults to null (no external export).
exportHeaders
Record<string, string> | null
Headers sent with trace exports (e.g. auth). Defaults to null.

LoggingOptions

Configure log export. See LoggingOptionsInit.

Constructor

enabled
boolean
Whether log export is enabled. Defaults to false.
level
string | string[]
Minimum log level(s) to export (e.g. 'INFO'). Defaults to 'INFO'.
exportUrl
string | null
Endpoint to export logs to. Defaults to null (no external export).
exportHeaders
Record<string, string> | null
Headers sent with log exports (e.g. auth). Defaults to null.

ObservabilityOptions

Group tracing, metrics, and logging settings into one object. See ObservabilityOptionsInit.

Constructor

traces
TracesOptions | null
Tracing settings. See TracesOptions. Defaults to null.
metrics
MetricsOptions | null
Metrics settings. See MetricsOptions. Defaults to null.
logs
LoggingOptions | null
Logging settings. See LoggingOptions. Defaults to null.

setupLogging

Configure and return the shared zrt.agents Logger.
level
string | number
Minimum level to emit. Default: 'INFO'.
returns
Logger