@bigfootai/sdk 1.21.0 → 1.22.0

package/dist/otel-config.d.ts

@@ -0,0 +1,4 @@
+/** Kept apart from `otel.ts` so both can be tested without starting an SDK. */
+export declare const SDK_DISABLED_VAR = "OTEL_SDK_DISABLED";
+export declare const shouldStartTelemetry: (env?: NodeJS.ProcessEnv) => boolean;
+//# sourceMappingURL=otel-config.d.ts.map

package/dist/otel-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"otel-config.d.ts","sourceRoot":"","sources":["../src/otel-config.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,eAAO,MAAM,gBAAgB,sBAAsB,CAAC;AAEpD,eAAO,MAAM,oBAAoB,SAAS,MAAM,CAAC,UAAU,KAAiB,OAA2C,CAAC"}

package/dist/otel-config.js

@@ -0,0 +1,4 @@
+/** Kept apart from `otel.ts` so both can be tested without starting an SDK. */
+export const SDK_DISABLED_VAR = 'OTEL_SDK_DISABLED';
+export const shouldStartTelemetry = (env = process.env) => env[SDK_DISABLED_VAR] !== 'true';
+//# sourceMappingURL=otel-config.js.map

package/dist/otel-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"otel-config.js","sourceRoot":"","sources":["../src/otel-config.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,MAAM,CAAC,MAAM,gBAAgB,GAAG,mBAAmB,CAAC;AAEpD,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,MAAyB,OAAO,CAAC,GAAG,EAAW,EAAE,CAAC,GAAG,CAAC,gBAAgB,CAAC,KAAK,MAAM,CAAC"}

package/dist/otel.d.ts

@@ -0,0 +1,5 @@
+import { NodeSDK } from '@opentelemetry/sdk-node';
+export declare const startTelemetry: () => NodeSDK | undefined;
+export { SDK_DISABLED_VAR, shouldStartTelemetry } from './otel-config.js';
+export declare const telemetry: NodeSDK;
+//# sourceMappingURL=otel.d.ts.map

package/dist/otel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"otel.d.ts","sourceRoot":"","sources":["../src/otel.ts"],"names":[],"mappings":"AA2BA,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAqBlD,eAAO,MAAM,cAAc,QAAO,OAAO,GAAG,SAqB3C,CAAC;AAEF,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAE1E,eAAO,MAAM,SAAS,SAAmB,CAAC"}

package/dist/otel.js

