212 lines
17 KiB
Plaintext
212 lines
17 KiB
Plaintext
page wrnexustracking {
|
|
seo {
|
|
title = "@wrnexus/tracking"
|
|
description = "Error/event capture, middleware, filtering, and sinks."
|
|
}
|
|
|
|
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/tracking</span></nav><section class="doc-intro"><span class="eyebrow">Runtime · Package reference</span><h1>@wrnexus/tracking</h1><p>Error/event capture, middleware, filtering, and sinks.</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/tracking@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"><blockquote>Error tracking for WRNexusJS apps: capture exceptions manually or via middleware and fan them out to pluggable sinks.</blockquote>
|
|
<p>Part of the <strong>WRNexusJS</strong> framework — an SSR-first, Bun-native full-stack web framework.</p>
|
|
<h3 id="overview">Overview</h3>
|
|
<p><code>@wrnexus/tracking</code> is a small, server-side error-capture layer. You create a tracker with one or more <strong>sinks</strong>, then feed it errors — either manually with <code>tracker.capture(err, context)</code> or automatically by mounting <code>tracker.middleware()</code> in your request pipeline. A <code>consoleSink</code> is included; forwarding to Sentry, Datadog, or any other backend is just a matter of writing a tiny sink. Reach for it when you want a single, sink-agnostic place to route application errors. Sinks run best-effort — a throwing sink never breaks the request.</p>
|
|
<pre data-language="bash"><code>bun add @wrnexus/tracking</code></pre>
|
|
<blockquote>Private package — the machine must be authenticated to the <code>wrnexus</code> npm org</blockquote>
|
|
<blockquote>(a read token in <code>~/.npmrc</code>). Requires <strong>Bun</strong> (Node is not supported).</blockquote>
|
|
<h3 id="api">API</h3>
|
|
<h4 id="createtracker-options-tracker"><code>createTracker(options?): Tracker</code></h4>
|
|
<p>Creates a tracker. <code>TrackerOptions</code>:</p>
|
|
<div class="table-wrap"><table>
|
|
<thead><tr><th>Option</th><th>Type</th><th>Description</th></tr></thead>
|
|
<tbody><tr><td><code>sinks</code></td><td><code>ErrorSink[]</code></td><td>Initial sinks to fan events out to. Defaults to <code>[]</code>.</td></tr><tr><td><code>now</code></td><td><code>() => number</code></td><td>Clock used for <code>event.timestamp</code> (epoch ms). Defaults to <code>Date.now</code>.</td></tr><tr><td><code>beforeSend</code></td><td>`(event: ErrorEvent) => ErrorEvent \</td><td>null`</td><td>Scrub/enrich an event before it reaches any sink. Return <code>null</code> to drop it.</td></tr></tbody></table></div>
|
|
<p>The returned <code>Tracker</code>:</p>
|
|
<div class="table-wrap"><table>
|
|
<thead><tr><th>Member</th><th>Signature</th><th>Description</th></tr></thead>
|
|
<tbody><tr><td><code>capture</code></td><td><code>(error: unknown, context?: Record<string, unknown>) => Promise<void></code></td><td>Normalizes any thrown value into an <code>Error</code>, builds an <code>ErrorEvent</code>, runs <code>beforeSend</code>, then dispatches to all sinks. Non-<code>Error</code> values are wrapped in an <code>Error</code> named <code>NonError</code>.</td></tr><tr><td><code>addSink</code></td><td><code>(sink: ErrorSink) => void</code></td><td>Registers an additional sink at runtime.</td></tr><tr><td><code>middleware</code></td><td><code>() => Middleware</code></td><td>Returns a WRNexusJS <code>Middleware</code> that captures any error thrown downstream, then re-throws it so the framework's error handler still produces the response.</td></tr></tbody></table></div>
|
|
<p>The middleware attaches this context to captured events:</p>
|
|
<pre data-language="ts"><code>{ method: ctx.req.method, path: ctx.url.pathname, requestId: ctx.locals.requestId }</code></pre>
|
|
<h4 id="consolesink-errorsink"><code>consoleSink: ErrorSink</code></h4>
|
|
<p>A built-in sink that logs a compact one-line message via <code>console.error</code>, e.g. <code>[error] TypeError: cannot read x {"userId":42}</code>.</p>
|
|
<h4 id="types">Types</h4>
|
|
<pre data-language="ts"><code>interface ErrorEvent {
|
|
error: Error;
|
|
context: Record<string, unknown>; // request info, user id, tags…
|
|
timestamp: number; // epoch ms
|
|
}
|
|
|
|
interface ErrorSink {
|
|
name?: string;
|
|
capture(event: ErrorEvent): void | Promise<void>;
|
|
}</code></pre>
|
|
<h3 id="usage">Usage</h3>
|
|
<p>Manual capture:</p>
|
|
<pre data-language="ts"><code>import { createTracker, consoleSink } from "@wrnexus/tracking";
|
|
|
|
const tracker = createTracker({ sinks: [consoleSink] });
|
|
|
|
try {
|
|
await doWork();
|
|
} catch (err) {
|
|
await tracker.capture(err, { userId: 42, op: "doWork" });
|
|
throw err;
|
|
}</code></pre>
|
|
<p>As request middleware:</p>
|
|
<pre data-language="ts"><code>import { createTracker, consoleSink } from "@wrnexus/tracking";
|
|
|
|
const tracker = createTracker({ sinks: [consoleSink] });
|
|
|
|
app.use(tracker.middleware()); // captures + re-throws downstream errors</code></pre>
|
|
<p>A custom sink with <code>beforeSend</code> scrubbing:</p>
|
|
<pre data-language="ts"><code>import { createTracker, type ErrorSink } from "@wrnexus/tracking";
|
|
|
|
const sentrySink: ErrorSink = {
|
|
name: "sentry",
|
|
async capture(event) {
|
|
await Sentry.captureException(event.error, { extra: event.context });
|
|
},
|
|
};
|
|
|
|
const tracker = createTracker({
|
|
sinks: [sentrySink],
|
|
beforeSend(event) {
|
|
delete event.context.password; // scrub secrets
|
|
return event; // return null to drop the event entirely
|
|
},
|
|
});
|
|
|
|
tracker.addSink(anotherSink); // add more sinks later</code></pre>
|
|
<h3 id="requirements-notes">Requirements / Notes</h3>
|
|
<ul>
|
|
<li>Runs on <strong>Bun</strong> only (Node is not supported).</li>
|
|
<li>Peer package: [<code>@wrnexus/core</code>](../core) — the <code>Context</code> and <code>Middleware</code> types</li>
|
|
<p>used by <code>tracker.middleware()</code> come from there.</p>
|
|
<li>Sink dispatch is fire-and-forget-safe: all sinks run via <code>Promise.all</code>, and a</li>
|
|
<p>sink that throws is swallowed so it can never break the app.</p>
|
|
</ul></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>import { Middleware } from '@wrnexus/core';
|
|
|
|
type TelemetryKind = "error" | "event" | "metric" | "span";
|
|
interface TelemetryEnvelope {
|
|
id: string;
|
|
kind: TelemetryKind;
|
|
name: string;
|
|
timestamp: number;
|
|
traceId?: string;
|
|
userId?: string;
|
|
tenantId?: string;
|
|
attributes: Record<string, unknown>;
|
|
payload?: unknown;
|
|
}
|
|
interface TelemetrySink {
|
|
name?: string;
|
|
send(events: TelemetryEnvelope[]): void | Promise<void>;
|
|
}
|
|
interface TelemetryPipeline {
|
|
emit(input: Omit<TelemetryEnvelope, "id" | "timestamp"> & Partial<Pick<TelemetryEnvelope, "id" | "timestamp">>): Promise<void>;
|
|
flush(): Promise<void>;
|
|
close(): Promise<void>;
|
|
size(): number;
|
|
}
|
|
interface TelemetryPipelineOptions {
|
|
sinks: TelemetrySink[];
|
|
batchSize?: number;
|
|
flushIntervalMs?: number;
|
|
maxQueueSize?: number;
|
|
sampleRate?: number;
|
|
beforeSend?: (event: TelemetryEnvelope) => TelemetryEnvelope | null;
|
|
onSinkError?: (error: unknown, sink: TelemetrySink, events: readonly TelemetryEnvelope[]) => void | Promise<void>;
|
|
now?: () => number;
|
|
random?: () => number;
|
|
}
|
|
declare function createTelemetryPipeline(options: TelemetryPipelineOptions): TelemetryPipeline;
|
|
declare const telemetryConsoleSink: TelemetrySink;
|
|
|
|
/**
|
|
* @wrnexus/tracking — error tracking with pluggable sinks. Capture exceptions
|
|
* manually or via middleware, and fan them out to any sink (console by default;
|
|
* write a small sink to forward to Sentry/Datadog/etc.).
|
|
*
|
|
* const tracker = createTracker({ sinks: [consoleSink] });
|
|
* app-middleware: tracker.middleware() // captures + re-throws request errors
|
|
* tracker.capture(err, { userId }); // manual
|
|
*/
|
|
|
|
interface ErrorEvent {
|
|
error: Error;
|
|
/** Arbitrary structured context (request info, user id, tags…). */
|
|
context: Record<string, unknown>;
|
|
/** Epoch ms. */
|
|
timestamp: number;
|
|
}
|
|
interface ErrorSink {
|
|
name?: string;
|
|
capture(event: ErrorEvent): void | Promise<void>;
|
|
}
|
|
interface Tracker {
|
|
capture(error: unknown, context?: Record<string, unknown>): Promise<void>;
|
|
addSink(sink: ErrorSink): void;
|
|
/** Middleware that captures errors thrown downstream, then re-throws them. */
|
|
middleware(): Middleware;
|
|
}
|
|
interface TrackerOptions {
|
|
sinks?: ErrorSink[];
|
|
now?: () => number;
|
|
/** Scrub/enrich an event before it hits sinks (return null to drop it). */
|
|
beforeSend?: (event: ErrorEvent) => ErrorEvent | null;
|
|
}
|
|
/** A sink that logs a compact one-line error to the console. */
|
|
declare const consoleSink: ErrorSink;
|
|
declare function createTracker(options?: TrackerOptions): Tracker;
|
|
|
|
export { type ErrorEvent, type ErrorSink, type TelemetryEnvelope, type TelemetryKind, type TelemetryPipeline, type TelemetryPipelineOptions, type TelemetrySink, type Tracker, type TrackerOptions, consoleSink, createTelemetryPipeline, createTracker, telemetryConsoleSink };
|
|
</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>Manual capture</h3><pre data-language="ts"><code>import { createTracker, consoleSink } from "@wrnexus/tracking";
|
|
|
|
const tracker = createTracker({ sinks: [consoleSink] });
|
|
|
|
try {
|
|
await doWork();
|
|
} catch (err) {
|
|
await tracker.capture(err, { userId: 42, op: "doWork" });
|
|
throw err;
|
|
}</code></pre></article><article class="example-card"><h3>As request middleware</h3><pre data-language="ts"><code>import { createTracker, consoleSink } from "@wrnexus/tracking";
|
|
|
|
const tracker = createTracker({ sinks: [consoleSink] });
|
|
|
|
app.use(tracker.middleware()); // captures + re-throws downstream errors</code></pre></article><article class="example-card"><h3>A custom sink with beforeSend scrubbing</h3><pre data-language="ts"><code>import { createTracker, type ErrorSink } from "@wrnexus/tracking";
|
|
|
|
const sentrySink: ErrorSink = {
|
|
name: "sentry",
|
|
async capture(event) {
|
|
await Sentry.captureException(event.error, { extra: event.context });
|
|
},
|
|
};
|
|
|
|
const tracker = createTracker({
|
|
sinks: [sentrySink],
|
|
beforeSend(event) {
|
|
delete event.context.password; // scrub secrets
|
|
return event; // return null to drop the event entirely
|
|
},
|
|
});
|
|
|
|
tracker.addSink(anotherSink); // add more sinks later</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="#overview">Overview</a><a class="toc-level-3" href="#api">API</a><a class="toc-level-4" href="#createtracker-options-tracker">createTracker(options?): Tracker</a><a class="toc-level-4" href="#consolesink-errorsink">consoleSink: ErrorSink</a><a class="toc-level-4" href="#types">Types</a><a class="toc-level-3" href="#usage">Usage</a><a class="toc-level-3" href="#requirements-notes">Requirements / Notes</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>
|
|
}
|
|
}
|