@ddd-ts-kit/tracing 0.0.0-stage → 0.1.1

package/dist/local-root/correlate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"correlate.d.ts","sourceRoot":"","sources":["../../src/local-root/correlate.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAEjD,eAAO,MAAM,wBAAwB,uBAAuB,CAAC;AAC7D,eAAO,MAAM,gBAAgB,eAAe,CAAC;AAE7C;;;GAGG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI,CAmB/C"}

package/dist/local-root/correlate.js

@@ -0,0 +1,23 @@
+import { tracingConfiguration } from '../configuration/configure-tracing.js';
+export const CORRELATION_ID_ATTRIBUTE = 'app.correlation_id';
+export const ORIGIN_ATTRIBUTE = 'app.origin';
+/**
+ * Names the execution context on the local root, once. Identifiers of the work only: who acts
+ * and for which tenant never become span attributes.
+ */
+export function correlate(root) {
+    if (root.correlated) {
+        return;
+    }
+    const execution = tracingConfiguration().executionScope?.current();
+    if (execution === undefined) {
+        return;
+    }
+    root.correlated = true;
+    if (!root.span.isRecording()) {
+        return;
+    }
+    root.span.setAttribute(CORRELATION_ID_ATTRIBUTE, execution.correlationId);
+    root.span.setAttribute(ORIGIN_ATTRIBUTE, execution.origin);
+}
+//# sourceMappingURL=correlate.js.map

package/dist/local-root/correlate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"correlate.js","sourceRoot":"","sources":["../../src/local-root/correlate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAC;AAG7E,MAAM,CAAC,MAAM,wBAAwB,GAAG,oBAAoB,CAAC;AAC7D,MAAM,CAAC,MAAM,gBAAgB,GAAG,YAAY,CAAC;AAE7C;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAC,IAAe;IACvC,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;QACpB,OAAO;IACT,CAAC;IAED,MAAM,SAAS,GAAG,oBAAoB,EAAE,CAAC,cAAc,EAAE,OAAO,EAAE,CAAC;IAEnE,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,OAAO;IACT,CAAC;IAED,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;IAEvB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QAC7B,OAAO;IACT,CAAC;IAED,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,wBAAwB,EAAE,SAAS,CAAC,aAAa,CAAC,CAAC;IAC1E,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;AAC7D,CAAC"}

package/dist/local-root/local-root-tracker.d.ts

@@ -0,0 +1,18 @@
+import { type Context, type Span } from '@opentelemetry/api';
+/**
+ * Span processor that remembers, for every span, the local root it belongs to (the
+ * first span of the trace in this process: no parent, or a remote one). Add it to the
+ * tracer provider to enable the per-root cap of dependency spans; without it the cap is
+ * not applied. Structurally compatible with the SDK `SpanProcessor`.
+ *
+ * With `configureTracing({ executionScope })`, it also names the correlation id and the origin
+ * of the work on the local root, as soon as a span starts inside the execution scope: the root
+ * itself usually starts before the boundary opened the scope.
+ */
+export declare class LocalRootTracker {
+    onStart(span: Span, parentContext: Context): void;
+    onEnd(): void;
+    forceFlush(): Promise<void>;
+    shutdown(): Promise<void>;
+}
+//# sourceMappingURL=local-root-tracker.d.ts.map

package/dist/local-root/local-root-tracker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-root-tracker.d.ts","sourceRoot":"","sources":["../../src/local-root/local-root-tracker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,KAAK,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAIpE;;;;;;;;;GASG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,GAAG,IAAI,CAOhD;IAED,KAAK,IAAI,IAAI,CAAG;IAEV,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAG;IAE9B,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAG;CACnC"}

package/dist/local-root/local-root-tracker.js

@@ -0,0 +1,26 @@
+import { trace } from '@opentelemetry/api';
+import { correlate } from './correlate.js';
+import { localRoots } from './local-roots.js';
+/**
+ * Span processor that remembers, for every span, the local root it belongs to (the
+ * first span of the trace in this process: no parent, or a remote one). Add it to the
+ * tracer provider to enable the per-root cap of dependency spans; without it the cap is
+ * not applied. Structurally compatible with the SDK `SpanProcessor`.
+ *
+ * With `configureTracing({ executionScope })`, it also names the correlation id and the origin
+ * of the work on the local root, as soon as a span starts inside the execution scope: the root
+ * itself usually starts before the boundary opened the scope.
+ */
+export class LocalRootTracker {
+    onStart(span, parentContext) {
+        const parent = trace.getSpan(parentContext);
+        const inherited = parent === undefined ? undefined : localRoots.get(parent);
+        const root = inherited ?? { span, perName: new Map(), total: 0, dropped: 0, correlated: false };
+        localRoots.set(span, root);
+        correlate(root);
+    }
+    onEnd() { }
+    async forceFlush() { }
+    async shutdown() { }
+}
+//# sourceMappingURL=local-root-tracker.js.map

package/dist/local-root/local-root-tracker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-root-tracker.js","sourceRoot":"","sources":["../../src/local-root/local-root-tracker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAA2B,MAAM,oBAAoB,CAAC;AACpE,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C;;;;;;;;;GASG;AACH,MAAM,OAAO,gBAAgB;IAC3B,OAAO,CAAC,IAAU,EAAE,aAAsB;QACxC,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC5C,MAAM,SAAS,GAAG,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC5E,MAAM,IAAI,GAAG,SAAS,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,GAAG,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;QAEhG,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC3B,SAAS,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC;IAED,KAAK,KAAU,CAAC;IAEhB,KAAK,CAAC,UAAU,KAAmB,CAAC;IAEpC,KAAK,CAAC,QAAQ,KAAmB,CAAC;CACnC"}