@@ -0,0 +1,68 @@
+/**
+ * Starts OpenTelemetry for a provider, before the app and before anything it instruments:
+ *
+ *   node --import @bigfootai/sdk/otel dist/index.js
+ *
+ * The ESM loader hook is only needed for ESM dependencies; express, pino, http and undici are
+ * CommonJS, so the require hook patches them without it.
+ *
+ * Logs go to the collector one record at a time, so a line written before an invocation hangs still
+ * leaves the process. Traces and metrics batch, and are flushed on shutdown: a timeout freezes the
+ * process with no shutdown, so that tail is lost.
+ *
+ * The collector receives all three at OTEL_EXPORTER_OTLP_ENDPOINT, which defaults to
+ * http://localhost:4318. Setting OTEL_SDK_DISABLED=true starts no SDK at all, which is what a local
+ * run without a collector wants.
+ */
+import { OTLPLogExporter } from '@opentelemetry/exporter-logs-otlp-http';
+import { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-http';
+import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
+import { AwsInstrumentation } from '@opentelemetry/instrumentation-aws-sdk';
+import { ExpressInstrumentation } from '@opentelemetry/instrumentation-express';
+import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
+import { MongoDBInstrumentation } from '@opentelemetry/instrumentation-mongodb';
+import { PinoInstrumentation } from '@opentelemetry/instrumentation-pino';
+import { UndiciInstrumentation } from '@opentelemetry/instrumentation-undici';
+import { SimpleLogRecordProcessor } from '@opentelemetry/sdk-logs';
+import { PeriodicExportingMetricReader } from '@opentelemetry/sdk-metrics';
+import { NodeSDK } from '@opentelemetry/sdk-node';
+import { shouldStartTelemetry } from './otel-config.js';
+/**
+ * Instrumentations are chosen one at a time rather than taken as a bundle: each costs start-up time
+ * and patched surface, and a provider only needs the call paths it uses. http covers axios and the
+ * node client; undici covers fetch.
+ */
+const instrumentations = () => [
+    new HttpInstrumentation(),
+    new UndiciInstrumentation(),
+    new ExpressInstrumentation(),
+    new PinoInstrumentation(),
+    // enhancedDatabaseReporting adds query parameters and results to the span; off is the default,
+    // stated so that turning it on has to be deliberate.
+    new MongoDBInstrumentation({ enhancedDatabaseReporting: false }),
+    // DynamoDB commands are not serialised at all unless dynamoDBStatementSerializer is set, so item
+    // values never reach a span. suppressInternalInstrumentation hides the duplicate http span.
+    new AwsInstrumentation({ suppressInternalInstrumentation: true }),
+];
+export const startTelemetry = () => {
+    if (!shouldStartTelemetry())
+        return undefined;
+    const sdk = new NodeSDK({
+        instrumentations: instrumentations(),
+        // One record at a time: a batch processor holds records the process may never flush.
+        logRecordProcessors: [new SimpleLogRecordProcessor({ exporter: new OTLPLogExporter() })],
+        metricReaders: [new PeriodicExportingMetricReader({ exporter: new OTLPMetricExporter() })],
+        traceExporter: new OTLPTraceExporter(),
+    });
+    sdk.start();
+    // A SIGTERM is the one shutdown Lambda describes; a timeout does not send one.
+    const shutdown = () => {
+        void sdk.shutdown().catch(() => undefined);
+    };
+    process.once('SIGTERM', shutdown);
+    process.once('SIGINT', shutdown);
+    return sdk;
+};
+export { SDK_DISABLED_VAR, shouldStartTelemetry } from './otel-config.js';
+export const telemetry = startTelemetry();
+//# sourceMappingURL=otel.js.map

package/dist/otel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"otel.js","sourceRoot":"","sources":["../src/otel.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,iBAAiB,EAAE,MAAM,yCAAyC,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAE,sBAAsB,EAAE,MAAM,wCAAwC,CAAC;AAChF,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,EAAE,sBAAsB,EAAE,MAAM,wCAAwC,CAAC;AAChF,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,6BAA6B,EAAE,MAAM,4BAA4B,CAAC;AAC3E,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAExD;;;;GAIG;AACH,MAAM,gBAAgB,GAAG,GAAG,EAAE,CAAC;IAC9B,IAAI,mBAAmB,EAAE;IACzB,IAAI,qBAAqB,EAAE;IAC3B,IAAI,sBAAsB,EAAE;IAC5B,IAAI,mBAAmB,EAAE;IACzB,+FAA+F;IAC/F,qDAAqD;IACrD,IAAI,sBAAsB,CAAC,EAAE,yBAAyB,EAAE,KAAK,EAAE,CAAC;IAChE,iGAAiG;IACjG,4FAA4F;IAC5F,IAAI,kBAAkB,CAAC,EAAE,+BAA+B,EAAE,IAAI,EAAE,CAAC;CACjE,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,GAAwB,EAAE;IACvD,IAAI,CAAC,oBAAoB,EAAE;QAAE,OAAO,SAAS,CAAC;IAE9C,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC;QACvB,gBAAgB,EAAE,gBAAgB,EAAE;QACpC,qFAAqF;QACrF,mBAAmB,EAAE,CAAC,IAAI,wBAAwB,CAAC,EAAE,QAAQ,EAAE,IAAI,eAAe,EAAE,EAAE,CAAC,CAAC;QACxF,aAAa,EAAE,CAAC,IAAI,6BAA6B,CAAC,EAAE,QAAQ,EAAE,IAAI,kBAAkB,EAAE,EAAE,CAAC,CAAC;QAC1F,aAAa,EAAE,IAAI,iBAAiB,EAAE;KACtC,CAAC,CAAC;IAEH,GAAG,CAAC,KAAK,EAAE,CAAC;IAEZ,+EAA+E;IAC/E,MAAM,QAAQ,GAAG,GAAS,EAAE;QAC3B,KAAK,GAAG,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC5C,CAAC,CAAC;IACF,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAClC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAEjC,OAAO,GAAG,CAAC;AACZ,CAAC,CAAC;AAEF,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAE1E,MAAM,CAAC,MAAM,SAAS,GAAG,cAAc,EAAE,CAAC"}

package/dist/otel.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=otel.test.d.ts.map

package/dist/otel.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"otel.test.d.ts","sourceRoot":"","sources":["../src/otel.test.ts"],"names":[],"mappings":""}

