@atproto/pds 0.5.24 → 0.5.26

package/dist/telemetry.js

@@ -0,0 +1,193 @@
+import { register } from 'node:module';
+import { diag } from '@opentelemetry/api';
+import { getResourceDetectors } from '@opentelemetry/auto-instrumentations-node';
+import { getBooleanFromEnv, getStringFromEnv, getStringListFromEnv, } from '@opentelemetry/core';
+import { AwsInstrumentation } from '@opentelemetry/instrumentation-aws-sdk';
+import { ExpressInstrumentation, ExpressLayerType, } from '@opentelemetry/instrumentation-express';
+import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
+import { IORedisInstrumentation } from '@opentelemetry/instrumentation-ioredis';
+import { PinoInstrumentation } from '@opentelemetry/instrumentation-pino';
+import { RuntimeNodeInstrumentation } from '@opentelemetry/instrumentation-runtime-node';
+import { UndiciInstrumentation } from '@opentelemetry/instrumentation-undici';
+import { NodeSDK } from '@opentelemetry/sdk-node';
+import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
+import { BetterSqlite3Instrumentation } from 'opentelemetry-plugin-better-sqlite3';
+const ATTR_XRPC_METHOD = 'xrpc.method';
+const ATTR_XRPC_PROXIED = 'xrpc.proxied';
+const ATTR_XRPC_PROXY = 'xrpc.proxy';
+// @NOTE Hand-rolled equivalent of "@opentelemetry/auto-instrumentations-node"'s
+// register script, because that one lacks better-sqlite3 instrumentation and
+// doesn't let us customize the HTTP span naming for XRPC. We use `NodeSDK`
+// rather than `registerInstrumentations` to get exporter setup from the
+// conventional OTEL_* env vars for free.
+// @NOTE Telemetry is opt-in via exporter endpoint rather than a non-standard
+// flag: configuring an OTLP endpoint is what enables the SDK. OTEL_SDK_DISABLED
+// remains a kill switch, per spec.
+const otelDisabled = getBooleanFromEnv('OTEL_SDK_DISABLED');
+const tracesConfigured = isSignalConfigured('TRACES');
+const metricsConfigured = isSignalConfigured('METRICS');
+const logsConfigured = isSignalConfigured('LOGS');
+const otelConfigured = tracesConfigured || metricsConfigured || logsConfigured;
+const otelEnabled = !otelDisabled && otelConfigured;
+if (otelEnabled) {
+    try {
+        register('@opentelemetry/instrumentation/hook.mjs', import.meta.url);
+        const sdk = new NodeSDK({
+            // @NOTE Unlike sdk-node's default detectors, these include the
+            // "container" detector.
+            resourceDetectors: getResourceDetectors(),
+            instrumentations: getInstrumentations(),
+            // @NOTE The gate above enables the SDK as soon as *any* signal is
+            // configured, but NodeSDK then defaults every unspecified
+            // OTEL_{SIGNAL}_EXPORTER to "otlp" on http://localhost:4318 — shipping
+            // signals the operator never opted into. An *empty* pipeline opts a
+            // signal out: NodeSDK only reads OTEL_{SIGNAL}_EXPORTER when the pipeline
+            // option is `undefined`, and registers no provider when handed an empty
+            // one. Opted-in signals get `undefined` so they stay env-configured.
+            spanProcessors: tracesConfigured ? undefined : [],
+            metricReaders: metricsConfigured ? undefined : [],
+            logRecordProcessors: logsConfigured ? undefined : [],
+        });
+        sdk.start();
+        // @NOTE On SIGINT/SIGTERM the PDS releases its resources without calling
+        // process.exit(), so the event loop empties and Node emits "beforeExit"
+        // (https://nodejs.org/api/process.html#event-beforeexit). That's our window
+        // to flush pending telemetry.
+        process.once('beforeExit', () => {
+            sdk.shutdown().catch((err) => {
+                diag.error('Error terminating OpenTelemetry SDK', err);
+            });
+        });
+    }
+    catch (err) {
+        diag.error('Error initializing OpenTelemetry SDK', err);
+    }
+}
+function getInstrumentations() {
+    return [
+        // @NOTE Not using getNodeAutoInstrumentations: it pulls in many
+        // instrumentations we don't need, with no easy way to filter them out.
+        new RuntimeNodeInstrumentation(),
+        new HttpInstrumentation({
+            // Derives "http.route" (and the span name) from the normalized XRPC path,
+            // for both incoming and outgoing requests.
+            //
+            // @NOTE Must be applyCustomAttributesOnSpan (fires on response finish),
+            // not requestHook (fires on request start). The express instrumentation
+            // overwrites the shared rpcMetadata.route on every layer it enters, which
+            // in this app resolves to "/" more often than not (multiple express apps
+            // and routers mounted at "/", plus catchall middlewares with no route
+            // layer). On finish, the http instrumentation copies rpcMetadata.route
+            // into "http.route" and renames the span from it, clobbering anything a
+            // requestHook set. This hook runs after that, so it wins.
+            applyCustomAttributesOnSpan: (span, request) => {
+                const { url, method, proxy } = 'path' in request
+                    ? // ClientRequest
+                        {
+                            url: request.path,
+                            method: request.method,
+                            proxy: request.getHeader('atproto-proxy'),
+                        }
+                    : // IncomingMessage
+                        {
+                            url: request.url ?? '/',
+                            method: request.method ?? 'GET',
+                            proxy: request.headers['atproto-proxy'],
+                        };
+                const lxm = method === 'GET' || method === 'POST'
+                    ? extractNormalizedLxm(url)
+                    : undefined;
+                // Normalized route for XRPC, raw path otherwise
+                const route = lxm ? `/xrpc/${lxm}` : url.split('?')[0];
+                span.setAttribute(ATTR_HTTP_ROUTE, route);
+                if (lxm) {
+                    span.updateName(`${method} /xrpc/${lxm}`);
+                    span.setAttribute(ATTR_XRPC_METHOD, lxm);
+                    span.setAttribute(ATTR_XRPC_PROXIED, !!proxy);
+                    if (proxy) {
+                        span.setAttribute(ATTR_XRPC_PROXY, proxy);
+                    }
+                }
+            },
+        }),
+        new ExpressInstrumentation({
+            ignoreLayersType: [ExpressLayerType.MIDDLEWARE],
+        }),
+        new UndiciInstrumentation({
+            requestHook: (span, request) => {
+                const lxm = extractNormalizedLxm(request.path);
+                if (lxm) {
+                    span.setAttribute(ATTR_XRPC_METHOD, lxm);
+                }
+            },
+        }),
+        new AwsInstrumentation(),
+        new IORedisInstrumentation(),
+        new BetterSqlite3Instrumentation(),
+        // @NOTE Keep log correlation (trace_id/span_id injected into pino records)
+        // but disable log sending: it JSON.parse()s every record on the main thread
+        // and would forward all subsystems indiscriminately. Events we actually want
+        // in the OTEL stack go through the Logs API explicitly (see ./events.ts).
+        new PinoInstrumentation({ disableLogSending: true }),
+    ];
+}
+/**
+ * A signal counts as configured when an OTLP endpoint applies to it
+ * (signal-specific or generic) and its exporter isn't set to "none".
+ *
+ * @NOTE OTEL_{SIGNAL}_EXPORTER is a comma-separated list, and the SDK handles
+ * "none" alongside other exporters inconsistently (metrics & logs disable the
+ * signal, traces falls back to "otlp"). Such a combination is a
+ * misconfiguration, so we treat any list containing "none" as disabling.
+ */
+function isSignalConfigured(signal) {
+    if (getStringListFromEnv(`OTEL_${signal}_EXPORTER`)?.includes('none')) {
+        return false;
+    }
+    return (!!getStringFromEnv(`OTEL_EXPORTER_OTLP_${signal}_ENDPOINT`) ||
+        !!getStringFromEnv('OTEL_EXPORTER_OTLP_ENDPOINT'));
+}
+// @NOTE Hand-rolled (rather than using URL/split) because this runs on every
+// instrumented request. Should become obsolete once we have dedicated
+// XrpcClient/XrpcServer instrumentations.
+function extractNormalizedLxm(url) {
+    if (typeof url !== 'string') {
+        return undefined;
+    }
+    // 9 = "/xrpc/".length + shortest conceivable NSID ("a.b")
+    if (url.length < 9 || !url.startsWith('/xrpc/')) {
+        return undefined;
+    }
+    const firstMethodCharPos = 6; // "/xrpc/".length
+    // Characters that can never open an NSID (note "_" skips "/xrpc/_health")
+    const nextChar = url.charCodeAt(firstMethodCharPos);
+    if (nextChar === 0x2e /* '.' */ ||
+        nextChar === 0x2f /* '/' */ ||
+        nextChar === 0x3f /* '?' */ ||
+        nextChar === 0x5f /* '_' */) {
+        return undefined;
+    }
+    const queryIndex = url.indexOf('?', firstMethodCharPos + 1);
+    let lastMethodCharPos = queryIndex === -1 ? url.length - 1 : queryIndex - 1;
+    // Ignore the trailing slash, if there is one
+    if (url.charCodeAt(lastMethodCharPos) === 0x2f /* '/' */) {
+        lastMethodCharPos--;
+    }
+    if (lastMethodCharPos < 9) {
+        return undefined;
+    }
+    // Make sure there is no other slash in the path
+    if (url.lastIndexOf('/', lastMethodCharPos) !== firstMethodCharPos - 1) {
+        return undefined;
+    }
+    // Require at least one dot, and not as the last character
+    const lastDotPos = url.lastIndexOf('.', lastMethodCharPos);
+    if (lastDotPos === -1 || lastDotPos === lastMethodCharPos) {
+        return undefined;
+    }
+    // @NOTE Only the domain authority is case-insensitive; the trailing name
+    // segment is not, so it must be preserved as-is to avoid conflating
+    // distinct NSIDs.
+    return `${url.substring(firstMethodCharPos, lastDotPos).toLowerCase()}${url.substring(lastDotPos, lastMethodCharPos + 1)}`;
+}
+//# sourceMappingURL=telemetry.js.map