package/dist/local-root/local-root.d.ts

@@ -0,0 +1,11 @@
+import type { Span } from '@opentelemetry/api';
+/** The first span of a trace in this process, and what was counted under it. */
+export interface LocalRoot {
+    readonly span: Span;
+    readonly perName: Map<string, number>;
+    total: number;
+    dropped: number;
+    /** Whether the span already names the execution context it belongs to. */
+    correlated: boolean;
+}
+//# sourceMappingURL=local-root.d.ts.map

package/dist/local-root/local-root.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-root.d.ts","sourceRoot":"","sources":["../../src/local-root/local-root.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAE/C,gFAAgF;AAChF,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,0EAA0E;IAC1E,UAAU,EAAE,OAAO,CAAC;CACrB"}

package/dist/local-root/local-root.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=local-root.js.map

package/dist/local-root/local-root.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-root.js","sourceRoot":"","sources":["../../src/local-root/local-root.ts"],"names":[],"mappings":""}

package/dist/local-root/local-roots.d.ts

@@ -0,0 +1,4 @@
+import type { Span } from '@opentelemetry/api';
+import type { LocalRoot } from './local-root.js';
+export declare const localRoots: WeakMap<Span, LocalRoot>;
+//# sourceMappingURL=local-roots.d.ts.map

package/dist/local-root/local-roots.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-roots.d.ts","sourceRoot":"","sources":["../../src/local-root/local-roots.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAIjD,eAAO,MAAM,UAAU,0BAAiC,CAAC"}

package/dist/local-root/local-roots.js

@@ -0,0 +1,4 @@
+// Keyed by span object: the SDK hands the same object to the processor and to the
+// context, and a WeakMap needs no cleanup when a trace ends.
+export const localRoots = new WeakMap();
+//# sourceMappingURL=local-roots.js.map

package/dist/local-root/local-roots.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"local-roots.js","sourceRoot":"","sources":["../../src/local-root/local-roots.ts"],"names":[],"mappings":"AAGA,kFAAkF;AAClF,6DAA6D;AAC7D,MAAM,CAAC,MAAM,UAAU,GAAG,IAAI,OAAO,EAAmB,CAAC"}

package/dist/local-root/work-attributes.d.ts

@@ -0,0 +1,4 @@
+import type { Attributes } from '@opentelemetry/api';
+/** The correlation id and the origin of the unit of work in progress, for the span that starts it. Empty outside of one. */
+export declare function workAttributes(): Attributes;
+//# sourceMappingURL=work-attributes.d.ts.map

package/dist/local-root/work-attributes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"work-attributes.d.ts","sourceRoot":"","sources":["../../src/local-root/work-attributes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAIrD,4HAA4H;AAC5H,wBAAgB,cAAc,IAAI,UAAU,CAQ3C"}

package/dist/local-root/work-attributes.js

@@ -0,0 +1,11 @@
+import { tracingConfiguration } from '../configuration/configure-tracing.js';
+import { CORRELATION_ID_ATTRIBUTE, ORIGIN_ATTRIBUTE } from './correlate.js';
+/** The correlation id and the origin of the unit of work in progress, for the span that starts it. Empty outside of one. */
+export function workAttributes() {
+    const execution = tracingConfiguration().executionScope?.current();
+    if (execution === undefined) {
+        return {};
+    }
+    return { [CORRELATION_ID_ATTRIBUTE]: execution.correlationId, [ORIGIN_ATTRIBUTE]: execution.origin };
+}
+//# sourceMappingURL=work-attributes.js.map

package/dist/local-root/work-attributes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"work-attributes.js","sourceRoot":"","sources":["../../src/local-root/work-attributes.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAC;AAC7E,OAAO,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAE5E,4HAA4H;AAC5H,MAAM,UAAU,cAAc;IAC5B,MAAM,SAAS,GAAG,oBAAoB,EAAE,CAAC,cAAc,EAAE,OAAO,EAAE,CAAC;IAEnE,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,EAAE,CAAC,wBAAwB,CAAC,EAAE,SAAS,CAAC,aAAa,EAAE,CAAC,gBAAgB,CAAC,EAAE,SAAS,CAAC,MAAM,EAAE,CAAC;AACvG,CAAC"}

package/dist/node/default-instrumentations.d.ts

@@ -0,0 +1,20 @@
+import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';
+export type AutoInstrumentationSettings = NonNullable<Parameters<typeof getNodeAutoInstrumentations>[0]>;
+export interface DefaultInstrumentationsOptions {
+    /** Paths whose incoming requests get no span. Default `NOISE_PATHS`. */
+    readonly ignoredPaths?: readonly string[];
+    /** Merged over the defaults, per instrumentation: `{ '@opentelemetry/instrumentation-fs': { enabled: true } }`. */
+    readonly settings?: AutoInstrumentationSettings;
+}
+/**
+ * Off: plumbing and duplicates. `fs`, `dns` and `net` describe how a call was made, not what
+ * was done. Web framework layers (`express`, `connect`, `router`, `fastify`, `koa`, `hapi`,
+ * `restify`, `nestjs-core`) add a span per middleware where the kit names the request by its
+ * route. Broker clients (`amqplib`, `kafkajs`) would double the `publish` and `process` spans
+ * of the kit. Query builders, pools and loaders (`knex`, `generic-pool`, `dataloader`,
+ * `lru-memoizer`, `mongoose`) repeat what the driver says. Logging bridges and runtime metrics
+ * are no trace matter. An instrumentation a later version of the bundle adds keeps the default
+ * of the bundle until it is listed here.
+ */
+export declare function defaultInstrumentations(options?: DefaultInstrumentationsOptions): ReturnType<typeof getNodeAutoInstrumentations>;
+//# sourceMappingURL=default-instrumentations.d.ts.map

