@xeonr/upload-pool-sdk 1.3.0 → 1.4.0

package/dist/tracing.js

@@ -0,0 +1,270 @@
+/**
+ * OpenTelemetry tracing setup for the worker SDK.
+ *
+ * Spans are exported via OTLP/HTTP-JSON to pipeline-api's `/v1/traces`
+ * receiver, authenticated with the pool's queue token. The pipeline-api
+ * receiver decodes the OTLP envelope and writes spans to its MySQL trace
+ * store, which backs the `/admin/workflow-run` admin UI — so worker
+ * callbacks nest naturally under the dispatching parseUpload trace.
+ *
+ * Design notes (see also: discussion in epic plan):
+ *   - The TracerProvider is private to the SDK. It does *not* register
+ *     globally — calling `trace.getTracer(...)` outside the SDK won't pick
+ *     it up. This avoids interfering with any OTel setup the host
+ *     application already has (e.g. its own collector → Grafana
+ *     pipeline). The exporter ships SDK-emitted spans only.
+ *   - `wf.run_id` is stamped on every emitted span as an attribute,
+ *     mirrored from the job envelope's `wf_run_id` field. The pipeline-api
+ *     receiver uses this attribute to associate the span with the right
+ *     workflow run in `workflow_run_spans`.
+ *   - The W3C traceparent propagator runs on outbound RPC calls *only when
+ *     targeting the pipeline endpoint*. The uploads-api side has its own
+ *     OTel pipeline and we don't want to inject our trace_id into its
+ *     trees. See the interceptor in rpc-clients.ts.
+ *
+ * Body sanitization for `rpc.request` / `rpc.response` span events lives
+ * in the interceptor — keys matching /(token|secret|password|authorization
+ * |api[_-]?key|signature|sig|cookie)/i are redacted; payloads truncated
+ * to MAX_BODY_EVENT_BYTES.
+ */
+import { context, trace, SpanKind, SpanStatusCode, } from "@opentelemetry/api";
+import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
+import { Resource } from "@opentelemetry/resources";
+import { BatchSpanProcessor, BasicTracerProvider, } from "@opentelemetry/sdk-trace-base";
+import { ATTR_SERVICE_NAME, ATTR_SERVICE_VERSION, } from "@opentelemetry/semantic-conventions";
+const TRACER_NAME = "@xeonr/upload-pool-sdk";
+export const SPAN_ATTR = {
+    JOB_ID: "iq.job_id",
+    UPLOAD_ID: "iq.upload_id",
+    URN: "iq.content_type_urn",
+    WORKER_ID: "iq.worker_id",
+    POOL_TOKEN_PREFIX: "iq.pool_token_prefix",
+    // Matches pipeline-api's TRACE_ATTRIBUTE.RUN_ID. The trace-store
+    // exporter reads this attribute to associate each span with the
+    // right workflow_run in MySQL (workflow_run_spans.run_id). Worker
+    // spans MUST carry it or they're dropped on the floor by the
+    // pipeline-api receiver.
+    RUN_ID: "pipeline.run_id",
+    RPC_METHOD: "rpc.method",
+    RPC_SERVICE: "rpc.service",
+    RPC_TARGET: "rpc.target",
+    RPC_CODE: "rpc.code",
+    RPC_DURATION_MS: "rpc.duration_ms",
+    S3_BYTES: "s3.bytes",
+    S3_URL_ORIGIN: "s3.url_origin",
+    S3_OUTCOME: "s3.outcome",
+};
+let activeHandle = null;
+export function initTracing(cfg) {
+    if (activeHandle) {
+        return activeHandle;
+    }
+    const enabled = cfg.enabled !== false;
+    if (!enabled) {
+        const tracer = trace.getTracer(TRACER_NAME, cfg.sdkVersion);
+        activeHandle = {
+            tracer,
+            shutdown: async () => { },
+            contextFromEnvelope: () => context.active(),
+        };
+        return activeHandle;
+    }
+    const resource = new Resource({
+        [ATTR_SERVICE_NAME]: TRACER_NAME,
+        [ATTR_SERVICE_VERSION]: cfg.sdkVersion,
+        [SPAN_ATTR.WORKER_ID]: cfg.workerId,
+    });
+    // OTLP/HTTP-JSON to pipeline-api's receiver. JSON over protobuf because
+    // it lets the receiver decode without pulling in @opentelemetry/
+    // otlp-transformer's protobuf runtime — the wire size penalty is fine
+    // for the volume the SDK emits (≈10 spans per job, ≈40 KB per job).
+    const exporter = new OTLPTraceExporter({
+        url: `${cfg.pipelineEndpoint.replace(/\/+$/, "")}/v1/traces`,
+        headers: {
+            authorization: `Bearer ${cfg.poolToken}`,
+        },
+        // Generous timeout — pipeline-api's receiver writes through to MySQL
+        // synchronously and we'd rather hold the export than drop a span on
+        // a slow ack.
+        timeoutMillis: 10_000,
+    });
+    const processor = new BatchSpanProcessor(exporter, {
+        // Default batch settings keep us flushing every 5s or 512 spans.
+        // We prefer faster flushes for the per-job RPC use case so the
+        // admin UI sees the latest activity within a couple seconds.
+        scheduledDelayMillis: 1_000,
+        maxQueueSize: 1024,
+        maxExportBatchSize: 128,
+    });
+    const provider = new BasicTracerProvider({
+        resource,
+        spanProcessors: [processor],
+    });
+    const tracer = provider.getTracer(TRACER_NAME, cfg.sdkVersion);
+    const handle = {
+        tracer,
+        shutdown: async () => {
+            try {
+                await provider.shutdown();
+            }
+            catch {
+                // Worker exit is best-effort — never block on export.
+            }
+        },
+        contextFromEnvelope: (traceparent, runId) => {
+            let ctx = context.active();
+            // Ensure every span produced under this context carries the
+            // runId attribute via baggage-like behaviour. We stamp it on
+            // each span at creation site instead of relying on baggage
+            // because the trace store reads it from span attributes.
+            if (!traceparent) {
+                return ctx;
+            }
+            const parsed = parseTraceparent(traceparent);
+            if (!parsed) {
+                return ctx;
+            }
+            ctx = trace.setSpanContext(ctx, parsed);
+            // runId is consumed by the caller and stamped explicitly on
+            // each span via stampJobAttributes(); we don't store it in
+            // the OTel context because there's no cross-span attribute
+            // mechanism in OTel without using a custom propagator.
+            void runId;
+            return ctx;
+        },
+    };
+    activeHandle = handle;
+    return handle;
+}
+export function getTracingHandle() {
+    return activeHandle;
+}
+export async function shutdownTracing() {
+    if (activeHandle) {
+        await activeHandle.shutdown();
+        activeHandle = null;
+    }
+}
+// --- traceparent helpers --------------------------------------------------
+/**
+ * Parse a W3C `traceparent` header into an OTel SpanContext.
+ *
+ * Format: `00-<32 hex trace id>-<16 hex span id>-<2 hex flags>`. Returns
+ * null on malformed input. Used by the SDK to root iq.job spans under
+ * whatever pipeline activity dispatched the job.
+ */
+export function parseTraceparent(value) {
+    if (!value)
+        return null;
+    const parts = value.trim().split("-");
+    if (parts.length !== 4)
+        return null;
+    const [version, traceId, spanId, flagsHex] = parts;
+    if (version !== "00")
+        return null;
+    if (!/^[0-9a-f]{32}$/.test(traceId))
+        return null;
+    if (!/^[0-9a-f]{16}$/.test(spanId))
+        return null;
+    if (!/^[0-9a-f]{2}$/.test(flagsHex))
+        return null;
+    const flags = Number.parseInt(flagsHex, 16);
+    return {
+        traceId,
+        spanId,
+        traceFlags: flags,
+        isRemote: true,
+    };
+}
+/**
+ * Serialise a SpanContext as a W3C traceparent header value.
+ */
+export function spanContextToTraceparent(sc) {
+    const flags = sc.traceFlags.toString(16).padStart(2, "0");
+    return `00-${sc.traceId}-${sc.spanId}-${flags}`;
+}
+// --- body sanitization (req/resp on RPC span events) ----------------------
+const MAX_BODY_EVENT_BYTES = 4 * 1024;
+const REDACTED_KEY_PATTERN = /(token|secret|password|authorization|api[_-]?key|signature|^sig$|cookie)/i;
+const REDACTED_VALUE = "<redacted>";
+/**
+ * Sanitize an arbitrary RPC request/response object for inclusion as a
+ * span event attribute. Same shape as the pipeline-api's tracing/sanitize
+ * (4 KB cap, key-pattern redaction) so the two ends produce consistent
+ * payloads in the admin UI.
+ */
+export function sanitizeRpcBody(value) {
+    try {
+        const cloned = redactDeep(value, 0);
+        const serialised = JSON.stringify(cloned);
+        if (serialised.length <= MAX_BODY_EVENT_BYTES) {
+            return serialised;
+        }
+        return `${serialised.slice(0, MAX_BODY_EVENT_BYTES)}...<truncated>`;
+    }
+    catch {
+        return "<unserialisable>";
+    }
+}
+function redactDeep(value, depth) {
+    if (depth > 6)
+        return "<max-depth>";
+    if (value === null || value === undefined)
+        return value;
+    if (value instanceof Uint8Array) {
+        return `<bytes:${value.byteLength}>`;
+    }
+    if (Array.isArray(value)) {
+        return value.slice(0, 50).map((v) => redactDeep(v, depth + 1));
+    }
+    if (typeof value === "object") {
+        const out = {};
+        const obj = value;
+        const keys = Object.keys(obj).slice(0, 50);
+        for (const k of keys) {
+            if (REDACTED_KEY_PATTERN.test(k)) {
+                out[k] = REDACTED_VALUE;
+            }
+            else {
+                out[k] = redactDeep(obj[k], depth + 1);
+            }
+        }
+        return out;
+    }
+    if (typeof value === "string") {
+        // Heuristic: very long strings are likely embedded payloads; clamp.
+        return value.length > 1024 ? `${value.slice(0, 1024)}...` : value;
+    }
+    return value;
+}
+// --- span helpers --------------------------------------------------------
+/**
+ * Set common job-scoped attributes on a span. Called by every site that
+ * creates a per-job span so RUN_ID / JOB_ID / UPLOAD_ID / URN are
+ * consistently present (the exporter requires `wf.run_id` to route the
+ * span into the right workflow run).
+ */
+export function stampJobAttributes(span, attrs) {
+    span.setAttribute(SPAN_ATTR.RUN_ID, attrs.runId);
+    span.setAttribute(SPAN_ATTR.JOB_ID, attrs.jobId);
+    if (attrs.uploadId) {
+        span.setAttribute(SPAN_ATTR.UPLOAD_ID, attrs.uploadId);
+    }
+    if (attrs.urn) {
+        span.setAttribute(SPAN_ATTR.URN, attrs.urn);
+    }
+    if (attrs.workerId) {
+        span.setAttribute(SPAN_ATTR.WORKER_ID, attrs.workerId);
+    }
+}
+export function recordSpanError(span, err) {
+    if (err instanceof Error) {
+        span.recordException(err);
+        span.setStatus({ code: SpanStatusCode.ERROR, message: err.message });
+    }
+    else {
+        span.setStatus({ code: SpanStatusCode.ERROR, message: String(err) });
+    }
+}
+export { SpanKind, SpanStatusCode };
+//# sourceMappingURL=tracing.js.map

