@watchtowerobservability/node 0.4.0 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/README.md +44 -9
  2. package/dist/cjs/buffer.d.ts +2 -3
  3. package/dist/cjs/buffer.js +6 -6
  4. package/dist/cjs/env.d.ts +12 -0
  5. package/dist/cjs/env.js +37 -0
  6. package/dist/cjs/errors.d.ts +8 -0
  7. package/dist/cjs/errors.js +23 -0
  8. package/dist/cjs/index.d.ts +34 -12
  9. package/dist/cjs/index.js +106 -52
  10. package/dist/cjs/instrument.d.ts +7 -0
  11. package/dist/cjs/instrument.js +51 -0
  12. package/dist/cjs/integrations/genai-agents.d.ts +4 -1
  13. package/dist/cjs/integrations/genai-agents.js +27 -24
  14. package/dist/cjs/integrations/genai-frameworks.d.ts +25 -0
  15. package/dist/cjs/integrations/genai-frameworks.js +211 -0
  16. package/dist/cjs/integrations/genai.d.ts +1 -0
  17. package/dist/cjs/integrations/genai.js +7 -2
  18. package/dist/cjs/integrations/next.d.ts +4 -1
  19. package/dist/cjs/integrations/next.js +13 -7
  20. package/dist/cjs/load.d.ts +2 -0
  21. package/dist/cjs/load.js +54 -5
  22. package/dist/cjs/metrics.d.ts +1 -2
  23. package/dist/cjs/metrics.js +6 -6
  24. package/dist/cjs/origin.d.ts +9 -0
  25. package/dist/cjs/origin.js +43 -0
  26. package/dist/cjs/redact.d.ts +8 -0
  27. package/dist/cjs/redact.js +43 -0
  28. package/dist/cjs/register.d.ts +1 -0
  29. package/dist/cjs/register.js +29 -0
  30. package/dist/cjs/sampling.d.ts +53 -0
  31. package/dist/cjs/sampling.js +98 -0
  32. package/dist/esm/buffer.d.ts +2 -3
  33. package/dist/esm/buffer.js +6 -6
  34. package/dist/esm/env.d.ts +12 -0
  35. package/dist/esm/env.js +33 -0
  36. package/dist/esm/errors.d.ts +8 -0
  37. package/dist/esm/errors.js +22 -0
  38. package/dist/esm/index.d.ts +34 -12
  39. package/dist/esm/index.js +104 -51
  40. package/dist/esm/instrument.d.ts +7 -0
  41. package/dist/esm/instrument.js +48 -0
  42. package/dist/esm/integrations/genai-agents.d.ts +4 -1
  43. package/dist/esm/integrations/genai-agents.js +4 -4
  44. package/dist/esm/integrations/genai-frameworks.d.ts +25 -0
  45. package/dist/esm/integrations/genai-frameworks.js +206 -0
  46. package/dist/esm/integrations/genai.d.ts +1 -0
  47. package/dist/esm/integrations/genai.js +3 -1
  48. package/dist/esm/integrations/next.d.ts +4 -1
  49. package/dist/esm/integrations/next.js +11 -6
  50. package/dist/esm/load.d.ts +2 -0
  51. package/dist/esm/load.js +78 -2
  52. package/dist/esm/metrics.d.ts +1 -2
  53. package/dist/esm/metrics.js +5 -5
  54. package/dist/esm/origin.d.ts +9 -0
  55. package/dist/esm/origin.js +39 -0
  56. package/dist/esm/redact.d.ts +8 -0
  57. package/dist/esm/redact.js +39 -0
  58. package/dist/esm/register.d.ts +1 -0
  59. package/dist/esm/register.js +27 -0
  60. package/dist/esm/sampling.d.ts +53 -0
  61. package/dist/esm/sampling.js +91 -0
  62. package/package.json +86 -14
package/dist/esm/load.js CHANGED
@@ -1,5 +1,81 @@
1
+ // Optional-peer loader. Each peer is required by a LITERAL name inside a try block so bundlers (webpack, esbuild, Next's
2
+ // file tracer) can follow it; a computed `require(name)` is invisible to them. This is the CommonJS form;
3
+ // scripts/build.mjs prepends `const require = createRequire(import.meta.url)` for dist/esm (webpack follows that too).
4
+ // The cwd fallback only matters when `require` does not exist (test runners running the TS source as ESM).
1
5
  import { createRequire } from 'node:module';