package/dist/node/default-instrumentations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-instrumentations.d.ts","sourceRoot":"","sources":["../../src/node/default-instrumentations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,2CAA2C,CAAC;AAKxF,MAAM,MAAM,2BAA2B,GAAG,WAAW,CAAC,UAAU,CAAC,OAAO,2BAA2B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAEzG,MAAM,WAAW,8BAA8B;IAC7C,wEAAwE;IACxE,QAAQ,CAAC,YAAY,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1C,mHAAmH;IACnH,QAAQ,CAAC,QAAQ,CAAC,EAAE,2BAA2B,CAAC;CACjD;AAwBD;;;;;;;;;GASG;AACH,wBAAgB,uBAAuB,CACrC,OAAO,GAAE,8BAAmC,GAC3C,UAAU,CAAC,OAAO,2BAA2B,CAAC,CAchD"}

package/dist/node/default-instrumentations.js

@@ -0,0 +1,55 @@
+import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';
+import { isNoisePath } from '../http/is-noise-path.js';
+import { NOISE_PATHS } from '../http/noise-paths.js';
+import { INSTRUMENTATIONS_OFF } from './instrumentations-off.js';
+/**
+ * On: what tells the story of an action. HTTP, as server and as client (`http`, `undici`, `grpc`),
+ * and the database and cache drivers, whose statements are recorded as written, with their
+ * placeholders and never the values bound to them, and only inside a trace: a poller or a
+ * pool that queries outside of any request makes no span.
+ */
+const KEPT = {
+    '@opentelemetry/instrumentation-http': {},
+    '@opentelemetry/instrumentation-undici': { requireParentforSpans: true },
+    '@opentelemetry/instrumentation-grpc': {},
+    '@opentelemetry/instrumentation-pg': {
+        requireParentSpan: true,
+        ignoreConnectSpans: true,
+        enhancedDatabaseReporting: false,
+    },
+    '@opentelemetry/instrumentation-mysql2': { maskStatement: true },
+    '@opentelemetry/instrumentation-mysql': { enhancedDatabaseReporting: false },
+    '@opentelemetry/instrumentation-mongodb': { requireParentSpan: true, enhancedDatabaseReporting: false },
+    '@opentelemetry/instrumentation-ioredis': { requireParentSpan: true },
+    '@opentelemetry/instrumentation-redis': { requireParentSpan: true },
+};
+/**
+ * Off: plumbing and duplicates. `fs`, `dns` and `net` describe how a call was made, not what
+ * was done. Web framework layers (`express`, `connect`, `router`, `fastify`, `koa`, `hapi`,
+ * `restify`, `nestjs-core`) add a span per middleware where the kit names the request by its
+ * route. Broker clients (`amqplib`, `kafkajs`) would double the `publish` and `process` spans
+ * of the kit. Query builders, pools and loaders (`knex`, `generic-pool`, `dataloader`,
+ * `lru-memoizer`, `mongoose`) repeat what the driver says. Logging bridges and runtime metrics
+ * are no trace matter. An instrumentation a later version of the bundle adds keeps the default
+ * of the bundle until it is listed here.
+ */
+export function defaultInstrumentations(options = {}) {
+    const ignoredPaths = options.ignoredPaths ?? NOISE_PATHS;
+    const settings = {
+        ...everythingElseOff(),
+        ...enabled(KEPT),
+        '@opentelemetry/instrumentation-http': {
+            enabled: true,
+            ignoreIncomingRequestHook: (request) => isNoisePath(request.url ?? '', ignoredPaths),
+        },
+        ...options.settings,
+    };
+    return getNodeAutoInstrumentations(settings);
+}
+function everythingElseOff() {
+    return Object.fromEntries(INSTRUMENTATIONS_OFF.map((name) => [name, { enabled: false }]));
+}
+function enabled(settings) {
+    return Object.fromEntries(Object.entries(settings).map(([name, config]) => [name, { ...config, enabled: true }]));
+}
+//# sourceMappingURL=default-instrumentations.js.map

package/dist/node/default-instrumentations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-instrumentations.js","sourceRoot":"","sources":["../../src/node/default-instrumentations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,2CAA2C,CAAC;AACxF,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAWjE;;;;;GAKG;AACH,MAAM,IAAI,GAAgC;IACxC,qCAAqC,EAAE,EAAE;IACzC,uCAAuC,EAAE,EAAE,qBAAqB,EAAE,IAAI,EAAE;IACxE,qCAAqC,EAAE,EAAE;IACzC,mCAAmC,EAAE;QACnC,iBAAiB,EAAE,IAAI;QACvB,kBAAkB,EAAE,IAAI;QACxB,yBAAyB,EAAE,KAAK;KACjC;IACD,uCAAuC,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE;IAChE,sCAAsC,EAAE,EAAE,yBAAyB,EAAE,KAAK,EAAE;IAC5E,wCAAwC,EAAE,EAAE,iBAAiB,EAAE,IAAI,EAAE,yBAAyB,EAAE,KAAK,EAAE;IACvG,wCAAwC,EAAE,EAAE,iBAAiB,EAAE,IAAI,EAAE;IACrE,sCAAsC,EAAE,EAAE,iBAAiB,EAAE,IAAI,EAAE;CACpE,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,UAAU,uBAAuB,CACrC,OAAO,GAAmC,EAAE;IAE5C,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,WAAW,CAAC;IAEzD,MAAM,QAAQ,GAAgC;QAC5C,GAAG,iBAAiB,EAAE;QACtB,GAAG,OAAO,CAAC,IAAI,CAAC;QAChB,qCAAqC,EAAE;YACrC,OAAO,EAAE,IAAI;YACb,yBAAyB,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,IAAI,EAAE,EAAE,YAAY,CAAC;SACrF;QACD,GAAG,OAAO,CAAC,QAAQ;KACpB,CAAC;IAEF,OAAO,2BAA2B,CAAC,QAAQ,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,iBAAiB;IACxB,OAAO,MAAM,CAAC,WAAW,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;AAC5F,CAAC;AAED,SAAS,OAAO,CAAC,QAAqC;IACpD,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AACpH,CAAC"}