package/dist/tracing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracing.js","sourceRoot":"","sources":["../src/tracing.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,OAAO,EACN,OAAO,EACP,KAAK,EAML,QAAQ,EACR,cAAc,GACd,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,yCAAyC,CAAC;AAC5E,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACpD,OAAO,EACN,kBAAkB,EAClB,mBAAmB,GACnB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACN,iBAAiB,EACjB,oBAAoB,GACpB,MAAM,qCAAqC,CAAC;AAE7C,MAAM,WAAW,GAAG,wBAAwB,CAAC;AAE7C,MAAM,CAAC,MAAM,SAAS,GAAG;IACxB,MAAM,EAAE,WAAW;IACnB,SAAS,EAAE,cAAc;IACzB,GAAG,EAAE,qBAAqB;IAC1B,SAAS,EAAE,cAAc;IACzB,iBAAiB,EAAE,sBAAsB;IACzC,iEAAiE;IACjE,gEAAgE;IAChE,kEAAkE;IAClE,6DAA6D;IAC7D,yBAAyB;IACzB,MAAM,EAAE,iBAAiB;IACzB,UAAU,EAAE,YAAY;IACxB,WAAW,EAAE,aAAa;IAC1B,UAAU,EAAE,YAAY;IACxB,QAAQ,EAAE,UAAU;IACpB,eAAe,EAAE,iBAAiB;IAClC,QAAQ,EAAE,UAAU;IACpB,aAAa,EAAE,eAAe;IAC9B,UAAU,EAAE,YAAY;CACf,CAAC;AA2BX,IAAI,YAAY,GAAyB,IAAI,CAAC;AAE9C,MAAM,UAAU,WAAW,CAAC,GAAsB;IACjD,IAAI,YAAY,EAAE,CAAC;QAClB,OAAO,YAAY,CAAC;IACrB,CAAC;IAED,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,KAAK,KAAK,CAAC;IACtC,IAAI,CAAC,OAAO,EAAE,CAAC;QACd,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,WAAW,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC;QAC5D,YAAY,GAAG;YACd,MAAM;YACN,QAAQ,EAAE,KAAK,IAAI,EAAE,GAAE,CAAC;YACxB,mBAAmB,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE;SAC3C,CAAC;QACF,OAAO,YAAY,CAAC;IACrB,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC;QAC7B,CAAC,iBAAiB,CAAC,EAAE,WAAW;QAChC,CAAC,oBAAoB,CAAC,EAAE,GAAG,CAAC,UAAU;QACtC,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,GAAG,CAAC,QAAQ;KACnC,CAAC,CAAC;IAEH,wEAAwE;IACxE,iEAAiE;IACjE,sEAAsE;IACtE,oEAAoE;IACpE,MAAM,QAAQ,GAAG,IAAI,iBAAiB,CAAC;QACtC,GAAG,EAAE,GAAG,GAAG,CAAC,gBAAgB,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,YAAY;QAC5D,OAAO,EAAE;YACR,aAAa,EAAE,UAAU,GAAG,CAAC,SAAS,EAAE;SACxC;QACD,qEAAqE;QACrE,oEAAoE;QACpE,cAAc;QACd,aAAa,EAAE,MAAM;KACrB,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,IAAI,kBAAkB,CAAC,QAAQ,EAAE;QAClD,iEAAiE;QACjE,+DAA+D;QAC/D,6DAA6D;QAC7D,oBAAoB,EAAE,KAAK;QAC3B,YAAY,EAAE,IAAI;QAClB,kBAAkB,EAAE,GAAG;KACvB,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,IAAI,mBAAmB,CAAC;QACxC,QAAQ;QACR,cAAc,EAAE,CAAC,SAAS,CAAC;KAC3B,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,WAAW,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC;IAE/D,MAAM,MAAM,GAAkB;QAC7B,MAAM;QACN,QAAQ,EAAE,KAAK,IAAI,EAAE;YACpB,IAAI,CAAC;gBACJ,MAAM,QAAQ,CAAC,QAAQ,EAAE,CAAC;YAC3B,CAAC;YAAC,MAAM,CAAC;gBACR,sDAAsD;YACvD,CAAC;QACF,CAAC;QACD,mBAAmB,EAAE,CAAC,WAAmB,EAAE,KAAa,EAAE,EAAE;YAC3D,IAAI,GAAG,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;YAC3B,4DAA4D;YAC5D,6DAA6D;YAC7D,2DAA2D;YAC3D,yDAAyD;YACzD,IAAI,CAAC,WAAW,EAAE,CAAC;gBAClB,OAAO,GAAG,CAAC;YACZ,CAAC;YACD,MAAM,MAAM,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC;YAC7C,IAAI,CAAC,MAAM,EAAE,CAAC;gBACb,OAAO,GAAG,CAAC;YACZ,CAAC;YACD,GAAG,GAAG,KAAK,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YACxC,4DAA4D;YAC5D,2DAA2D;YAC3D,2DAA2D;YAC3D,uDAAuD;YACvD,KAAK,KAAK,CAAC;YACX,OAAO,GAAG,CAAC;QACZ,CAAC;KACD,CAAC;IAEF,YAAY,GAAG,MAAM,CAAC;IACtB,OAAO,MAAM,CAAC;AACf,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC/B,OAAO,YAAY,CAAC;AACrB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe;IACpC,IAAI,YAAY,EAAE,CAAC;QAClB,MAAM,YAAY,CAAC,QAAQ,EAAE,CAAC;QAC9B,YAAY,GAAG,IAAI,CAAC;IACrB,CAAC;AACF,CAAC;AAED,6EAA6E;AAE7E;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAa;IAC7C,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAC;IACxB,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACtC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACpC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC;IACnD,IAAI,OAAO,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAClC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC;QAAE,OAAO,IAAI,CAAC;IACjD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC;QAAE,OAAO,IAAI,CAAC;IAChD,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC;QAAE,OAAO,IAAI,CAAC;IACjD,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAC5C,OAAO;QACN,OAAO;QACP,MAAM;QACN,UAAU,EAAE,KAAmB;QAC/B,QAAQ,EAAE,IAAI;KACd,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,EAAe;IACvD,MAAM,KAAK,GAAG,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC1D,OAAO,MAAM,EAAE,CAAC,OAAO,IAAI,EAAE,CAAC,MAAM,IAAI,KAAK,EAAE,CAAC;AACjD,CAAC;AAED,6EAA6E;AAE7E,MAAM,oBAAoB,GAAG,CAAC,GAAG,IAAI,CAAC;AACtC,MAAM,oBAAoB,GACzB,2EAA2E,CAAC;AAC7E,MAAM,cAAc,GAAG,YAAY,CAAC;AAEpC;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,KAAc;IAC7C,IAAI,CAAC;QACJ,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACpC,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,UAAU,CAAC,MAAM,IAAI,oBAAoB,EAAE,CAAC;YAC/C,OAAO,UAAU,CAAC;QACnB,CAAC;QACD,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,oBAAoB,CAAC,gBAAgB,CAAC;IACrE,CAAC;IAAC,MAAM,CAAC;QACR,OAAO,kBAAkB,CAAC;IAC3B,CAAC;AACF,CAAC;AAED,SAAS,UAAU,CAAC,KAAc,EAAE,KAAa;IAChD,IAAI,KAAK,GAAG,CAAC;QAAE,OAAO,aAAa,CAAC;IACpC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,KAAK,CAAC;IACxD,IAAI,KAAK,YAAY,UAAU,EAAE,CAAC;QACjC,OAAO,UAAU,KAAK,CAAC,UAAU,GAAG,CAAC;IACtC,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;IAChE,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC/B,MAAM,GAAG,GAA4B,EAAE,CAAC;QACxC,MAAM,GAAG,GAAG,KAAgC,CAAC;QAC7C,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QAC3C,KAAK,MAAM,CAAC,IAAI,IAAI,EAAE,CAAC;YACtB,IAAI,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;gBAClC,GAAG,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC;YACzB,CAAC;iBAAM,CAAC;gBACP,GAAG,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;YACxC,CAAC;QACF,CAAC;QACD,OAAO,GAAG,CAAC;IACZ,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC/B,oEAAoE;QACpE,OAAO,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;IACnE,CAAC;IACD,OAAO,KAAK,CAAC;AACd,CAAC;AAED,4EAA4E;AAE5E;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CACjC,IAAU,EACV,KAMC;IAED,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IACjD,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IACjD,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;QACpB,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,SAAS,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;IACD,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;QACf,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;IACD,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;QACpB,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,SAAS,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IACxD,CAAC;AACF,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,IAAU,EAAE,GAAY;IACvD,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;QAC1B,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;SAAM,CAAC;QACP,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACtE,CAAC;AACF,CAAC;AAED,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,CAAC"}

