@watchtowerobservability/node 0.5.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.
- package/README.md +39 -8
- package/dist/cjs/env.d.ts +12 -0
- package/dist/cjs/env.js +37 -0
- package/dist/cjs/errors.d.ts +8 -0
- package/dist/cjs/errors.js +23 -0
- package/dist/cjs/index.d.ts +29 -9
- package/dist/cjs/index.js +87 -49
- package/dist/cjs/instrument.d.ts +7 -0
- package/dist/cjs/instrument.js +51 -0
- package/dist/cjs/integrations/genai-agents.d.ts +4 -1
- package/dist/cjs/integrations/genai-agents.js +27 -24
- package/dist/cjs/integrations/genai-frameworks.d.ts +25 -0
- package/dist/cjs/integrations/genai-frameworks.js +211 -0
- package/dist/cjs/integrations/genai.d.ts +1 -0
- package/dist/cjs/integrations/genai.js +7 -2
- package/dist/cjs/integrations/next.d.ts +4 -1
- package/dist/cjs/integrations/next.js +13 -7
- package/dist/cjs/load.js +36 -5
- package/dist/cjs/origin.d.ts +9 -0
- package/dist/cjs/origin.js +43 -0
- package/dist/cjs/redact.d.ts +8 -0
- package/dist/cjs/redact.js +43 -0
- package/dist/cjs/register.d.ts +1 -0
- package/dist/cjs/register.js +29 -0
- package/dist/cjs/sampling.d.ts +53 -0
- package/dist/cjs/sampling.js +98 -0
- package/dist/esm/env.d.ts +12 -0
- package/dist/esm/env.js +33 -0
- package/dist/esm/errors.d.ts +8 -0
- package/dist/esm/errors.js +22 -0
- package/dist/esm/index.d.ts +29 -9
- package/dist/esm/index.js +87 -50
- package/dist/esm/instrument.d.ts +7 -0
- package/dist/esm/instrument.js +48 -0
- package/dist/esm/integrations/genai-agents.d.ts +4 -1
- package/dist/esm/integrations/genai-agents.js +4 -4
- package/dist/esm/integrations/genai-frameworks.d.ts +25 -0
- package/dist/esm/integrations/genai-frameworks.js +206 -0
- package/dist/esm/integrations/genai.d.ts +1 -0
- package/dist/esm/integrations/genai.js +3 -1
- package/dist/esm/integrations/next.d.ts +4 -1
- package/dist/esm/integrations/next.js +11 -6
- package/dist/esm/load.js +78 -2
- package/dist/esm/origin.d.ts +9 -0
- package/dist/esm/origin.js +39 -0
- package/dist/esm/redact.d.ts +8 -0
- package/dist/esm/redact.js +39 -0
- package/dist/esm/register.d.ts +1 -0
- package/dist/esm/register.js +27 -0
- package/dist/esm/sampling.d.ts +53 -0
- package/dist/esm/sampling.js +91 -0
- package/package.json +33 -2
|
@@ -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.
|
|
3
|
+
"version": "0.6.0",
|
|
4
4
|
"repository": {
|
|
5
5
|
"type": "git",
|
|
6
6
|
"url": "git+https://github.com/watchtowerobservability/watchtower-node.git"
|
|
@@ -346,6 +346,16 @@
|
|
|
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",
|
|
@@ -356,7 +366,8 @@
|
|
|
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
373
|
"@opentelemetry/api": "^1.10.0"
|
|
@@ -367,7 +378,12 @@
|
|
|
367
378
|
"@opentelemetry/exporter-logs-otlp-http": "^0.301.0",
|
|
368
379
|
"@opentelemetry/exporter-metrics-otlp-http": "^0.301.0",
|
|
369
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",
|
|
370
385
|
"@opentelemetry/instrumentation-runtime-node": ">=0.38.0",
|
|
386
|
+
"@opentelemetry/instrumentation-undici": ">=0.10.0",
|
|
371
387
|
"@opentelemetry/otlp-transformer": "^0.301.0",
|
|
372
388
|
"@opentelemetry/resources": "^3.1.0",
|
|
373
389
|
"@opentelemetry/sdk-logs": "^3.1.0",
|
|
@@ -391,9 +407,24 @@
|
|
|
391
407
|
"@opentelemetry/exporter-trace-otlp-http": {
|
|
392
408
|
"optional": true
|
|
393
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
|
+
},
|
|
394
422
|
"@opentelemetry/instrumentation-runtime-node": {
|
|
395
423
|
"optional": true
|
|
396
424
|
},
|
|
425
|
+
"@opentelemetry/instrumentation-undici": {
|
|
426
|
+
"optional": true
|
|
427
|
+
},
|
|
397
428
|
"@opentelemetry/otlp-transformer": {
|
|
398
429
|
"optional": true
|
|
399
430
|
},
|