package/dist/node/init-tracing.d.ts

@@ -0,0 +1,41 @@
+import { NodeSDK, tracing } from '@opentelemetry/sdk-node';
+import { type AutoInstrumentationSettings } from './default-instrumentations.js';
+type NodeSdkOptions = NonNullable<ConstructorParameters<typeof NodeSDK>[0]>;
+export interface InitTracingOptions {
+    readonly serviceName: string;
+    readonly serviceVersion?: string;
+    /** Reported as `deployment.environment.name`. */
+    readonly environment?: string;
+    /**
+     * Full OTLP/HTTP traces URL, for example `http://collector:4318/v1/traces`. Without
+     * it, the standard `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` and `OTEL_EXPORTER_OTLP_ENDPOINT`
+     * variables are honoured; with none of them, nothing is exported.
+     */
+    readonly exporterUrl?: string;
+    /**
+     * Share of new traces sampled, 0 to 1, decided where a trace starts: a sampled parent is
+     * always followed, so a trace is kept or dropped whole, across processes. Without it, the
+     * standard `OTEL_TRACES_SAMPLER` and `OTEL_TRACES_SAMPLER_ARG` variables are honoured, and
+     * by default every trace is kept. Keeping the traces that end in error whatever the ratio is
+     * tail sampling, which is the work of a collector: sample everything here and decide there.
+     */
+    readonly sampleRatio?: number;
+    /** Replaces the default instrumentations altogether. */
+    readonly instrumentations?: NonNullable<NodeSdkOptions['instrumentations']>;
+    /** Changes the settings of the default instrumentations, one by one: turns one on, or off, or configures it. */
+    readonly autoInstrumentations?: AutoInstrumentationSettings;
+    /** Paths whose incoming requests get no span. Default `NOISE_PATHS`: probes, metrics, documentation. */
+    readonly ignoredPaths?: readonly string[];
+    /** Attribute names, or prefixes ending with a dot, kept on spans besides `DEFAULT_ALLOWED_ATTRIBUTES`. */
+    readonly allowedAttributes?: readonly string[];
+    /** Run after the built-in scrubbing processors and before the exporter. */
+    readonly extraSpanProcessors?: readonly tracing.SpanProcessor[];
+    readonly enabled?: boolean;
+}
+export interface TracingHandle {
+    /** Flushes pending spans. Call it on SIGTERM, before the process exits. */
+    shutdown(): Promise<void>;
+}
+export declare function initTracing(options: InitTracingOptions): TracingHandle;
+export {};
+//# sourceMappingURL=init-tracing.d.ts.map

package/dist/node/init-tracing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"init-tracing.d.ts","sourceRoot":"","sources":["../../src/node/init-tracing.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,OAAO,EAAa,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAKtE,OAAO,EAA2B,KAAK,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAE1G,KAAK,cAAc,GAAG,WAAW,CAAC,qBAAqB,CAAC,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAE5E,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,iDAAiD;IACjD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;;;OAMG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,wDAAwD;IACxD,QAAQ,CAAC,gBAAgB,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC5E,gHAAgH;IAChH,QAAQ,CAAC,oBAAoB,CAAC,EAAE,2BAA2B,CAAC;IAC5D,wGAAwG;IACxG,QAAQ,CAAC,YAAY,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1C,0GAA0G;IAC1G,QAAQ,CAAC,iBAAiB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC/C,2EAA2E;IAC3E,QAAQ,CAAC,mBAAmB,CAAC,EAAE,SAAS,OAAO,CAAC,aAAa,EAAE,CAAC;IAChE,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,aAAa;IAC5B,2EAA2E;IAC3E,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3B;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,aAAa,CAsBtE"}

package/dist/node/init-tracing.js