2
- const req = createRequire(import.meta.url);
6
+ const pre = {};
7
+ try { pre["@opentelemetry/context-async-hooks"] = await import("@opentelemetry/context-async-hooks"); } catch (e) { pre["@opentelemetry/context-async-hooks"] = e; }
8
+ try { pre["@opentelemetry/core"] = await import("@opentelemetry/core"); } catch (e) { pre["@opentelemetry/core"] = e; }
9
+ try { pre["@opentelemetry/exporter-logs-otlp-http"] = await import("@opentelemetry/exporter-logs-otlp-http"); } catch (e) { pre["@opentelemetry/exporter-logs-otlp-http"] = e; }
10
+ try { pre["@opentelemetry/exporter-metrics-otlp-http"] = await import("@opentelemetry/exporter-metrics-otlp-http"); } catch (e) { pre["@opentelemetry/exporter-metrics-otlp-http"] = e; }
11
+ try { pre["@opentelemetry/exporter-trace-otlp-http"] = await import("@opentelemetry/exporter-trace-otlp-http"); } catch (e) { pre["@opentelemetry/exporter-trace-otlp-http"] = e; }
12
+ try { pre["@opentelemetry/otlp-transformer"] = await import("@opentelemetry/otlp-transformer"); } catch (e) { pre["@opentelemetry/otlp-transformer"] = e; }
13
+ try { pre["@opentelemetry/resources"] = await import("@opentelemetry/resources"); } catch (e) { pre["@opentelemetry/resources"] = e; }
14
+ try { pre["@opentelemetry/sdk-logs"] = await import("@opentelemetry/sdk-logs"); } catch (e) { pre["@opentelemetry/sdk-logs"] = e; }
15
+ try { pre["@opentelemetry/sdk-metrics"] = await import("@opentelemetry/sdk-metrics"); } catch (e) { pre["@opentelemetry/sdk-metrics"] = e; }
16
+ try { pre["@opentelemetry/sdk-trace"] = await import("@opentelemetry/sdk-trace"); } catch (e) { pre["@opentelemetry/sdk-trace"] = e; }
17
+ try { pre["@opentelemetry/instrumentation-runtime-node"] = await import("@opentelemetry/instrumentation-runtime-node"); } catch (e) { pre["@opentelemetry/instrumentation-runtime-node"] = e; }
18
+ try { pre["@opentelemetry/instrumentation"] = await import("@opentelemetry/instrumentation"); } catch (e) { pre["@opentelemetry/instrumentation"] = e; }
19
+ try { pre["@opentelemetry/instrumentation-http"] = await import("@opentelemetry/instrumentation-http"); } catch (e) { pre["@opentelemetry/instrumentation-http"] = e; }
20
+ try { pre["@opentelemetry/instrumentation-undici"] = await import("@opentelemetry/instrumentation-undici"); } catch (e) { pre["@opentelemetry/instrumentation-undici"] = e; }
21
+ try { pre["@opentelemetry/instrumentation-pg"] = await import("@opentelemetry/instrumentation-pg"); } catch (e) { pre["@opentelemetry/instrumentation-pg"] = e; }
22
+ try { pre["@opentelemetry/instrumentation-ioredis"] = await import("@opentelemetry/instrumentation-ioredis"); } catch (e) { pre["@opentelemetry/instrumentation-ioredis"] = e; }
23
+ try { pre["winston-transport"] = await import("winston-transport"); } catch (e) { pre["winston-transport"] = e; }
24
+ const nodeRequire = createRequire(import.meta.url);
25
+ const require = (id) => {
26
+ const m = pre[id];
27
+ if (m === undefined) return nodeRequire(id);
28
+ if (m instanceof Error) throw Object.assign(new Error(m.message), { code: m.code === 'ERR_MODULE_NOT_FOUND' ? 'MODULE_NOT_FOUND' : m.code });
29
+ return m.default && typeof m.default === 'object' ? { ...m.default, ...m } : m;
30
+ };
31
+ const NONE = Symbol('not a known peer');
32
+ function known(id) {
33
+ try { // bundlers only tolerate an optional require that is lexically inside try
34
+ switch (id) {
35
+ case '@opentelemetry/context-async-hooks': return require('@opentelemetry/context-async-hooks');
36
+ case '@opentelemetry/core': return require('@opentelemetry/core');
37
+ case '@opentelemetry/exporter-logs-otlp-http': return require('@opentelemetry/exporter-logs-otlp-http');
38
+ case '@opentelemetry/exporter-metrics-otlp-http': return require('@opentelemetry/exporter-metrics-otlp-http');
39
+ case '@opentelemetry/exporter-trace-otlp-http': return require('@opentelemetry/exporter-trace-otlp-http');
40
+ case '@opentelemetry/otlp-transformer': return require('@opentelemetry/otlp-transformer');
41
+ case '@opentelemetry/resources': return require('@opentelemetry/resources');
42
+ case '@opentelemetry/sdk-logs': return require('@opentelemetry/sdk-logs');
43
+ case '@opentelemetry/sdk-metrics': return require('@opentelemetry/sdk-metrics');
44
+ case '@opentelemetry/sdk-trace': return require('@opentelemetry/sdk-trace');
45
+ case '@opentelemetry/instrumentation-runtime-node': return require('@opentelemetry/instrumentation-runtime-node');
46
+ case '@opentelemetry/instrumentation': return require('@opentelemetry/instrumentation');
47
+ case '@opentelemetry/instrumentation-http': return require('@opentelemetry/instrumentation-http');
48
+ case '@opentelemetry/instrumentation-undici': return require('@opentelemetry/instrumentation-undici');
49
+ case '@opentelemetry/instrumentation-pg': return require('@opentelemetry/instrumentation-pg');
50
+ case '@opentelemetry/instrumentation-ioredis': return require('@opentelemetry/instrumentation-ioredis');
51
+ case 'winston-transport': return require('winston-transport');
52
+ default: return NONE;
53
+ }
54
+ }
55
+ catch (e) {
56
+ throw e;
57
+ }
58
+ }
3
59
  export function load(id) {
4
- return req(id);
60
+ if (typeof require !== 'function')
61
+ return createRequire(`${process.cwd()}/`)(id);
62
+ const m = known(id);
63
+ return m === NONE ? require(id) : m;
64
+ }
65
+ const SDK_PEERS = [
66
+ '@opentelemetry/context-async-hooks', '@opentelemetry/core', '@opentelemetry/exporter-logs-otlp-http',
67
+ '@opentelemetry/exporter-metrics-otlp-http', '@opentelemetry/exporter-trace-otlp-http', '@opentelemetry/otlp-transformer',
68
+ '@opentelemetry/resources', '@opentelemetry/sdk-logs', '@opentelemetry/sdk-metrics', '@opentelemetry/sdk-trace',
69
+ ];
70
+ /** Load an OpenTelemetry SDK package (an optional peer); a missing one throws an error naming what to install. */
71
+ export function need(id) {
72
+ try {
73
+ return load(id);
74
+ }
75
+ catch (e) {
76
+ if (e?.code === 'MODULE_NOT_FOUND' && String(e.message).includes(id)) {
77
+ throw new Error(`@watchtowerobservability/node needs the OpenTelemetry SDK, which is not installed (missing ${id}). Run: npm install ${SDK_PEERS.join(' ')}`);
78
+ }
79
+ throw e;
80
+ }
5
81
  }