package/dist/otel.test.js

@@ -0,0 +1,12 @@
+import { describe, expect, it } from 'vitest';
+import { SDK_DISABLED_VAR, shouldStartTelemetry } from './otel-config.js';
+describe('shouldStartTelemetry', () => {
+    it('starts when the switch is absent or not true', () => {
+        expect(shouldStartTelemetry({})).toBe(true);
+        expect(shouldStartTelemetry({ [SDK_DISABLED_VAR]: 'false' })).toBe(true);
+    });
+    it('stays off only for an explicit true', () => {
+        expect(shouldStartTelemetry({ [SDK_DISABLED_VAR]: 'true' })).toBe(false);
+    });
+});
+//# sourceMappingURL=otel.test.js.map

package/dist/otel.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"otel.test.js","sourceRoot":"","sources":["../src/otel.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAE1E,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;IACrC,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACvD,MAAM,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5C,MAAM,CAAC,oBAAoB,CAAC,EAAE,CAAC,gBAAgB,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC9C,MAAM,CAAC,oBAAoB,CAAC,EAAE,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bigfootai/sdk",
   "type": "module",
-  "version": "1.21.0",
+  "version": "1.22.0",
   "files": [
     "dist",
     "LICENSE",
@@ -10,6 +10,18 @@
   "main": "dist/index.js",
   "dependencies": {
     "@bigfootai/bigfoot-types": "^5.4.302",
+    "@opentelemetry/exporter-logs-otlp-http": "^0.300.0",
+    "@opentelemetry/exporter-metrics-otlp-http": "^0.300.0",
+    "@opentelemetry/exporter-trace-otlp-http": "^0.300.0",
+    "@opentelemetry/instrumentation-aws-sdk": "^0.79.0",
+    "@opentelemetry/instrumentation-express": "^0.72.0",
+    "@opentelemetry/instrumentation-http": "^0.300.0",
+    "@opentelemetry/instrumentation-mongodb": "^0.77.0",
+    "@opentelemetry/instrumentation-pino": "^0.70.0",
+    "@opentelemetry/instrumentation-undici": "^0.34.0",
+    "@opentelemetry/sdk-logs": "^3.0.0",
+    "@opentelemetry/sdk-metrics": "^3.0.0",
+    "@opentelemetry/sdk-node": "^0.300.0",
     "body-parser": "^2.2.2",
     "compression": "^1.8.1",
     "express": "^5.0.1",
@@ -28,6 +40,16 @@
     "typescript": "^5.7.3",
     "vitest": "^3.0.0"
   },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./otel": {
+      "types": "./dist/otel.d.ts",
+      "default": "./dist/otel.js"
+    }
+  },
   "scripts": {
     "build": "tsc",
     "release": "pnpm build && pnpm version minor --no-git-checks --message 'chore: Published @bigfootai/sdk v%s' && pnpm publish --no-git-checks",