@@ -0,0 +1,71 @@
+/*
+ * Node bootstrap. The only file of the package that loads the OpenTelemetry SDK.
+ *
+ * `initTracing` must run before any module that requires `http` or a database driver is
+ * loaded, otherwise auto-instrumentation registers too late and those modules stay
+ * unpatched. Make it the very first statement of `main.ts`. In an ES module, static
+ * imports are evaluated before the first statement, so there the call goes in a file of
+ * its own (`platform/tracing.ts`) that `main.ts` imports first, or that is preloaded
+ * with `node --import`. Packages published as ES modules additionally need the
+ * `@opentelemetry/instrumentation` loader hook; CommonJS packages and Node built-ins
+ * do not.
+ */
+import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
+import { NodeSDK, resources, tracing } from '@opentelemetry/sdk-node';
+import { LocalRootTracker } from '../local-root/local-root-tracker.js';
+import { AttributeAllowList } from '../processors/attribute-allow-list.js';
+import { ErrorMessageScrubber } from '../processors/error-message-scrubber.js';
+import { UrlSecretSpanProcessor } from '../processors/url-secret-span-processor.js';
+import { defaultInstrumentations } from './default-instrumentations.js';
+export function initTracing(options) {
+    if (options.enabled === false || process.env['OTEL_SDK_DISABLED']?.toLowerCase() === 'true') {
+        return { shutdown: async () => { } };
+    }
+    const sdk = new NodeSDK({
+        serviceName: options.serviceName,
+        resource: resourceOf(options),
+        spanProcessors: spanProcessorsOf(options),
+        instrumentations: options.instrumentations ?? [instrumentationsOf(options)],
+        ...(options.sampleRatio === undefined
+            ? {}
+            : {
+                sampler: new tracing.ParentBasedSampler({
+                    root: new tracing.TraceIdRatioBasedSampler(options.sampleRatio),
+                }),
+            }),
+    });
+    sdk.start();
+    return { shutdown: () => sdk.shutdown() };
+}
+function instrumentationsOf({ ignoredPaths, autoInstrumentations, }) {
+    return defaultInstrumentations({
+        ...(ignoredPaths === undefined ? {} : { ignoredPaths }),
+        ...(autoInstrumentations === undefined ? {} : { settings: autoInstrumentations }),
+    });
+}
+function resourceOf(options) {
+    return resources.defaultResource().merge(resources.resourceFromAttributes({
+        ...(options.serviceVersion === undefined ? {} : { 'service.version': options.serviceVersion }),
+        ...(options.environment === undefined ? {} : { 'deployment.environment.name': options.environment }),
+    }));
+}
+function spanProcessorsOf(options) {
+    const exporter = exporterFor(options);
+    return [
+        new LocalRootTracker(),
+        new UrlSecretSpanProcessor(),
+        new ErrorMessageScrubber(),
+        new AttributeAllowList(options.allowedAttributes === undefined ? {} : { alsoAllowed: options.allowedAttributes }),
+        ...(options.extraSpanProcessors ?? []),
+        ...(exporter === undefined ? [] : [new tracing.BatchSpanProcessor(exporter)]),
+    ];
+}
+function exporterFor(options) {
+    if (options.exporterUrl !== undefined) {
+        return new OTLPTraceExporter({ url: options.exporterUrl });
+    }
+    const fromEnvironment = process.env['OTEL_EXPORTER_OTLP_TRACES_ENDPOINT'] ?? process.env['OTEL_EXPORTER_OTLP_ENDPOINT'];
+    // The exporter reads the variables itself and appends `/v1/traces` where the spec says so.
+    return fromEnvironment ? new OTLPTraceExporter() : undefined;
+}
+//# sourceMappingURL=init-tracing.js.map

package/dist/node/init-tracing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"init-tracing.js","sourceRoot":"","sources":["../../src/node/init-tracing.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,OAAO,EAAE,iBAAiB,EAAE,MAAM,yCAAyC,CAAC;AAC5E,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAC3E,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAC;AAC/E,OAAO,EAAE,sBAAsB,EAAE,MAAM,4CAA4C,CAAC;AACpF,OAAO,EAAE,uBAAuB,EAAoC,MAAM,+BAA+B,CAAC;AAyC1G,MAAM,UAAU,WAAW,CAAC,OAA2B;IACrD,IAAI,OAAO,CAAC,OAAO,KAAK,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,EAAE,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;QAC5F,OAAO,EAAE,QAAQ,EAAE,KAAK,IAAI,EAAE,GAAE,CAAC,EAAE,CAAC;IACtC,CAAC;IAED,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC;QACtB,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,QAAQ,EAAE,UAAU,CAAC,OAAO,CAAC;QAC7B,cAAc,EAAE,gBAAgB,CAAC,OAAO,CAAC;QACzC,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAC3E,GAAG,CAAC,OAAO,CAAC,WAAW,KAAK,SAAS;YACnC,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC;gBACE,OAAO,EAAE,IAAI,OAAO,CAAC,kBAAkB,CAAC;oBACtC,IAAI,EAAE,IAAI,OAAO,CAAC,wBAAwB,CAAC,OAAO,CAAC,WAAW,CAAC;iBAChE,CAAC;aACH,CAAC;KACP,CAAC,CAAC;IAEH,GAAG,CAAC,KAAK,EAAE,CAAC;IAEZ,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC;AAC5C,CAAC;AAED,SAAS,kBAAkB,CAAC,EAC1B,YAAY,EACZ,oBAAoB,GACD;IACnB,OAAO,uBAAuB,CAAC;QAC7B,GAAG,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC;QACvD,GAAG,CAAC,oBAAoB,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,oBAAoB,EAAE,CAAC;KAClF,CAAC,CAAC;AACL,CAAC;AAED,SAAS,UAAU,CAAC,OAA2B;IAC7C,OAAO,SAAS,CAAC,eAAe,EAAE,CAAC,KAAK,CACtC,SAAS,CAAC,sBAAsB,CAAC;QAC/B,GAAG,CAAC,OAAO,CAAC,cAAc,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,iBAAiB,EAAE,OAAO,CAAC,cAAc,EAAE,CAAC;QAC9F,GAAG,CAAC,OAAO,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,6BAA6B,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC;KACrG,CAAC,CACH,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,OAA2B;IACnD,MAAM,QAAQ,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IAEtC,OAAO;QACL,IAAI,gBAAgB,EAAE;QACtB,IAAI,sBAAsB,EAAE;QAC5B,IAAI,oBAAoB,EAAE;QAC1B,IAAI,kBAAkB,CAAC,OAAO,CAAC,iBAAiB,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,iBAAiB,EAAE,CAAC;QACjH,GAAG,CAAC,OAAO,CAAC,mBAAmB,IAAI,EAAE,CAAC;QACtC,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAAC;KAC9E,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,OAA2B;IAC9C,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QACtC,OAAO,IAAI,iBAAiB,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED,MAAM,eAAe,GACnB,OAAO,CAAC,GAAG,CAAC,oCAAoC,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;IAElG,2FAA2F;IAC3F,OAAO,eAAe,CAAC,CAAC,CAAC,IAAI,iBAAiB,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AAC/D,CAAC"}

