API reference

observability(options) creates a named metrics, events, signals, and traces stream.

Import

import { observability } from "@layeron/modules"

observability

Create a Layeron observability module.

observability(options: ObservabilityModuleOptions): ObservabilityModule

ObservabilityModuleSamplingOptions

Sampling policy for a named observability stream.

Field	Type	Description
success	float64 | undefined	Sampling rate for normal metric, event, signal, and trace records. Value must be from 0 to 1.
error	float64 | undefined	Sampling rate for error records. Value must be from 0 to 1.

ObservabilityModuleCaptureOptions

Capture switches for a named observability stream.

Field	Type	Description
metrics	boolean | undefined	Capture metric records.
events	boolean | undefined	Capture event records.
signals	boolean | undefined	Capture signal records.
traces	boolean | undefined	Capture trace span records.
errors	boolean | undefined	Capture error records.

ObservabilityModuleOptions

Options accepted by observability(options).

Field	Type	Description
name	string	Stable observability stream name inside the Layeron app.
namespace	string	Platform namespace for the instance. Defaults to default.
sampling	ObservabilityModuleSamplingOptions | undefined	Sampling policy for this stream.
redaction	Layeron.Observability.RedactionPolicy | undefined	Redaction policy applied before attributes are emitted.
capture	ObservabilityModuleCaptureOptions | undefined	Capture switches for this stream.
sink	ObservabilitySink | undefined	Runtime sink. The first supported sink is worker_logs.

ObservabilityModule

Layeron observability module returned by observability(options).

Field	Type	Description
name	”observability”	Module name.
config	ObservabilityModuleOptions	Normalized module configuration.
observability	Layeron.Observability.ObservabilityConfig | undefined	Effective observability policy recorded on the module declaration.

ObservabilitySink

Sink used by the observability module.

Value	Description
worker_logs	Emit structured observability records through Cloudflare Worker Logs.

Operations

observabilityMetric

Emit a metric point.

observabilityMetric(name: string, value: float64, attributes?: unknown): void

observabilityIncrement

Increment a counter metric.

observabilityIncrement(name: string, value?: float64, attributes?: unknown): void

observabilityGauge

Emit a gauge metric.

observabilityGauge(name: string, value: float64, attributes?: unknown): void

observabilityHistogram

Emit a histogram metric.

observabilityHistogram(name: string, value: float64, attributes?: unknown): void

observabilitySignal

Emit a signal point.

observabilitySignal(name: string, value: float64, attributes?: unknown): void

observabilityEvent

Emit an event record.

observabilityEvent(name: string, attributes?: unknown): void

observabilityCapture

Capture an error record.

observabilityCapture(error: unknown, attributes?: unknown): void

observabilityTiming

Measure callback duration and emit a timing metric.

observabilityTiming(name: string, callback: unknown, attributes?: unknown): unknown

observabilitySpan

Measure callback duration and emit a span record.

observabilitySpan(name: string, callback: unknown, attributes?: unknown): unknown