package/dist/types.d.ts

@@ -59,6 +59,14 @@ export interface PoolConfig {
     logger?: import("./logger.js").Logger;
     /** Max concurrent in-flight jobs. Defaults to 1. */
     concurrency?: number;
+    /**
+     * Tracing config. The SDK ships spans to pipeline-api's /v1/traces
+     * receiver for the admin UI. Disable with `{ enabled: false }` to
+     * skip the OTel SDK setup entirely (e.g. in tests).
+     */
+    tracing?: {
+        enabled?: boolean;
+    };
 }
 export type JobHandler = (ctx: JobContext) => Promise<void>;
 export interface JobContext {

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,MAAM,WAAW,UAAU;IAC1B,2EAA2E;IAC3E,KAAK,EAAE,MAAM,CAAC;IACd;;;;;;;;OAQG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;;;;OAQG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB,wEAAwE;IACxE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iEAAiE;IACjE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACrC,6EAA6E;IAC7E,WAAW,CAAC,EAAE,UAAU,CAAC;IACzB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,EAAE,UAAU,KAAK,IAAI,CAAC;IACjD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,aAAa,EAAE,MAAM,CAAC;IACtC,oDAAoD;IACpD,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,UAAU,GAAG,CAAC,GAAG,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAE5D,MAAM,WAAW,UAAU;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,EAAE,EAAE,MAAM,CAAC;QACX,8DAA8D;QAC9D,MAAM,EAAE,UAAU,CAAC;KACnB,CAAC;IACF,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B,sDAAsD;IACtD,SAAS,EAAE,MAAM,CAAC;IAClB,sDAAsD;IACtD,QAAQ,IAAI,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC;IAChD,0EAA0E;IAC1E,cAAc,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC;IACtC,mCAAmC;IACnC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C,gFAAgF;IAChF,UAAU,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD;;;;;;OAMG;IACH,WAAW,CAAC,QAAQ,EAAE,qBAAqB,GAAG,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClF,mEAAmE;IACnE,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7D,0EAA0E;IAC1E,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD;;;;;;;;;;;;;;;;OAgBG;IACH,oBAAoB,CAAC,CAAC,EACrB,IAAI,EAAE,sBAAsB,EAAE,EAC9B,QAAQ,EAAE,CAAC,OAAO,EAAE,gBAAgB,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,GACnD,OAAO,CAAC,CAAC,CAAC,CAAC;CACd;AAED,MAAM,WAAW,sBAAsB;IACtC,IAAI,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAChC,mDAAmD;IACnD,SAAS,EAAE,MAAM,CAAC;IAClB,2GAA2G;IAC3G,WAAW,EAAE,MAAM,CAAC;IACpB,6FAA6F;IAC7F,UAAU,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,aAAa;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;QACZ,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;KACpB,CAAC,CAAC;CACH;AAED,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,iBAAiB,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,cAAc,GAAG,cAAc,GAAG,YAAY,GAAG,iBAAiB,CAAC;IACnI,IAAI,EAAE,UAAU,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC;IAC9C,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oEAAoE;IACpE,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAE9E;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACrC,KAAK,CAAC,EAAE;QACP,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,KAAK,CAAC,EAAE;QACP,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,UAAU,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,KAAK,CAAC,EAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,GAAG,CAAC,EAAE;QACL,SAAS,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACpC;AAED,MAAM,WAAW,mBAAmB;IACnC,SAAS,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAChD,YAAY,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IACnD,UAAU,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IAC3C,YAAY,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC;IACjE,SAAS,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;CACxD"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,MAAM,WAAW,UAAU;IAC1B,2EAA2E;IAC3E,KAAK,EAAE,MAAM,CAAC;IACd;;;;;;;;OAQG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;;;;OAQG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB,wEAAwE;IACxE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iEAAiE;IACjE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACrC,6EAA6E;IAC7E,WAAW,CAAC,EAAE,UAAU,CAAC;IACzB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,EAAE,UAAU,KAAK,IAAI,CAAC;IACjD;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,aAAa,EAAE,MAAM,CAAC;IACtC,oDAAoD;IACpD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,OAAO,CAAC,EAAE;QACT,OAAO,CAAC,EAAE,OAAO,CAAC;KAClB,CAAC;CACF;AAED,MAAM,MAAM,UAAU,GAAG,CAAC,GAAG,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAE5D,MAAM,WAAW,UAAU;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,EAAE,EAAE,MAAM,CAAC;QACX,8DAA8D;QAC9D,MAAM,EAAE,UAAU,CAAC;KACnB,CAAC;IACF,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B,sDAAsD;IACtD,SAAS,EAAE,MAAM,CAAC;IAClB,sDAAsD;IACtD,QAAQ,IAAI,OAAO,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC;IAChD,0EAA0E;IAC1E,cAAc,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC;IACtC,mCAAmC;IACnC,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C,gFAAgF;IAChF,UAAU,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD;;;;;;OAMG;IACH,WAAW,CAAC,QAAQ,EAAE,qBAAqB,GAAG,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClF,mEAAmE;IACnE,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7D,0EAA0E;IAC1E,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD;;;;;;;;;;;;;;;;OAgBG;IACH,oBAAoB,CAAC,CAAC,EACrB,IAAI,EAAE,sBAAsB,EAAE,EAC9B,QAAQ,EAAE,CAAC,OAAO,EAAE,gBAAgB,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,GACnD,OAAO,CAAC,CAAC,CAAC,CAAC;CACd;AAED,MAAM,WAAW,sBAAsB;IACtC,IAAI,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAChC,mDAAmD;IACnD,SAAS,EAAE,MAAM,CAAC;IAClB,2GAA2G;IAC3G,WAAW,EAAE,MAAM,CAAC;IACpB,6FAA6F;IAC7F,UAAU,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,aAAa;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,KAAK,CAAC;QACZ,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;KACpB,CAAC,CAAC;CACH;AAED,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,iBAAiB,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,cAAc,GAAG,cAAc,GAAG,YAAY,GAAG,iBAAiB,CAAC;IACnI,IAAI,EAAE,UAAU,GAAG,cAAc,CAAC,UAAU,CAAC,CAAC;IAC9C,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oEAAoE;IACpE,WAAW,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAE9E;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACrC,KAAK,CAAC,EAAE;QACP,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,KAAK,CAAC,EAAE;QACP,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,UAAU,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,KAAK,CAAC,EAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,GAAG,CAAC,EAAE;QACL,SAAS,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,0BAA0B,CAAC,EAAE,MAAM,CAAC;CACpC;AAED,MAAM,WAAW,mBAAmB;IACnC,SAAS,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAChD,YAAY,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IACnD,UAAU,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IAC3C,YAAY,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC;IACjE,SAAS,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,CAAC;CACxD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xeonr/upload-pool-sdk",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Self-hosted worker SDK for the upl.im content type pipeline. Implement a handler per content type URN; the SDK handles SSE connection, job acceptance, presigned thumbnail upload, and metadata callbacks.",
   "type": "module",
   "main": "./dist/index.js",
@@ -20,6 +20,13 @@
     "@bufbuild/protobuf": "^2.10.1",
     "@connectrpc/connect": "^2.0.0",
     "@connectrpc/connect-node": "^2.0.0",
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/core": "^1.30.0",
+    "@opentelemetry/exporter-trace-otlp-http": "^0.57.0",
+    "@opentelemetry/resources": "^1.30.0",
+    "@opentelemetry/sdk-trace-base": "^1.30.0",
+    "@opentelemetry/sdk-trace-node": "^1.30.0",
+    "@opentelemetry/semantic-conventions": "^1.28.0",
     "eventsource": "^3.0.0"
   },
   "devDependencies": {