package/dist/node/instrumentations-off.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The instrumentations of the bundle that are off by default: what is neither an HTTP side nor
+ * a database or cache driver. Named one by one, since listing the bundle would load them all.
+ */
+export declare const INSTRUMENTATIONS_OFF: readonly ['@opentelemetry/instrumentation-amqplib', '@opentelemetry/instrumentation-aws-lambda', '@opentelemetry/instrumentation-aws-sdk', '@opentelemetry/instrumentation-bunyan', '@opentelemetry/instrumentation-cassandra-driver', '@opentelemetry/instrumentation-connect', '@opentelemetry/instrumentation-cucumber', '@opentelemetry/instrumentation-dataloader', '@opentelemetry/instrumentation-dns', '@opentelemetry/instrumentation-express', '@opentelemetry/instrumentation-fs', '@opentelemetry/instrumentation-generic-pool', '@opentelemetry/instrumentation-graphql', '@opentelemetry/instrumentation-hapi', '@opentelemetry/instrumentation-host-metrics', '@opentelemetry/instrumentation-kafkajs', '@opentelemetry/instrumentation-knex', '@opentelemetry/instrumentation-koa', '@opentelemetry/instrumentation-lru-memoizer', '@opentelemetry/instrumentation-memcached', '@opentelemetry/instrumentation-mongoose', '@opentelemetry/instrumentation-nestjs-core', '@opentelemetry/instrumentation-net', '@opentelemetry/instrumentation-openai', '@opentelemetry/instrumentation-oracledb', '@opentelemetry/instrumentation-pino', '@opentelemetry/instrumentation-restify', '@opentelemetry/instrumentation-router', '@opentelemetry/instrumentation-runtime-node', '@opentelemetry/instrumentation-socket.io', '@opentelemetry/instrumentation-tedious', '@opentelemetry/instrumentation-winston'];
+//# sourceMappingURL=instrumentations-off.d.ts.map

package/dist/node/instrumentations-off.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"instrumentations-off.d.ts","sourceRoot":"","sources":["../../src/node/instrumentations-off.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,eAAO,MAAM,oBAAoB,YAC/B,wCAAwC,EACxC,2CAA2C,EAC3C,wCAAwC,EACxC,uCAAuC,EACvC,iDAAiD,EACjD,wCAAwC,EACxC,yCAAyC,EACzC,2CAA2C,EAC3C,oCAAoC,EACpC,wCAAwC,EACxC,mCAAmC,EACnC,6CAA6C,EAC7C,wCAAwC,EACxC,qCAAqC,EACrC,6CAA6C,EAC7C,wCAAwC,EACxC,qCAAqC,EACrC,oCAAoC,EACpC,6CAA6C,EAC7C,0CAA0C,EAC1C,yCAAyC,EACzC,4CAA4C,EAC5C,oCAAoC,EACpC,uCAAuC,EACvC,yCAAyC,EACzC,qCAAqC,EACrC,wCAAwC,EACxC,uCAAuC,EACvC,6CAA6C,EAC7C,0CAA0C,EAC1C,wCAAwC,EACxC,wCAAwC,CAChC,CAAC"}

package/dist/node/instrumentations-off.js

@@ -0,0 +1,39 @@
+/**
+ * The instrumentations of the bundle that are off by default: what is neither an HTTP side nor
+ * a database or cache driver. Named one by one, since listing the bundle would load them all.
+ */
+export const INSTRUMENTATIONS_OFF = [
+    '@opentelemetry/instrumentation-amqplib',
+    '@opentelemetry/instrumentation-aws-lambda',
+    '@opentelemetry/instrumentation-aws-sdk',
+    '@opentelemetry/instrumentation-bunyan',
+    '@opentelemetry/instrumentation-cassandra-driver',
+    '@opentelemetry/instrumentation-connect',
+    '@opentelemetry/instrumentation-cucumber',
+    '@opentelemetry/instrumentation-dataloader',
+    '@opentelemetry/instrumentation-dns',
+    '@opentelemetry/instrumentation-express',
+    '@opentelemetry/instrumentation-fs',
+    '@opentelemetry/instrumentation-generic-pool',
+    '@opentelemetry/instrumentation-graphql',
+    '@opentelemetry/instrumentation-hapi',
+    '@opentelemetry/instrumentation-host-metrics',
+    '@opentelemetry/instrumentation-kafkajs',
+    '@opentelemetry/instrumentation-knex',
+    '@opentelemetry/instrumentation-koa',
+    '@opentelemetry/instrumentation-lru-memoizer',
+    '@opentelemetry/instrumentation-memcached',
+    '@opentelemetry/instrumentation-mongoose',
+    '@opentelemetry/instrumentation-nestjs-core',
+    '@opentelemetry/instrumentation-net',
+    '@opentelemetry/instrumentation-openai',
+    '@opentelemetry/instrumentation-oracledb',
+    '@opentelemetry/instrumentation-pino',
+    '@opentelemetry/instrumentation-restify',
+    '@opentelemetry/instrumentation-router',
+    '@opentelemetry/instrumentation-runtime-node',
+    '@opentelemetry/instrumentation-socket.io',
+    '@opentelemetry/instrumentation-tedious',
+    '@opentelemetry/instrumentation-winston',
+];
+//# sourceMappingURL=instrumentations-off.js.map

