139 lines
14 KiB
Plaintext
139 lines
14 KiB
Plaintext
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.8</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 id="main" class="portal-main docs-layout docs-layout--navigation"><aside class="docs-section-menu" aria-label="Documentation sections"><nav>
|
|
<section><strong>Get started</strong><a href="/getting-started">Quick start</a><a href="/tutorial">Tutorial</a><a href="/guides/full-stack-auth-demo">Auth dashboard demo</a><a href="/guides/configuration-and-profiles">Configuration</a></section>
|
|
<section><strong>Build</strong><a href="/guides/pages-and-components">Pages and components</a><a href="/guides/routing">Routing</a><a href="/guides/server-data">Server data</a><a href="/guides/forms-and-validation">Forms and validation</a><a href="/guides/database">Database</a></section>
|
|
<section><strong>Auth and security</strong><a href="/guides/authentication">Authentication</a><a href="/guides/authorization">Authorization</a><a href="/guides/security">Application security</a><a href="/security">Security policy</a></section>
|
|
<section><strong>Reference</strong><a href="/packages">Packages overview</a><a href="/packages/cli">CLI</a><a href="/language">.wrn language</a><a href="https://component.wrnexusjs.dev/">Components</a><a href="/examples">Examples</a></section>
|
|
<section class="package-menu"><strong>Packages</strong><a href="/packages/ai">@wrnexus/ai</a><a href="/packages/auth">@wrnexus/auth</a><a href="/packages/authz">@wrnexus/authz</a><a href="/packages/benchmark">@wrnexus/benchmark</a><a href="/packages/cache">@wrnexus/cache</a><a href="/packages/captcha">@wrnexus/captcha</a><a href="/packages/cli">@wrnexus/cli</a><a href="/packages/compiler">@wrnexus/compiler</a><a href="/packages/content">@wrnexus/content</a><a href="/packages/core">@wrnexus/core</a><a href="/packages/csr">@wrnexus/csr</a><a href="/packages/db">@wrnexus/db</a><a href="/packages/dev-server">@wrnexus/dev-server</a><a href="/packages/dev-toolbar">@wrnexus/dev-toolbar</a><a href="/packages/encryption">@wrnexus/encryption</a><a href="/packages/graphql">@wrnexus/graphql</a><a href="/packages/helpers">@wrnexus/helpers</a><a href="/packages/i18n">@wrnexus/i18n</a><a href="/packages/identity">@wrnexus/identity</a><a href="/packages/image">@wrnexus/image</a><a href="/packages/jwt">@wrnexus/jwt</a><a href="/packages/language-server">@wrnexus/language-server</a><a href="/packages/mcp">@wrnexus/mcp</a><a href="/packages/mobile">@wrnexus/mobile</a><a href="/packages/native">@wrnexus/native</a><a href="/packages/oauth">@wrnexus/oauth</a><a href="/packages/observability">@wrnexus/observability</a><a href="/packages/playground">@wrnexus/playground</a><a href="/packages/plugin">@wrnexus/plugin</a><a href="/packages/pubsub">@wrnexus/pubsub</a><a href="/packages/pwa">@wrnexus/pwa</a><a href="/packages/queue">@wrnexus/queue</a><a href="/packages/reactive">@wrnexus/reactive</a><a href="/packages/realtime">@wrnexus/realtime</a><a href="/packages/router">@wrnexus/router</a><a href="/packages/security">@wrnexus/security</a><a href="/packages/ssr">@wrnexus/ssr</a><a href="/packages/store">@wrnexus/store</a><a href="/packages/styles">@wrnexus/styles</a><a href="/packages/syntax">@wrnexus/syntax</a><a href="/packages/test">@wrnexus/test</a><a href="/packages/tracking">@wrnexus/tracking</a><a href="/packages/typecheck">@wrnexus/typecheck</a><a href="/packages/ui">@wrnexus/ui</a><a href="/packages/uploader">@wrnexus/uploader</a><a href="/packages/validation">@wrnexus/validation</a></section>
|
|
</nav></aside><div class="docs-reading-column">
|
|
<article 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.8</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.8</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 {
|
|
observability: { enabled: true, serverTiming: true, sampleRate: 0.1, webVitals: true },
|
|
};</code></pre>
|
|
<h3 id="traces-correlated-logs-and-otlp">Traces, correlated logs, and OTLP</h3>
|
|
<pre data-language="ts"><code>import {
|
|
createOtlpMetricExporter,
|
|
createOtlpTraceExporter,
|
|
createStructuredLogger,
|
|
metricsMiddleware,
|
|
traceMiddleware,
|
|
} from "@wrnexus/observability";
|
|
|
|
const traces = createOtlpTraceExporter("https://collector.example/v1/traces", {
|
|
serviceName: "checkout",
|
|
headers: { authorization: `Bearer ${process.env.OTLP_TOKEN}` },
|
|
});
|
|
|
|
export const tracing = traceMiddleware({
|
|
serviceName: "checkout",
|
|
sampleRate: 0.1,
|
|
exporter: traces,
|
|
onExportError(error) {
|
|
console.error("trace export failed", error);
|
|
},
|
|
});
|
|
|
|
export const metrics = metricsMiddleware();
|
|
export const metricExporter = createOtlpMetricExporter("https://collector.example/v1/metrics", {
|
|
serviceName: "checkout",
|
|
});
|
|
|
|
export const logger = createStructuredLogger({ service: "checkout" });
|
|
// Request middleware can create a correlated child from ctx.locals.
|
|
logger
|
|
.child({
|
|
traceId: ctx.locals.traceId,
|
|
spanId: ctx.locals.spanId,
|
|
requestId: ctx.locals.requestId,
|
|
})
|
|
.info("order accepted", { orderId });</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 { HealthRegistry } from "@wrnexus/core";
|
|
import { createLivenessHandler, createReadinessHandler } from "@wrnexus/observability";
|
|
|
|
const health = new HealthRegistry();
|
|
health.register("database", async () =>
|
|
(await db.ping()) ? { status: "up" } : { status: "down" },
|
|
);
|
|
|
|
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 { MetricLabels, MetricPoint, MetricsRegistry } from './metrics.js';
|
|
export { MetricExporter, MetricsMiddlewareOptions, WebVitalRecord, WebVitalsHandlerOptions, createHttpMetricExporter, createOtlpMetricExporter, createWebVitalsHandler, defaultMetrics, metricsMiddleware } from './server.js';
|
|
export { WebVitalsClientOptions, webVitalsClient } from './client.js';
|
|
export { S as SpanExporter, a as SpanRecord, T as TraceContext, b as TraceMiddlewareOptions, c as createOtlpTraceExporter, f as formatTraceparent, p as parseTraceparent, t as traceMiddleware } from './trace-CvRlPzhE.js';
|
|
export { HealthHandlerOptions, createLivenessHandler, createReadinessHandler } from './health.js';
|
|
export { LogLevel, LogRecord, StructuredLogger, StructuredLoggerOptions, createStructuredLogger } from './logging.js';
|
|
export { ErrorReporter, FrameworkSpanKind, LogExporter, OperationTracer, createJaegerExporter, createOperationTracer, createOtlpLogExporter, createPerformanceProfiler, createPrometheusPushExporter, createSentryCompatibleReporter, createZipkinExporter, renderPrometheus } 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 {
|
|
observability: { enabled: true, serverTiming: true, sampleRate: 0.1, webVitals: true },
|
|
};</code></pre></article><article class="example-card"><h3>## Traces, correlated logs, and OTLP</h3><pre data-language="ts"><code>import {
|
|
createOtlpMetricExporter,
|
|
createOtlpTraceExporter,
|
|
createStructuredLogger,
|
|
metricsMiddleware,
|
|
traceMiddleware,
|
|
} from "@wrnexus/observability";
|
|
|
|
const traces = createOtlpTraceExporter("https://collector.example/v1/traces", {
|
|
serviceName: "checkout",
|
|
headers: { authorization: `Bearer ${process.env.OTLP_TOKEN}` },
|
|
});
|
|
|
|
export const tracing = traceMiddleware({
|
|
serviceName: "checkout",
|
|
sampleRate: 0.1,
|
|
exporter: traces,
|
|
onExportError(error) {
|
|
console.error("trace export failed", error);
|
|
},
|
|
});
|
|
|
|
export const metrics = metricsMiddleware();
|
|
export const metricExporter = createOtlpMetricExporter("https://collector.example/v1/metrics", {
|
|
serviceName: "checkout",
|
|
});
|
|
|
|
export const logger = createStructuredLogger({ service: "checkout" });
|
|
// Request middleware can create a correlated child from ctx.locals.
|
|
logger
|
|
.child({
|
|
traceId: ctx.locals.traceId,
|
|
spanId: ctx.locals.spanId,
|
|
requestId: ctx.locals.requestId,
|
|
})
|
|
.info("order accepted", { orderId });</code></pre></article><article class="example-card"><h3>## Liveness and readiness</h3><pre data-language="ts"><code>import { HealthRegistry } from "@wrnexus/core";
|
|
import { createLivenessHandler, createReadinessHandler } from "@wrnexus/observability";
|
|
|
|
const health = new HealthRegistry();
|
|
health.register("database", async () =>
|
|
(await db.ping()) ? { status: "up" } : { status: "down" },
|
|
);
|
|
|
|
export const live = createLivenessHandler();
|
|
export const ready = createReadinessHandler(health);</code></pre></article></div></section></article></div>
|
|
<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.8</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>
|
|
}
|
|
}
|