@@ -1,6 +1,5 @@
1
1
  import type { Resource } from '@opentelemetry/resources';
2
- import { MeterProvider } from '@opentelemetry/sdk-metrics';
3
- import type { PushMetricExporter } from '@opentelemetry/sdk-metrics';
2
+ import type { MeterProvider, PushMetricExporter } from '@opentelemetry/sdk-metrics';
4
3
  /** Explicit flag, else `WATCHTOWER_LOGS` / `WATCHTOWER_METRICS` (default on); `OTEL_*_EXPORTER=none` turns it off. */
5
4
  export declare function switchOn(name: string, otelExporterEnv: string, flag?: boolean): boolean;
6
5
  export interface Metrics {
@@ -3,10 +3,8 @@
3
3
  // metrics (event loop delay and utilization, GC, heap) come from the optional peer
4
4
  // @opentelemetry/instrumentation-runtime-node when it is installed.
5
5
  import * as nodePath from 'node:path';
6
- import { MeterProvider, PeriodicExportingMetricReader } from '@opentelemetry/sdk-metrics';
7
- import { AggregationTemporalityPreference, OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-http';
8
6
  import { MetricSpool } from './buffer.js';
9
- import { load } from './load.js';
7
+ import { load, need } from './load.js';
10
8
  /** Explicit flag, else `WATCHTOWER_LOGS` / `WATCHTOWER_METRICS` (default on); `OTEL_*_EXPORTER=none` turns it off. */
11
9
  export function switchOn(name, otelExporterEnv, flag) {
12
10
  if (flag !== undefined)
@@ -17,9 +15,11 @@ export function switchOn(name, otelExporterEnv, flag) {
17
15
  return !['off', 'false', '0', 'no'].includes((env[name] || 'on').trim().toLowerCase());
18
16
  }
19
17
  export function startMetrics(endpoint, headers, resource, bufferDir, fetch, exporter) {
18
+ const sdk = need('@opentelemetry/sdk-metrics');
20
19
  const url = `${endpoint}/v1/metrics`;
21
20
  let exp = exporter;
22
21
  if (!exp) {
22
+ const { AggregationTemporalityPreference, OTLPMetricExporter } = need('@opentelemetry/exporter-metrics-otlp-http');
23
23
  const delta = process.env.OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
24
24
  ? {} : { temporalityPreference: AggregationTemporalityPreference.DELTA };
25
25
  exp = new OTLPMetricExporter({ url, headers, ...delta });
@@ -27,10 +27,10 @@ export function startMetrics(endpoint, headers, resource, bufferDir, fetch, expo
27
27
  exp = new MetricSpool(exp, nodePath.join(bufferDir, 'metrics'), url, headers, fetch);
28
28
  }
29
29
  const interval = Number(process.env.OTEL_METRIC_EXPORT_INTERVAL) || 60000;
30
- const reader = new PeriodicExportingMetricReader({
30
+ const reader = new sdk.PeriodicExportingMetricReader({
31
31
  exporter: exp, exportIntervalMillis: interval, exportTimeoutMillis: Math.min(30000, interval),
32
32
  });
33
- const provider = new MeterProvider({ resource, readers: [reader] });
33
+ const provider = new sdk.MeterProvider({ resource, readers: [reader] });
34
34
  let runtime;
35
35
  try {
36
36
  const mod = load('@opentelemetry/instrumentation-runtime-node');
@@ -0,0 +1,9 @@
1
+ import type { SpanProcessor } from '@opentelemetry/sdk-trace';
2
+ export interface Frame {
3
+ file: string;
4
+ line: number;
5
+ fn?: string;
6
+ }
7
+ /** The first application frame of a V8 stack, or undefined. */
8
+ export declare function firstAppFrame(stack: string): Frame | undefined;
9
+ export declare function codeOrigin(): SpanProcessor;
@@ -0,0 +1,39 @@
1
+ const FRAME = /^\s*at (?:(.+?) \()?(.+?):(\d+):\d+\)?$/;
2
+ const SKIP = /node_modules|^node:|[\\/]watchtower[\\/](?:dist|src)[\\/]|@watchtowerobservability[\\/]node/;
3
+ /** The first application frame of a V8 stack, or undefined. */
4
+ export function firstAppFrame(stack) {
5
+ for (const line of stack.split('\n').slice(1)) {
6
+ const m = FRAME.exec(line);
7
+ if (!m)
8
+ continue;
9
+ const file = m[2].replace(/^file:\/\//, '');
10
+ if (SKIP.test(file) || SKIP.test(line.trim().slice(3)))
11
+ continue;
12
+ return { file, line: Number(m[3]), fn: m[1] && m[1] !== '<anonymous>' ? m[1] : undefined };
13
+ }
14
+ return undefined;
15
+ }
16
+ export function codeOrigin() {
17
+ return {
18
+ onStart(span) {
19
+ const s = span;
20
+ if (s.attributes?.['code.filepath'] !== undefined)
21
+ return;
22
+ const holder = {};
23
+ const prev = Error.stackTraceLimit;
24
+ Error.stackTraceLimit = 30;
25
+ Error.captureStackTrace(holder);
26
+ Error.stackTraceLimit = prev;
27
+ const f = firstAppFrame(holder.stack ?? '');
28
+ if (!f)
29
+ return;
30
+ s.setAttribute('code.filepath', f.file);
31
+ s.setAttribute('code.lineno', f.line);
32
+ if (f.fn)
33
+ s.setAttribute('code.function', f.fn);
34
+ },
35
+ onEnd() { },
36
+ shutdown: () => Promise.resolve(),
37
+ forceFlush: () => Promise.resolve(),
38
+ };
39
+ }
@@ -0,0 +1,8 @@
1
+ import type { SpanProcessor } from '@opentelemetry/sdk-trace';
2
+ export type RedactHook = (key: string, value: unknown) => unknown;
3
+ /** Hook keys for the non-attribute fields. Event attributes (incl. exception.message / exception.stacktrace) use their own keys. */
4
+ export declare const SPAN_NAME_KEY = "span.name";
5
+ export declare const STATUS_MESSAGE_KEY = "status.message";
6
+ export declare const LOG_BODY_KEY = "log.body";
7
+ /** Span processor that redacts the name, status message, attributes, every event's and link's attributes before export. */
8
+ export declare function redactor(hook: RedactHook): SpanProcessor;
@@ -0,0 +1,39 @@
1
+ /** Hook keys for the non-attribute fields. Event attributes (incl. exception.message / exception.stacktrace) use their own keys. */
2
+ export const SPAN_NAME_KEY = 'span.name';
3
+ export const STATUS_MESSAGE_KEY = 'status.message';
4
+ export const LOG_BODY_KEY = 'log.body';
5
+ function attrs(a, hook) {
6
+ if (!a)
7
+ return;
8
+ for (const k of Object.keys(a))
9
+ a[k] = hook(k, a[k]);
10
+ }
11
+ /** Assign, falling back to defineProperty if the SDK exposes the field as a getter. */
12
+ function put(o, k, v) {
13
+ try {
14
+ o[k] = v;
15
+ }
16
+ catch { /* readonly accessor */ }
17
+ if (o[k] !== v)
18
+ Object.defineProperty(o, k, { value: v, configurable: true, enumerable: true, writable: true });
19
+ }
20
+ /** Span processor that redacts the name, status message, attributes, every event's and link's attributes before export. */
21
+ export function redactor(hook) {
22
+ return {
23
+ onStart() { },
24
+ onEnd(span) {
25
+ // ReadableSpan fields are readonly in the types but are plain mutable fields on the SDK span
26
+ const s = span;
27
+ put(s, 'name', String(hook(SPAN_NAME_KEY, s.name) ?? ''));
28
+ if (s.status?.message)
29
+ put(s.status, 'message', String(hook(STATUS_MESSAGE_KEY, s.status.message) ?? ''));
30
+ attrs(span.attributes, hook);
31
+ for (const e of s.events || [])
32
+ attrs(e.attributes, hook);
33
+ for (const l of s.links || [])
34
+ attrs(l.attributes, hook);
35
+ },
36
+ shutdown: () => Promise.resolve(),
37
+ forceFlush: () => Promise.resolve(),
38
+ };
39
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,27 @@
1
+ // Preload entry: `node --import @watchtowerobservability/node/register app.mjs` (ESM) or `node -r @watchtowerobservability/node/register app.js` (CommonJS).
2
+ // Starts the SDK from WT_*/OTEL_* env before the app loads, so http, fetch, pg and ioredis are patched in time.
3
+ // No-op without WT_INGEST_KEY.
4
+ import { pathToFileURL } from 'node:url';
5
+ import { register as registerHooks } from 'node:module';
6
+ import { init } from './index.js';
7
+ if (process.env.WT_INGEST_KEY || process.env.OTEL_EXPORTER_OTLP_HEADERS) {
8
+ try {
9
+ // ESM modules (node:http imported from an ES module) are only patched through OpenTelemetry's loader hook
10
+ // (import-in-the-middle). Resolve it from the app, once per process, and skip quietly when it is not installed.
11
+ const g = globalThis;
12
+ const key = Symbol.for('watchtower.node.esm-hook');
13
+ if (!g[key]) {
14
+ g[key] = true;
15
+ try {
16
+ registerHooks('@opentelemetry/instrumentation/hook.mjs', pathToFileURL(`${process.cwd()}/`));
17
+ }
18
+ catch {
19
+ // @opentelemetry/instrumentation not installed: CommonJS apps are still instrumented
20
+ }
21
+ }
22
+ init({});
23
+ }
24
+ catch (e) {
25
+ console.warn(`[watchtower] register: ${e.message}`);
26
+ }
27
+ }
@@ -0,0 +1,53 @@
1
+ import type { Attributes, Context, Link, SpanKind } from '@opentelemetry/api';
2
+ import type { Sampler, SamplingResult } from '@opentelemetry/sdk-trace';
3
+ export interface SamplingRule {
4
+ name?: string;
5
+ enabled?: boolean | null;
6
+ match?: {
7
+ service?: string;
8
+ env?: string;
9
+ span_name_prefix?: string;
10
+ span_name_glob?: string;
11
+ span_name_regex?: string;
12
+ attrs?: Record<string, string>;
13
+ min_duration_ms?: number | null;
14
+ status?: string;
15
+ };
16
+ action?: {
17
+ kind?: string;
18
+ ratio?: number | null;
19
+ };
20
+ }
21
+ export interface RemoteConfig {
22
+ strategyType?: string;
23
+ probabilisticSampling?: {
24
+ samplingRate: number;
25
+ };
26
+ rules?: SamplingRule[];
27
+ }
28
+ /** fnv64a of the trace id's bytes, as a fraction of 2^64; matches the gateway's `ratioKeeps`. */
29
+ export declare function traceFraction(traceIdHex: string): number;
30
+ export declare function globMatches(glob: string, text: string): boolean;
31
+ /** The keep ratio for a span under `cfg` (1 = keep). First matching ratio/drop rule wins. */
32
+ export declare function ratioFor(cfg: RemoteConfig, service: string, env: string, name: string, attrs: Attributes): number;
33
+ export interface RemoteSamplerOptions {
34
+ endpoint: string;
35
+ headers: Record<string, string>;
36
+ service: string;
37
+ env?: string;
38
+ intervalMs?: number;
39
+ fetch?: typeof fetch;
40
+ }
41
+ export declare class RemoteSampler implements Sampler {
42
+ private readonly o;
43
+ cfg: RemoteConfig;
44
+ private etag;
45
+ private timer?;
46
+ private readonly fetchFn;
47
+ constructor(o: RemoteSamplerOptions);
48
+ /** One poll; a failure or 304 keeps the current config. */
49
+ poll(): Promise<void>;
50
+ stop(): void;
51
+ shouldSample(_c: Context, traceId: string, name: string, _k: SpanKind, attributes: Attributes, _l: Link[]): SamplingResult;
52
+ toString(): string;
53
+ }
@@ -0,0 +1,91 @@
1
+ const NOT_RECORD = 0;
2
+ const RECORD_AND_SAMPLED = 2;
3
+ const FNV_OFFSET = 0xcbf29ce484222325n;
4
+ const FNV_PRIME = 0x100000001b3n;
5
+ const MASK = 0xffffffffffffffffn;
6
+ const TWO_64 = 18446744073709551616;
7
+ /** fnv64a of the trace id's bytes, as a fraction of 2^64; matches the gateway's `ratioKeeps`. */
8
+ export function traceFraction(traceIdHex) {
9
+ let h = FNV_OFFSET;
10
+ for (let i = 0; i + 1 < traceIdHex.length; i += 2)
11
+ h = ((h ^ BigInt(parseInt(traceIdHex.slice(i, i + 2), 16))) * FNV_PRIME) & MASK;
12
+ return Number(h) / TWO_64;
13
+ }
14
+ export function globMatches(glob, text) {
15
+ const re = glob.replace(/[.+^${}()|[\]\\]/g, '\\$&').replace(/\*/g, '.*').replace(/\?/g, '.');
16
+ return new RegExp(`^${re}$`, 's').test(text);
17
+ }
18
+ function ruleMatches(r, service, env, name, attrs) {
19
+ const m = r.match ?? {};
20
+ // duration and status are only known at the end of the span: the gateway decides those
21
+ if (m.min_duration_ms != null || m.status)
22
+ return false;
23
+ if ((m.service && m.service !== service) || (m.env && m.env !== env))
24
+ return false;
25
+ if (m.span_name_prefix && !name.startsWith(m.span_name_prefix))
26
+ return false;
27
+ if (m.span_name_glob && !globMatches(m.span_name_glob, name))
28
+ return false;
29
+ if (m.span_name_regex) {
30
+ try {
31
+ if (!new RegExp(m.span_name_regex).test(name))
32
+ return false;
33
+ }
34
+ catch {
35
+ return false;
36
+ }
37
+ }
38
+ return Object.entries(m.attrs ?? {}).every(([k, v]) => String(attrs[k]) === v);
39
+ }
40
+ /** The keep ratio for a span under `cfg` (1 = keep). First matching ratio/drop rule wins. */
41
+ export function ratioFor(cfg, service, env, name, attrs) {
42
+ if (cfg.strategyType === 'PROBABILISTIC')
43
+ return clamp(cfg.probabilisticSampling?.samplingRate);
44
+ for (const r of cfg.rules ?? []) {
45
+ if (r.enabled === false || !ruleMatches(r, service, env, name, attrs))
46
+ continue;
47
+ if (r.action?.kind === 'drop')
48
+ return 0;
49
+ if (r.action?.kind === 'ratio' && r.action.ratio != null)
50
+ return clamp(r.action.ratio);
51
+ return 1; // keep, tail, rate: decided later
52
+ }
53
+ return 1;
54
+ }
55
+ const clamp = (r) => (typeof r === 'number' && Number.isFinite(r) ? Math.min(1, Math.max(0, r)) : 1);
56
+ export class RemoteSampler {
57
+ o;
58
+ cfg = {};
59
+ etag = '';
60
+ timer;
61
+ fetchFn;
62
+ constructor(o) {
63
+ this.o = o;
64
+ this.fetchFn = o.fetch ?? globalThis.fetch;
65
+ void this.poll();
66
+ this.timer = setInterval(() => void this.poll(), Math.max(1000, o.intervalMs ?? 30_000));
67
+ this.timer.unref?.();
68
+ }
69
+ /** One poll; a failure or 304 keeps the current config. */
70
+ async poll() {
71
+ try {
72
+ const q = new URLSearchParams({ service: this.o.service, ...(this.o.env ? { env: this.o.env } : {}) });
73
+ const res = await this.fetchFn(`${this.o.endpoint}/v1/sampling?${q}`, {
74
+ headers: { ...this.o.headers, ...(this.etag ? { 'If-None-Match': this.etag } : {}) },
75
+ });
76
+ if (res.status === 304 || !res.ok)
77
+ return;
78
+ this.cfg = (await res.json());
79
+ this.etag = res.headers.get('ETag') ?? '';
80
+ }
81
+ catch { /* fallback: keep the last good config */ }
82
+ }
83
+ stop() { if (this.timer)
84
+ clearInterval(this.timer); }
85
+ shouldSample(_c, traceId, name, _k, attributes, _l) {
86
+ const r = ratioFor(this.cfg, this.o.service, this.o.env ?? '', name, attributes);
87
+ const keep = r >= 1 || (r > 0 && traceFraction(traceId) < r);
88
+ return { decision: keep ? RECORD_AND_SAMPLED : NOT_RECORD };
89
+ }
90
+ toString() { return 'WatchtowerRemoteSampler'; }
91
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@watchtowerobservability/node",
3
- "version": "0.4.0",
3
+ "version": "0.6.0",
4
4
  "repository": {
5
5
  "type": "git",
6
6
  "url": "git+https://github.com/watchtowerobservability/watchtower-node.git"
@@ -346,43 +346,115 @@
346
346
  "types": "./dist/cjs/profiling.d.ts",
347
347
  "default": "./dist/cjs/profiling.js"
348
348
  }
349
+ },
350
+ "./register": {
351
+ "import": {
352
+ "types": "./dist/esm/register.d.ts",
353
+ "default": "./dist/esm/register.js"
354
+ },
355
+ "require": {
356
+ "types": "./dist/cjs/register.d.ts",
357
+ "default": "./dist/cjs/register.js"
358
+ }
349
359
  }
350
360
  },
351
361
  "license": "Apache-2.0",
352
362
  "engines": {
353
- "node": ">=18"
363
+ "node": ">=22.15"
354
364
  },
355
365
  "scripts": {
356
366
  "build": "node scripts/build.mjs",
357
367
  "typecheck": "tsc --noEmit -p tsconfig.json",
358
368
  "test": "vitest run",
359
- "prepack": "npm run build"
369
+ "prepack": "npm run build",
370
+ "smoke": "node scripts/smoke-pack.mjs"
360
371
  },
361
372
  "dependencies": {
362
- "@opentelemetry/api": "^1.9.0",
363
- "@opentelemetry/exporter-logs-otlp-http": "^0.57.0",
364
- "@opentelemetry/exporter-metrics-otlp-http": "^0.57.0",
365
- "@opentelemetry/exporter-trace-otlp-http": "^0.57.0",
366
- "@opentelemetry/otlp-transformer": "^0.57.0",
367
- "@opentelemetry/resources": "^1.30.0",
368
- "@opentelemetry/sdk-logs": "^0.57.0",
369
- "@opentelemetry/sdk-metrics": "^1.30.0",
370
- "@opentelemetry/sdk-trace-base": "^1.30.0",
371
- "@opentelemetry/sdk-trace-node": "^1.30.0"
373
+ "@opentelemetry/api": "^1.10.0"
372
374
  },
373
375
  "peerDependencies": {
374
- "@opentelemetry/instrumentation-runtime-node": ">=0.12.0",
376
+ "@opentelemetry/context-async-hooks": "^3.1.0",
377
+ "@opentelemetry/core": "^3.1.0",
378
+ "@opentelemetry/exporter-logs-otlp-http": "^0.301.0",
379
+ "@opentelemetry/exporter-metrics-otlp-http": "^0.301.0",
380
+ "@opentelemetry/exporter-trace-otlp-http": "^0.301.0",
381
+ "@opentelemetry/instrumentation": ">=0.200.0",
382
+ "@opentelemetry/instrumentation-http": ">=0.200.0",
383
+ "@opentelemetry/instrumentation-ioredis": ">=0.50.0",
384
+ "@opentelemetry/instrumentation-pg": ">=0.50.0",
385
+ "@opentelemetry/instrumentation-runtime-node": ">=0.38.0",
386
+ "@opentelemetry/instrumentation-undici": ">=0.10.0",
387
+ "@opentelemetry/otlp-transformer": "^0.301.0",
388
+ "@opentelemetry/resources": "^3.1.0",
389
+ "@opentelemetry/sdk-logs": "^3.1.0",
390
+ "@opentelemetry/sdk-metrics": "^3.1.0",
391
+ "@opentelemetry/sdk-trace": "^3.1.0",
375
392
  "winston-transport": "^4.0.0"
376
393
  },
377
394
  "peerDependenciesMeta": {
395
+ "@opentelemetry/context-async-hooks": {
396
+ "optional": true
397
+ },
398
+ "@opentelemetry/core": {
399
+ "optional": true
400
+ },
401
+ "@opentelemetry/exporter-logs-otlp-http": {
402
+ "optional": true
403
+ },
404
+ "@opentelemetry/exporter-metrics-otlp-http": {
405
+ "optional": true
406
+ },
407
+ "@opentelemetry/exporter-trace-otlp-http": {
408
+ "optional": true
409
+ },
410
+ "@opentelemetry/instrumentation": {
411
+ "optional": true
412
+ },
413
+ "@opentelemetry/instrumentation-http": {
414
+ "optional": true
415
+ },
416
+ "@opentelemetry/instrumentation-ioredis": {
417
+ "optional": true
418
+ },
419
+ "@opentelemetry/instrumentation-pg": {
420
+ "optional": true
421
+ },
378
422
  "@opentelemetry/instrumentation-runtime-node": {
379
423
  "optional": true
380
424
  },
425
+ "@opentelemetry/instrumentation-undici": {
426
+ "optional": true
427
+ },
428
+ "@opentelemetry/otlp-transformer": {
429
+ "optional": true
430
+ },
431
+ "@opentelemetry/resources": {
432
+ "optional": true
433
+ },
434
+ "@opentelemetry/sdk-logs": {
435
+ "optional": true
436
+ },
437
+ "@opentelemetry/sdk-metrics": {
438
+ "optional": true
439
+ },
440
+ "@opentelemetry/sdk-trace": {
441
+ "optional": true
442
+ },
381
443
  "winston-transport": {
382
444
  "optional": true
383
445
  }
384
446
  },
385
447
  "devDependencies": {
448
+ "@opentelemetry/context-async-hooks": "^3.1.0",
449
+ "@opentelemetry/core": "^3.1.0",
450
+ "@opentelemetry/exporter-logs-otlp-http": "^0.301.0",
451
+ "@opentelemetry/exporter-metrics-otlp-http": "^0.301.0",
452
+ "@opentelemetry/exporter-trace-otlp-http": "^0.301.0",
453
+ "@opentelemetry/otlp-transformer": "^0.301.0",
454
+ "@opentelemetry/resources": "^3.1.0",
455
+ "@opentelemetry/sdk-logs": "^3.1.0",
456
+ "@opentelemetry/sdk-metrics": "^3.1.0",
457
+ "@opentelemetry/sdk-trace": "^3.1.0",
386
458
  "@types/node": "22.15.0",
387
459
  "typescript": "5.7.2",
388
460
  "vitest": "5.0.5",