package/dist/node/instrumentations-off.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"instrumentations-off.js","sourceRoot":"","sources":["../../src/node/instrumentations-off.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,wCAAwC;IACxC,2CAA2C;IAC3C,wCAAwC;IACxC,uCAAuC;IACvC,iDAAiD;IACjD,wCAAwC;IACxC,yCAAyC;IACzC,2CAA2C;IAC3C,oCAAoC;IACpC,wCAAwC;IACxC,mCAAmC;IACnC,6CAA6C;IAC7C,wCAAwC;IACxC,qCAAqC;IACrC,6CAA6C;IAC7C,wCAAwC;IACxC,qCAAqC;IACrC,oCAAoC;IACpC,6CAA6C;IAC7C,0CAA0C;IAC1C,yCAAyC;IACzC,4CAA4C;IAC5C,oCAAoC;IACpC,uCAAuC;IACvC,yCAAyC;IACzC,qCAAqC;IACrC,wCAAwC;IACxC,uCAAuC;IACvC,6CAA6C;IAC7C,0CAA0C;IAC1C,wCAAwC;IACxC,wCAAwC;CAChC,CAAC"}

package/dist/node.d.ts

@@ -0,0 +1,3 @@
+export { defaultInstrumentations, type AutoInstrumentationSettings, type DefaultInstrumentationsOptions, } from './node/default-instrumentations.js';
+export { initTracing, type InitTracingOptions, type TracingHandle } from './node/init-tracing.js';
+//# sourceMappingURL=node.d.ts.map

package/dist/node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../src/node.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,KAAK,2BAA2B,EAChC,KAAK,8BAA8B,GACpC,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,KAAK,aAAa,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/node.js

@@ -0,0 +1,3 @@
+export { defaultInstrumentations, } from './node/default-instrumentations.js';
+export { initTracing } from './node/init-tracing.js';
+//# sourceMappingURL=node.js.map

package/dist/node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.js","sourceRoot":"","sources":["../src/node.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,GAGxB,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,WAAW,EAA+C,MAAM,wBAAwB,CAAC"}

package/dist/processors/attribute-allow-list.d.ts

@@ -0,0 +1,25 @@
+import type { EndedSpan } from './ended-span.js';
+export interface AttributeAllowListOptions {
+    /** Replaces the default list. A name ending with a dot allows every attribute below it. */
+    readonly allowed?: readonly string[];
+    /** Added to the list in use. */
+    readonly alsoAllowed?: readonly string[];
+}
+/**
+ * Keeps on every span, and on its events, only the attributes of the allow-list: request and
+ * response headers, bodies, query parameter values of a database call, user and client
+ * identifiers an instrumentation may record never reach the exporter. Register it BEFORE the
+ * exporting processor.
+ */
+export declare class AttributeAllowList {
+    private readonly names;
+    private readonly prefixes;
+    constructor(options?: AttributeAllowListOptions);
+    onStart(): void;
+    onEnd(span: EndedSpan): void;
+    forceFlush(): Promise<void>;
+    shutdown(): Promise<void>;
+    private prune;
+    private allows;
+}
+//# sourceMappingURL=attribute-allow-list.d.ts.map

package/dist/processors/attribute-allow-list.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"attribute-allow-list.d.ts","sourceRoot":"","sources":["../../src/processors/attribute-allow-list.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAEjD,MAAM,WAAW,yBAAyB;IACxC,2FAA2F;IAC3F,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACrC,gCAAgC;IAChC,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC1C;AAED;;;;;GAKG;AACH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAsB;IAE5C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAoB;IAE7C,YAAY,OAAO,GAAE,yBAA8B,EAKlD;IAED,OAAO,IAAI,IAAI,CAAG;IAElB,KAAK,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI,CAQ3B;IAEK,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAG;IAE9B,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAG;IAElC,OAAO,CAAC,KAAK;IAQb,OAAO,CAAC,MAAM;CAGf"}

package/dist/processors/attribute-allow-list.js

@@ -0,0 +1,38 @@
+import { DEFAULT_ALLOWED_ATTRIBUTES } from './default-allowed-attributes.js';
+/**
+ * Keeps on every span, and on its events, only the attributes of the allow-list: request and
+ * response headers, bodies, query parameter values of a database call, user and client
+ * identifiers an instrumentation may record never reach the exporter. Register it BEFORE the
+ * exporting processor.
+ */
+export class AttributeAllowList {
+    names;
+    prefixes;
+    constructor(options = {}) {
+        const allowed = [...(options.allowed ?? DEFAULT_ALLOWED_ATTRIBUTES), ...(options.alsoAllowed ?? [])];
+        this.names = new Set(allowed.filter((name) => !name.endsWith('.')));
+        this.prefixes = allowed.filter((name) => name.endsWith('.'));
+    }
+    onStart() { }
+    onEnd(span) {
+        this.prune(span.attributes);
+        for (const event of span.events) {
+            if (event.attributes !== undefined) {
+                this.prune(event.attributes, 'exception.type');
+            }
+        }
+    }
+    async forceFlush() { }
+    async shutdown() { }
+    prune(attributes, ...kept) {
+        for (const name of Object.keys(attributes)) {
+            if (!kept.includes(name) && !this.allows(name)) {
+                Reflect.deleteProperty(attributes, name);
+            }
+        }
+    }
+    allows(name) {
+        return this.names.has(name) || this.prefixes.some((prefix) => name.startsWith(prefix));
+    }
+}
+//# sourceMappingURL=attribute-allow-list.js.map

