Lynx/Modules/Observability
@sigx/lynx-observability · Stable

Observability#

Opt-in production error capture, provider-agnostic log/error sinks, and Memory.query() — the engine-attributed memory reading.

v0.27.0 iOS · Android · Web MIT

Installation#

Terminal
pnpm add @sigx/lynx-observability
sigx prebuild   # links the native memory module

About#

@sigx/lynx-observability builds on the @sigx/lynx-core logger: uncaught errors are funnelled in as error-level records, and sinks are just LogTransports, so any provider — Sentry, Datadog, your own backend — is an adapter away. Declare it under logging.production in signalx.config.ts and @sigx/lynx-plugin prepends the init in release builds; or call initObservability() once in your entry.

Memory is the resource half: one process-global reading of what the Lynx engine is holding — total bytes, element-tree bytes and node count, runtime heaps, per-LynxView attribution — on demand with Memory.query() or on a timer with Memory.startReporting(). It is the package's native side, and the reason sigx prebuild is required after installing.

It is versioned in lockstep with the rest of the Lynx module family.

Next steps#

Continue with Installation for project setup, Usage for the patterns, or jump to the API reference.