WRNexusJSDoc/app/pages/packages/observability.wrn

page wrnexusobservability {
  seo {
    title = "@wrnexus/observability"
    description = "Structured logging, tracing, health, and integration adapters."
  }

  view {
    <div class="docs-shell">
      <a href="#main" class="skip-link">Skip to content</a>
      <header class="topbar">
        <a class="brand" href="/"><span>W</span> WRNexusJS</a>
        <nav aria-label="Primary"><a href="/getting-started">Get started</a><a href="/packages">Packages</a><a href="https://component.wrnexusjs.dev/">Components</a><a href="/language">Language</a><a href="/architecture">Architecture</a></nav>
        <div class="topbar-actions"><a class="preview-pill" href="/access">Private preview · v0.8.3</a><button data-wire-theme-toggle class="theme-button" aria-label="Toggle color theme" title="Toggle color theme">◐</button></div>
      </header>
      <div class="mobile-doc-nav"><details><summary>Browse documentation</summary><nav><a href="/getting-started">Get started</a><a href="/packages">Packages</a><a href="https://component.wrnexusjs.dev/">Components</a><a href="/language">Language</a><a href="/architecture">Architecture</a><a href="/tutorial">Tutorial</a><a href="/guides/project-structure">Guides</a><a href="/examples">Examples</a><a href="/search">Search</a></nav></details></div>
      <main class="portal-main docs-layout">
      <article id="main" class="documentation prose standalone package-document"><nav class="breadcrumbs" aria-label="Breadcrumb"><a href="/">Home</a><span>/</span><a href="/packages">Packages</a><span>/</span><span aria-current="page">@wrnexus/observability</span></nav><section class="doc-intro"><span class="eyebrow">Runtime · Package reference</span><h1>@wrnexus/observability</h1><p>Structured logging, tracing, health, and integration adapters.</p><div class="doc-meta"><span>v0.8.3</span><span>Private registry</span><span>Runtime</span></div><section id="access" class="access-callout"><h2>Install the package</h2><p>After WorkRoot approves private registry access, install the release-aligned package:</p><pre><code>bun add @wrnexus/observability@0.8.3</code><button type="button" class="copy-button" aria-label="Copy installation command">Copy</button></pre><p><a href="/access">Request preview access</a>. Never put registry tokens in source control.</p></section></section><section id="guide"><p>Open-standard traces, metrics, logs, health checks, Web Vitals, error reporting and profiling.</p>
<p>Use <code>createOperationTracer()</code> for <code>database</code>, <code>cache</code>, <code>queue</code>, <code>realtime</code>, <code>server-action</code> or custom <code>application</code> spans. Export through OTLP, Prometheus, Zipkin/Jaeger, or the Sentry-compatible error reporter; Grafana can consume the Prometheus or OTLP signals.</p>
<p>Privacy-conscious counters, gauges, histograms, HTTP middleware, Web Vitals ingestion, browser collection, and exporter adapters. Request bodies and user identifiers are not collected by default.</p>
<pre data-language="ts"><code>export default &#123;
  observability: &#123; enabled: true, serverTiming: true, sampleRate: 0.1, webVitals: true &#125;,
&#125;;</code></pre>
<h3 id="traces-correlated-logs-and-otlp">Traces, correlated logs, and OTLP</h3>
<pre data-language="ts"><code>import &#123;
  createOtlpMetricExporter,
  createOtlpTraceExporter,
  createStructuredLogger,
  metricsMiddleware,
  traceMiddleware,
&#125; from &quot;@wrnexus/observability&quot;;

const traces = createOtlpTraceExporter(&quot;https://collector.example/v1/traces&quot;, &#123;
  serviceName: &quot;checkout&quot;,
  headers: &#123; authorization: `Bearer $&#123;process.env.OTLP_TOKEN&#125;` &#125;,
&#125;);

export const tracing = traceMiddleware(&#123;
  serviceName: &quot;checkout&quot;,
  sampleRate: 0.1,
  exporter: traces,
  onExportError(error) &#123;
    console.error(&quot;trace export failed&quot;, error);
  &#125;,
&#125;);

export const metrics = metricsMiddleware();
export const metricExporter = createOtlpMetricExporter(&quot;https://collector.example/v1/metrics&quot;, &#123;
  serviceName: &quot;checkout&quot;,
&#125;);

export const logger = createStructuredLogger(&#123; service: &quot;checkout&quot; &#125;);
// Request middleware can create a correlated child from ctx.locals.
logger
  .child(&#123;
    traceId: ctx.locals.traceId,
    spanId: ctx.locals.spanId,
    requestId: ctx.locals.requestId,
  &#125;)
  .info(&quot;order accepted&quot;, &#123; orderId &#125;);</code></pre>
<p>The tracing middleware accepts and validates W3C <code>traceparent</code>, creates a child server span, stores correlation identifiers in <code>ctx.locals</code>, installs the framework tracer on <code>ctx.tracer</code>, and returns <code>traceparent</code> plus <code>x-request-id</code>. Export failures are isolated from application responses when <code>onExportError</code> is configured.</p>
<h3 id="liveness-and-readiness">Liveness and readiness</h3>
<pre data-language="ts"><code>import &#123; HealthRegistry &#125; from &quot;@wrnexus/core&quot;;
import &#123; createLivenessHandler, createReadinessHandler &#125; from &quot;@wrnexus/observability&quot;;

const health = new HealthRegistry();
health.register(&quot;database&quot;, async () =&gt;
  (await db.ping()) ? &#123; status: &quot;up&quot; &#125; : &#123; status: &quot;down&quot; &#125;,
);

export const live = createLivenessHandler();
export const ready = createReadinessHandler(health);</code></pre>
<p>Liveness reports whether the process can answer requests. Readiness returns HTTP 503 when a registered dependency is down. Dependency messages and details are hidden unless <code>exposeDetails: true</code> is explicitly selected for a trusted endpoint.</p></section><section id="api" class="api"><h2>Complete TypeScript API</h2><p>Generated from the exact installed package declarations.</p><pre data-language="typescript"><code>export &#123; MetricLabels, MetricPoint, MetricsRegistry &#125; from './metrics.js';
export &#123; MetricExporter, MetricsMiddlewareOptions, WebVitalRecord, WebVitalsHandlerOptions, createHttpMetricExporter, createOtlpMetricExporter, createWebVitalsHandler, defaultMetrics, metricsMiddleware &#125; from './server.js';
export &#123; WebVitalsClientOptions, webVitalsClient &#125; from './client.js';
export &#123; SpanExporter, SpanRecord, TraceContext, TraceMiddlewareOptions, createOtlpTraceExporter, formatTraceparent, parseTraceparent, traceMiddleware &#125; from './trace.js';
export &#123; HealthHandlerOptions, createLivenessHandler, createReadinessHandler &#125; from './health.js';
export &#123; LogLevel, LogRecord, StructuredLogger, StructuredLoggerOptions, createStructuredLogger &#125; from './logging.js';
export &#123; ErrorReporter, FrameworkSpanKind, LogExporter, OperationTracer, createJaegerExporter, createOperationTracer, createOtlpLogExporter, createPerformanceProfiler, createPrometheusPushExporter, createSentryCompatibleReporter, createZipkinExporter, renderPrometheus &#125; from './integrations.js';
import '@wrnexus/core';
</code></pre></section><section id="examples" class="examples"><h2>Examples</h2><p>Copy-ready examples from the installed package documentation.</p><div class="example-grid"><article class="example-card"><h3>Privacy-conscious counters, gauges, histograms, HTTP middleware, Web Vitals ingestion, browser collection, and exporter adapters. Request bodies and user identifiers are not collected by default.</h3><pre data-language="ts"><code>export default &#123;
  observability: &#123; enabled: true, serverTiming: true, sampleRate: 0.1, webVitals: true &#125;,
&#125;;</code></pre></article><article class="example-card"><h3>## Traces, correlated logs, and OTLP</h3><pre data-language="ts"><code>import &#123;
  createOtlpMetricExporter,
  createOtlpTraceExporter,
  createStructuredLogger,
  metricsMiddleware,
  traceMiddleware,
&#125; from &quot;@wrnexus/observability&quot;;

const traces = createOtlpTraceExporter(&quot;https://collector.example/v1/traces&quot;, &#123;
  serviceName: &quot;checkout&quot;,
  headers: &#123; authorization: `Bearer $&#123;process.env.OTLP_TOKEN&#125;` &#125;,
&#125;);

export const tracing = traceMiddleware(&#123;
  serviceName: &quot;checkout&quot;,
  sampleRate: 0.1,
  exporter: traces,
  onExportError(error) &#123;
    console.error(&quot;trace export failed&quot;, error);
  &#125;,
&#125;);

export const metrics = metricsMiddleware();
export const metricExporter = createOtlpMetricExporter(&quot;https://collector.example/v1/metrics&quot;, &#123;
  serviceName: &quot;checkout&quot;,
&#125;);

export const logger = createStructuredLogger(&#123; service: &quot;checkout&quot; &#125;);
// Request middleware can create a correlated child from ctx.locals.
logger
  .child(&#123;
    traceId: ctx.locals.traceId,
    spanId: ctx.locals.spanId,
    requestId: ctx.locals.requestId,
  &#125;)
  .info(&quot;order accepted&quot;, &#123; orderId &#125;);</code></pre></article><article class="example-card"><h3>## Liveness and readiness</h3><pre data-language="ts"><code>import &#123; HealthRegistry &#125; from &quot;@wrnexus/core&quot;;
import &#123; createLivenessHandler, createReadinessHandler &#125; from &quot;@wrnexus/observability&quot;;

const health = new HealthRegistry();
health.register(&quot;database&quot;, async () =&gt;
  (await db.ping()) ? &#123; status: &quot;up&quot; &#125; : &#123; status: &quot;down&quot; &#125;,
);

export const live = createLivenessHandler();
export const ready = createReadinessHandler(health);</code></pre></article></div></section></article>
      <aside class="on-this-page"><h2>On this page</h2><nav><a class="toc-level-2" href="#guide">Guide</a><a class="toc-level-3" href="#traces-correlated-logs-and-otlp">Traces, correlated logs, and OTLP</a><a class="toc-level-3" href="#liveness-and-readiness">Liveness and readiness</a><a class="toc-level-2" href="#api">Complete API</a><a class="toc-level-2" href="#examples">Examples</a></nav></aside>
    </main>
      <footer><div class="footer-brand"><span class="footer-mark" aria-hidden="true">W</span><p><strong>WRNexusJS 0.8.3</strong><span>Complete API documentation generated from installed package declarations.</span></p></div><nav aria-label="Footer"><a href="/packages">All packages</a><a href="/getting-started">Get started</a><a href="/security">Security</a><a href="/support">Support</a><a href="/llms.txt">AI guide</a></nav><p class="footer-meta">Private Developer Preview · Bun-native</p></footer>
    </div>
  }
}