package/dist/processors/attribute-allow-list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attribute-allow-list.js","sourceRoot":"","sources":["../../src/processors/attribute-allow-list.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAC;AAU7E;;;;;GAKG;AACH,MAAM,OAAO,kBAAkB;IACZ,KAAK,CAAsB;IAE3B,QAAQ,CAAoB;IAE7C,YAAY,OAAO,GAA8B,EAAE;QACjD,MAAM,OAAO,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,0BAA0B,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,CAAC;QAErG,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACpE,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED,OAAO,KAAU,CAAC;IAElB,KAAK,CAAC,IAAe;QACnB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE5B,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;gBACnC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;YACjD,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,CAAC,UAAU,KAAmB,CAAC;IAEpC,KAAK,CAAC,QAAQ,KAAmB,CAAC;IAE1B,KAAK,CAAC,UAAmC,EAAE,GAAG,IAAuB;QAC3E,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAC3C,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC/C,OAAO,CAAC,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YAC3C,CAAC;QACH,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,IAAY;QACzB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;IACzF,CAAC;CACF"}

package/dist/processors/default-allowed-attributes.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Attribute names and prefixes (ending with a dot) a span may carry by default: what the kit
+ * writes (`app.`, `code.`, `messaging.`, `error.type`) and what the instrumentations kept on by
+ * default write about a request, a query or a peer. Whatever else an instrumentation adds is
+ * dropped before export.
+ */
+export declare const DEFAULT_ALLOWED_ATTRIBUTES: readonly string[];
+//# sourceMappingURL=default-allowed-attributes.d.ts.map

package/dist/processors/default-allowed-attributes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-allowed-attributes.d.ts","sourceRoot":"","sources":["../../src/processors/default-allowed-attributes.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,EAAE,SAAS,MAAM,EAwCvD,CAAC"}

package/dist/processors/default-allowed-attributes.js

@@ -0,0 +1,48 @@
+/**
+ * Attribute names and prefixes (ending with a dot) a span may carry by default: what the kit
+ * writes (`app.`, `code.`, `messaging.`, `error.type`) and what the instrumentations kept on by
+ * default write about a request, a query or a peer. Whatever else an instrumentation adds is
+ * dropped before export.
+ */
+export const DEFAULT_ALLOWED_ATTRIBUTES = [
+    'app.',
+    'code.',
+    'messaging.',
+    'error.type',
+    'http.request.method',
+    'http.request.method_original',
+    'http.request.resend_count',
+    'http.response.status_code',
+    'http.route',
+    'http.method',
+    'http.status_code',
+    'http.scheme',
+    'http.target',
+    'http.url',
+    'http.host',
+    'http.flavor',
+    'url.',
+    'server.',
+    'network.protocol.',
+    'network.transport',
+    'network.type',
+    'net.host.name',
+    'net.host.port',
+    'net.peer.name',
+    'net.peer.port',
+    'db.system',
+    'db.system.name',
+    'db.namespace',
+    'db.name',
+    'db.collection.name',
+    'db.operation',
+    'db.operation.name',
+    'db.sql.table',
+    'db.statement',
+    'db.query.text',
+    'db.query.summary',
+    'db.response.status_code',
+    'rpc.',
+    'otel.',
+];
+//# sourceMappingURL=default-allowed-attributes.js.map

package/dist/processors/default-allowed-attributes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-allowed-attributes.js","sourceRoot":"","sources":["../../src/processors/default-allowed-attributes.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAsB;IAC3D,MAAM;IACN,OAAO;IACP,YAAY;IACZ,YAAY;IACZ,qBAAqB;IACrB,8BAA8B;IAC9B,2BAA2B;IAC3B,2BAA2B;IAC3B,YAAY;IACZ,aAAa;IACb,kBAAkB;IAClB,aAAa;IACb,aAAa;IACb,UAAU;IACV,WAAW;IACX,aAAa;IACb,MAAM;IACN,SAAS;IACT,mBAAmB;IACnB,mBAAmB;IACnB,cAAc;IACd,eAAe;IACf,eAAe;IACf,eAAe;IACf,eAAe;IACf,WAAW;IACX,gBAAgB;IAChB,cAAc;IACd,SAAS;IACT,oBAAoB;IACpB,cAAc;IACd,mBAAmB;IACnB,cAAc;IACd,cAAc;IACd,eAAe;IACf,kBAAkB;IAClB,yBAAyB;IACzB,MAAM;IACN,OAAO;CACR,CAAC"}

package/dist/processors/ended-span.d.ts

@@ -0,0 +1,19 @@
+import type { Attributes, SpanStatus } from '@opentelemetry/api';
+/**
+ * The part of an ended SDK span the scrubbing processors touch. Declared here so the root
+ * entry depends on `@opentelemetry/api` only; the SDK `ReadableSpan` is assignable to it.
+ *
+ * Those processors edit the span in `onEnd`. The SDK types a span as read-only at that point
+ * and offers no supported way to rewrite an attribute or an event of a span created by someone
+ * else (auto-instrumentation). With sdk-trace-base 2.x the attributes, events and status are
+ * plain mutable objects, and exporters read them after every processor ran, so mutating them
+ * there is the usual approach. Register these processors BEFORE the exporting one.
+ */
+export interface EndedSpan {
+    attributes: Attributes;
+    events: {
+        attributes?: Attributes;
+    }[];
+    status: SpanStatus;
+}
+//# sourceMappingURL=ended-span.d.ts.map

package/dist/processors/ended-span.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ended-span.d.ts","sourceRoot":"","sources":["../../src/processors/ended-span.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAEjE;;;;;;;;;GASG;AACH,MAAM,WAAW,SAAS;IACxB,UAAU,EAAE,UAAU,CAAC;IACvB,MAAM,EAAE;QAAE,UAAU,CAAC,EAAE,UAAU,CAAA;KAAE,EAAE,CAAC;IACtC,MAAM,EAAE,UAAU,CAAC;CACpB"}

package/dist/processors/ended-span.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ended-span.js.map