package/dist/telemetry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry.js","sourceRoot":"","sources":["../src/telemetry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AACtC,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAA;AACzC,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAA;AAChF,OAAO,EACL,iBAAiB,EACjB,gBAAgB,EAChB,oBAAoB,GACrB,MAAM,qBAAqB,CAAA;AAE5B,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAA;AAC3E,OAAO,EACL,sBAAsB,EACtB,gBAAgB,GACjB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAA;AACzE,OAAO,EAAE,sBAAsB,EAAE,MAAM,wCAAwC,CAAA;AAC/E,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAA;AACzE,OAAO,EAAE,0BAA0B,EAAE,MAAM,6CAA6C,CAAA;AACxF,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAA;AAC7E,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAA;AACrE,OAAO,EAAE,4BAA4B,EAAE,MAAM,qCAAqC,CAAA;AAElF,MAAM,gBAAgB,GAAG,aAAa,CAAA;AACtC,MAAM,iBAAiB,GAAG,cAAc,CAAA;AACxC,MAAM,eAAe,GAAG,YAAY,CAAA;AAEpC,gFAAgF;AAChF,6EAA6E;AAC7E,2EAA2E;AAC3E,wEAAwE;AACxE,yCAAyC;AAEzC,6EAA6E;AAC7E,gFAAgF;AAChF,mCAAmC;AACnC,MAAM,YAAY,GAAG,iBAAiB,CAAC,mBAAmB,CAAC,CAAA;AAC3D,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAA;AACrD,MAAM,iBAAiB,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAA;AACvD,MAAM,cAAc,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAA;AACjD,MAAM,cAAc,GAAG,gBAAgB,IAAI,iBAAiB,IAAI,cAAc,CAAA;AAC9E,MAAM,WAAW,GAAG,CAAC,YAAY,IAAI,cAAc,CAAA;AAEnD,IAAI,WAAW,EAAE,CAAC;IAChB,IAAI,CAAC;QACH,QAAQ,CAAC,yCAAyC,EAAE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAA;QAEpE,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC;YACtB,+DAA+D;YAC/D,wBAAwB;YACxB,iBAAiB,EAAE,oBAAoB,EAAE;YACzC,gBAAgB,EAAE,mBAAmB,EAAE;YAEvC,kEAAkE;YAClE,0DAA0D;YAC1D,uEAAuE;YACvE,oEAAoE;YACpE,0EAA0E;YAC1E,wEAAwE;YACxE,qEAAqE;YACrE,cAAc,EAAE,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE;YACjD,aAAa,EAAE,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE;YACjD,mBAAmB,EAAE,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE;SACrD,CAAC,CAAA;QAEF,GAAG,CAAC,KAAK,EAAE,CAAA;QAEX,yEAAyE;QACzE,wEAAwE;QACxE,4EAA4E;QAC5E,8BAA8B;QAC9B,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,GAAG,EAAE;YAC9B,GAAG,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC3B,IAAI,CAAC,KAAK,CAAC,qCAAqC,EAAE,GAAG,CAAC,CAAA;YACxD,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,KAAK,CAAC,sCAAsC,EAAE,GAAG,CAAC,CAAA;IACzD,CAAC;AACH,CAAC;AAED,SAAS,mBAAmB;IAC1B,OAAO;QACL,gEAAgE;QAChE,uEAAuE;QACvE,IAAI,0BAA0B,EAAE;QAChC,IAAI,mBAAmB,CAAC;YACtB,0EAA0E;YAC1E,2CAA2C;YAC3C,EAAE;YACF,wEAAwE;YACxE,wEAAwE;YACxE,0EAA0E;YAC1E,yEAAyE;YACzE,sEAAsE;YACtE,uEAAuE;YACvE,wEAAwE;YACxE,0DAA0D;YAC1D,2BAA2B,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;gBAC7C,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAC1B,MAAM,IAAI,OAAO;oBACf,CAAC,CAAC,gBAAgB;wBAChB;4BACE,GAAG,EAAE,OAAO,CAAC,IAAI;4BACjB,MAAM,EAAE,OAAO,CAAC,MAAM;4BACtB,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,eAAe,CAAC;yBAC1C;oBACH,CAAC,CAAC,kBAAkB;wBAClB;4BACE,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG;4BACvB,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,KAAK;4BAC/B,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC;yBACxC,CAAA;gBAEP,MAAM,GAAG,GACP,MAAM,KAAK,KAAK,IAAI,MAAM,KAAK,MAAM;oBACnC,CAAC,CAAC,oBAAoB,CAAC,GAAG,CAAC;oBAC3B,CAAC,CAAC,SAAS,CAAA;gBAEf,gDAAgD;gBAChD,MAAM,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;gBACtD,IAAI,CAAC,YAAY,CAAC,eAAe,EAAE,KAAK,CAAC,CAAA;gBAEzC,IAAI,GAAG,EAAE,CAAC;oBACR,IAAI,CAAC,UAAU,CAAC,GAAG,MAAM,UAAU,GAAG,EAAE,CAAC,CAAA;oBACzC,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAA;oBACxC,IAAI,CAAC,YAAY,CAAC,iBAAiB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAA;oBAE7C,IAAI,KAAK,EAAE,CAAC;wBACV,IAAI,CAAC,YAAY,CAAC,eAAe,EAAE,KAAK,CAAC,CAAA;oBAC3C,CAAC;gBACH,CAAC;YACH,CAAC;SACF,CAAC;QACF,IAAI,sBAAsB,CAAC;YACzB,gBAAgB,EAAE,CAAC,gBAAgB,CAAC,UAAU,CAAC;SAChD,CAAC;QACF,IAAI,qBAAqB,CAAC;YACxB,WAAW,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;gBAC7B,MAAM,GAAG,GAAG,oBAAoB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;gBAC9C,IAAI,GAAG,EAAE,CAAC;oBACR,IAAI,CAAC,YAAY,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAA;gBAC1C,CAAC;YACH,CAAC;SACF,CAAC;QACF,IAAI,kBAAkB,EAAE;QACxB,IAAI,sBAAsB,EAAE;QAC5B,IAAI,4BAA4B,EAAE;QAClC,2EAA2E;QAC3E,4EAA4E;QAC5E,6EAA6E;QAC7E,0EAA0E;QAC1E,IAAI,mBAAmB,CAAC,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC;KACrD,CAAA;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,kBAAkB,CAAC,MAAqC;IAC/D,IAAI,oBAAoB,CAAC,QAAQ,MAAM,WAAW,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;QACtE,OAAO,KAAK,CAAA;IACd,CAAC;IAED,OAAO,CACL,CAAC,CAAC,gBAAgB,CAAC,sBAAsB,MAAM,WAAW,CAAC;QAC3D,CAAC,CAAC,gBAAgB,CAAC,6BAA6B,CAAC,CAClD,CAAA;AACH,CAAC;AAED,6EAA6E;AAC7E,sEAAsE;AACtE,0CAA0C;AAC1C,SAAS,oBAAoB,CAAC,GAAY;IACxC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,0DAA0D;IAC1D,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChD,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,kBAAkB,GAAG,CAAC,CAAA,CAAC,kBAAkB;IAE/C,0EAA0E;IAC1E,MAAM,QAAQ,GAAG,GAAG,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAA;IACnD,IACE,QAAQ,KAAK,IAAI,CAAC,SAAS;QAC3B,QAAQ,KAAK,IAAI,CAAC,SAAS;QAC3B,QAAQ,KAAK,IAAI,CAAC,SAAS;QAC3B,QAAQ,KAAK,IAAI,CAAC,SAAS,EAC3B,CAAC;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,kBAAkB,GAAG,CAAC,CAAC,CAAA;IAE3D,IAAI,iBAAiB,GAAG,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,GAAG,CAAC,CAAA;IAE3E,6CAA6C;IAC7C,IAAI,GAAG,CAAC,UAAU,CAAC,iBAAiB,CAAC,KAAK,IAAI,CAAC,SAAS,EAAE,CAAC;QACzD,iBAAiB,EAAE,CAAA;IACrB,CAAC;IAED,IAAI,iBAAiB,GAAG,CAAC,EAAE,CAAC;QAC1B,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,gDAAgD;IAChD,IAAI,GAAG,CAAC,WAAW,CAAC,GAAG,EAAE,iBAAiB,CAAC,KAAK,kBAAkB,GAAG,CAAC,EAAE,CAAC;QACvE,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,0DAA0D;IAC1D,MAAM,UAAU,GAAG,GAAG,CAAC,WAAW,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAA;IAC1D,IAAI,UAAU,KAAK,CAAC,CAAC,IAAI,UAAU,KAAK,iBAAiB,EAAE,CAAC;QAC1D,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,yEAAyE;IACzE,oEAAoE;IACpE,kBAAkB;IAClB,OAAO,GAAG,GAAG,CAAC,SAAS,CAAC,kBAAkB,EAAE,UAAU,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,SAAS,CAAC,UAAU,EAAE,iBAAiB,GAAG,CAAC,CAAC,EAAE,CAAA;AAC5H,CAAC","sourcesContent":["import { register } from 'node:module'\nimport { diag } from '@opentelemetry/api'\nimport { getResourceDetectors } from '@opentelemetry/auto-instrumentations-node'\nimport {\n  getBooleanFromEnv,\n  getStringFromEnv,\n  getStringListFromEnv,\n} from '@opentelemetry/core'\nimport type { Instrumentation } from '@opentelemetry/instrumentation'\nimport { AwsInstrumentation } from '@opentelemetry/instrumentation-aws-sdk'\nimport {\n  ExpressInstrumentation,\n  ExpressLayerType,\n} from '@opentelemetry/instrumentation-express'\nimport { HttpInstrumentation } from '@opentelemetry/instrumentation-http'\nimport { IORedisInstrumentation } from '@opentelemetry/instrumentation-ioredis'\nimport { PinoInstrumentation } from '@opentelemetry/instrumentation-pino'\nimport { RuntimeNodeInstrumentation } from '@opentelemetry/instrumentation-runtime-node'\nimport { UndiciInstrumentation } from '@opentelemetry/instrumentation-undici'\nimport { NodeSDK } from '@opentelemetry/sdk-node'\nimport { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions'\nimport { BetterSqlite3Instrumentation } from 'opentelemetry-plugin-better-sqlite3'\n\nconst ATTR_XRPC_METHOD = 'xrpc.method'\nconst ATTR_XRPC_PROXIED = 'xrpc.proxied'\nconst ATTR_XRPC_PROXY = 'xrpc.proxy'\n\n// @NOTE Hand-rolled equivalent of \"@opentelemetry/auto-instrumentations-node\"'s\n// register script, because that one lacks better-sqlite3 instrumentation and\n// doesn't let us customize the HTTP span naming for XRPC. We use `NodeSDK`\n// rather than `registerInstrumentations` to get exporter setup from the\n// conventional OTEL_* env vars for free.\n\n// @NOTE Telemetry is opt-in via exporter endpoint rather than a non-standard\n// flag: configuring an OTLP endpoint is what enables the SDK. OTEL_SDK_DISABLED\n// remains a kill switch, per spec.\nconst otelDisabled = getBooleanFromEnv('OTEL_SDK_DISABLED')\nconst tracesConfigured = isSignalConfigured('TRACES')\nconst metricsConfigured = isSignalConfigured('METRICS')\nconst logsConfigured = isSignalConfigured('LOGS')\nconst otelConfigured = tracesConfigured || metricsConfigured || logsConfigured\nconst otelEnabled = !otelDisabled && otelConfigured\n\nif (otelEnabled) {\n  try {\n    register('@opentelemetry/instrumentation/hook.mjs', import.meta.url)\n\n    const sdk = new NodeSDK({\n      // @NOTE Unlike sdk-node's default detectors, these include the\n      // \"container\" detector.\n      resourceDetectors: getResourceDetectors(),\n      instrumentations: getInstrumentations(),\n\n      // @NOTE The gate above enables the SDK as soon as *any* signal is\n      // configured, but NodeSDK then defaults every unspecified\n      // OTEL_{SIGNAL}_EXPORTER to \"otlp\" on http://localhost:4318 — shipping\n      // signals the operator never opted into. An *empty* pipeline opts a\n      // signal out: NodeSDK only reads OTEL_{SIGNAL}_EXPORTER when the pipeline\n      // option is `undefined`, and registers no provider when handed an empty\n      // one. Opted-in signals get `undefined` so they stay env-configured.\n      spanProcessors: tracesConfigured ? undefined : [],\n      metricReaders: metricsConfigured ? undefined : [],\n      logRecordProcessors: logsConfigured ? undefined : [],\n    })\n\n    sdk.start()\n\n    // @NOTE On SIGINT/SIGTERM the PDS releases its resources without calling\n    // process.exit(), so the event loop empties and Node emits \"beforeExit\"\n    // (https://nodejs.org/api/process.html#event-beforeexit). That's our window\n    // to flush pending telemetry.\n    process.once('beforeExit', () => {\n      sdk.shutdown().catch((err) => {\n        diag.error('Error terminating OpenTelemetry SDK', err)\n      })\n    })\n  } catch (err) {\n    diag.error('Error initializing OpenTelemetry SDK', err)\n  }\n}\n\nfunction getInstrumentations(): Instrumentation[] {\n  return [\n    // @NOTE Not using getNodeAutoInstrumentations: it pulls in many\n    // instrumentations we don't need, with no easy way to filter them out.\n    new RuntimeNodeInstrumentation(),\n    new HttpInstrumentation({\n      // Derives \"http.route\" (and the span name) from the normalized XRPC path,\n      // for both incoming and outgoing requests.\n      //\n      // @NOTE Must be applyCustomAttributesOnSpan (fires on response finish),\n      // not requestHook (fires on request start). The express instrumentation\n      // overwrites the shared rpcMetadata.route on every layer it enters, which\n      // in this app resolves to \"/\" more often than not (multiple express apps\n      // and routers mounted at \"/\", plus catchall middlewares with no route\n      // layer). On finish, the http instrumentation copies rpcMetadata.route\n      // into \"http.route\" and renames the span from it, clobbering anything a\n      // requestHook set. This hook runs after that, so it wins.\n      applyCustomAttributesOnSpan: (span, request) => {\n        const { url, method, proxy } =\n          'path' in request\n            ? // ClientRequest\n              {\n                url: request.path,\n                method: request.method,\n                proxy: request.getHeader('atproto-proxy'),\n              }\n            : // IncomingMessage\n              {\n                url: request.url ?? '/',\n                method: request.method ?? 'GET',\n                proxy: request.headers['atproto-proxy'],\n              }\n\n        const lxm =\n          method === 'GET' || method === 'POST'\n            ? extractNormalizedLxm(url)\n            : undefined\n\n        // Normalized route for XRPC, raw path otherwise\n        const route = lxm ? `/xrpc/${lxm}` : url.split('?')[0]\n        span.setAttribute(ATTR_HTTP_ROUTE, route)\n\n        if (lxm) {\n          span.updateName(`${method} /xrpc/${lxm}`)\n          span.setAttribute(ATTR_XRPC_METHOD, lxm)\n          span.setAttribute(ATTR_XRPC_PROXIED, !!proxy)\n\n          if (proxy) {\n            span.setAttribute(ATTR_XRPC_PROXY, proxy)\n          }\n        }\n      },\n    }),\n    new ExpressInstrumentation({\n      ignoreLayersType: [ExpressLayerType.MIDDLEWARE],\n    }),\n    new UndiciInstrumentation({\n      requestHook: (span, request) => {\n        const lxm = extractNormalizedLxm(request.path)\n        if (lxm) {\n          span.setAttribute(ATTR_XRPC_METHOD, lxm)\n        }\n      },\n    }),\n    new AwsInstrumentation(),\n    new IORedisInstrumentation(),\n    new BetterSqlite3Instrumentation(),\n    // @NOTE Keep log correlation (trace_id/span_id injected into pino records)\n    // but disable log sending: it JSON.parse()s every record on the main thread\n    // and would forward all subsystems indiscriminately. Events we actually want\n    // in the OTEL stack go through the Logs API explicitly (see ./events.ts).\n    new PinoInstrumentation({ disableLogSending: true }),\n  ]\n}\n\n/**\n * A signal counts as configured when an OTLP endpoint applies to it\n * (signal-specific or generic) and its exporter isn't set to \"none\".\n *\n * @NOTE OTEL_{SIGNAL}_EXPORTER is a comma-separated list, and the SDK handles\n * \"none\" alongside other exporters inconsistently (metrics & logs disable the\n * signal, traces falls back to \"otlp\"). Such a combination is a\n * misconfiguration, so we treat any list containing \"none\" as disabling.\n */\nfunction isSignalConfigured(signal: 'TRACES' | 'METRICS' | 'LOGS'): boolean {\n  if (getStringListFromEnv(`OTEL_${signal}_EXPORTER`)?.includes('none')) {\n    return false\n  }\n\n  return (\n    !!getStringFromEnv(`OTEL_EXPORTER_OTLP_${signal}_ENDPOINT`) ||\n    !!getStringFromEnv('OTEL_EXPORTER_OTLP_ENDPOINT')\n  )\n}\n\n// @NOTE Hand-rolled (rather than using URL/split) because this runs on every\n// instrumented request. Should become obsolete once we have dedicated\n// XrpcClient/XrpcServer instrumentations.\nfunction extractNormalizedLxm(url: unknown): string | undefined {\n  if (typeof url !== 'string') {\n    return undefined\n  }\n\n  // 9 = \"/xrpc/\".length + shortest conceivable NSID (\"a.b\")\n  if (url.length < 9 || !url.startsWith('/xrpc/')) {\n    return undefined\n  }\n\n  const firstMethodCharPos = 6 // \"/xrpc/\".length\n\n  // Characters that can never open an NSID (note \"_\" skips \"/xrpc/_health\")\n  const nextChar = url.charCodeAt(firstMethodCharPos)\n  if (\n    nextChar === 0x2e /* '.' */ ||\n    nextChar === 0x2f /* '/' */ ||\n    nextChar === 0x3f /* '?' */ ||\n    nextChar === 0x5f /* '_' */\n  ) {\n    return undefined\n  }\n\n  const queryIndex = url.indexOf('?', firstMethodCharPos + 1)\n\n  let lastMethodCharPos = queryIndex === -1 ? url.length - 1 : queryIndex - 1\n\n  // Ignore the trailing slash, if there is one\n  if (url.charCodeAt(lastMethodCharPos) === 0x2f /* '/' */) {\n    lastMethodCharPos--\n  }\n\n  if (lastMethodCharPos < 9) {\n    return undefined\n  }\n\n  // Make sure there is no other slash in the path\n  if (url.lastIndexOf('/', lastMethodCharPos) !== firstMethodCharPos - 1) {\n    return undefined\n  }\n\n  // Require at least one dot, and not as the last character\n  const lastDotPos = url.lastIndexOf('.', lastMethodCharPos)\n  if (lastDotPos === -1 || lastDotPos === lastMethodCharPos) {\n    return undefined\n  }\n\n  // @NOTE Only the domain authority is case-insensitive; the trailing name\n  // segment is not, so it must be preserved as-is to avoid conflating\n  // distinct NSIDs.\n  return `${url.substring(firstMethodCharPos, lastDotPos).toLowerCase()}${url.substring(lastDotPos, lastMethodCharPos + 1)}`\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/pds",
-  "version": "0.5.24",
+  "version": "0.5.26",
   "license": "MIT",
   "description": "Reference implementation of atproto Personal Data Server (PDS)",
   "keywords": [
@@ -24,6 +24,10 @@
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
+    "./telemetry": {
+      "types": "./dist/telemetry.d.ts",
+      "default": "./dist/telemetry.js"
+    },
     "./package.json": "./package.json"
   },
   "engines": {
@@ -32,6 +36,21 @@
   "dependencies": {
     "@did-plc/lib": "^0.0.4",
     "@hapi/address": "^5.1.1",
+    "@opentelemetry/api": "^1.9.1",
+    "@opentelemetry/api-logs": "^0.219.0",
+    "@opentelemetry/auto-instrumentations-node": "^0.77.0",
+    "@opentelemetry/core": "^2.9.0",
+    "@opentelemetry/instrumentation": "^0.219.0",
+    "@opentelemetry/instrumentation-aws-sdk": "^0.74.0",
+    "@opentelemetry/instrumentation-express": "^0.67.0",
+    "@opentelemetry/instrumentation-http": "^0.219.0",
+    "@opentelemetry/instrumentation-ioredis": "^0.67.0",
+    "@opentelemetry/instrumentation-pino": "^0.65.0",
+    "@opentelemetry/instrumentation-runtime-node": "^0.32.0",
+    "@opentelemetry/instrumentation-undici": "^0.29.0",
+    "@opentelemetry/resource-detector-container": "^0.8.10",
+    "@opentelemetry/sdk-node": "^0.219.0",
+    "@opentelemetry/semantic-conventions": "^1.41.1",
     "better-sqlite3": "^12.0.0",
     "compression": "^1.7.4",
     "cors": "^2.8.5",
@@ -39,7 +58,6 @@
     "express": "^4.17.2",
     "express-async-errors": "^3.1.1",
     "file-type": "^16.5.4",
-    "glob": "^10.3.10",
     "handlebars": "^4.7.7",
     "http-terminator": "^3.2.0",
     "ioredis": "^5.3.2",
@@ -48,33 +66,32 @@
     "kysely": "^0.29.2",
     "nodemailer": "^6.8.0",
     "nodemailer-html-to-text": "^3.2.0",
+    "opentelemetry-plugin-better-sqlite3": "^1.13.0",
     "p-queue": "^8.0.0",
     "pino": "^10.3.1",
     "pino-http": "^11.0.0",
-    "typed-emitter": "^2.1.0",
     "uint8arrays": "^5.0.0",
     "undici": "^8.5.0",
     "zod": "^3.23.8",
     "@atproto-labs/fetch-node": "^0.3.7",
-    "@atproto-labs/simple-store-memory": "^0.2.6",
     "@atproto-labs/simple-store": "^0.5.1",
+    "@atproto-labs/simple-store-memory": "^0.2.6",
     "@atproto-labs/simple-store-redis": "^0.1.6",
-    "@atproto-labs/xrpc-utils": "^0.1.13",
-    "@atproto/aws": "^0.3.10",
-    "@atproto/common": "^0.7.4",
+    "@atproto/aws": "^0.3.12",
+    "@atproto/common": "^0.7.6",
+    "@atproto-labs/xrpc-utils": "^0.1.15",
     "@atproto/did": "^0.5.4",
+    "@atproto/lex": "^0.3.5",
     "@atproto/crypto": "^0.5.4",
-    "@atproto/identity": "^0.5.8",
+    "@atproto/identity": "^0.5.9",
     "@atproto/lex-cbor": "^0.1.6",
-    "@atproto/lex": "^0.3.3",
-    "@atproto/oauth-provider": "^0.21.2",
-    "@atproto/lex-data": "^0.1.7",
     "@atproto/lex-json": "^0.1.6",
-    "@atproto/oauth-scopes": "^0.5.8",
-    "@atproto/repo": "^0.10.8",
-    "@atproto/xrpc": "^0.8.9",
-    "@atproto/syntax": "^0.7.3",
-    "@atproto/xrpc-server": "^0.12.0"
+    "@atproto/lex-data": "^0.1.7",
+    "@atproto/oauth-scopes": "^0.5.9",
+    "@atproto/oauth-provider": "^0.22.0",
+    "@atproto/repo": "^0.10.10",
+    "@atproto/xrpc-server": "^0.12.2",
+    "@atproto/syntax": "^0.7.4"
   },
   "devDependencies": {
     "@did-plc/server": "^0.0.1",
@@ -90,16 +107,15 @@
     "jest": "^30.0.0",
     "puppeteer": "^23.11.1",
     "ws": "^8.12.0",
-    "@atproto/api": "^0.20.37",
-    "@atproto/bsky": "^0.0.270",
-    "@atproto/lex-document": "^0.1.8",
+    "@atproto/api": "^0.20.38",
+    "@atproto/lex-document": "^0.1.9",
     "@atproto/oauth-client-browser-example": "^0.1.7"
   },
   "scripts": {
     "codegen:lex": "lex build --clear --indexFile --lexicons ../../lexicons",
     "codegen:templates": "node ./build.templates.cjs",
     "prebuild": "pnpm run '/^(codegen:.+)$/'",
-    "build": "tsgo --build tsconfig.build.json",
+    "build": "tsc --build tsconfig.build.json",
     "verify:import": "node --input-type=module -e \"import '@atproto/pds'\"",
     "dev": "node ./build.templates.cjs --watch",
     "pretest": "puppeteer browsers install chrome",