@prairielearn/opentelemetry 1.11.3 → 2.0.1

package/.mocharc.cjs

@@ -0,0 +1,3 @@
+module.exports = {
+  require: ['tsx'],
+};

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @prairielearn/opentelemetry
 
+## 2.0.1
+
+### Patch Changes
+
+- 901fce8: Upgrade all JavaScript dependencies
+- b697912: Fix CommonJS preloads of packages
+
+## 2.0.0
+
+### Major Changes
+
+- 4f30b7e: Publish as native ESM
+
+### Minor Changes
+
+- c51f3aa: Upgrade all JavaScript dependencies; ensure packages loaded with ESM are instrumented
+
 ## 1.11.3
 
 ### Patch Changes

package/dist/commonjs-preloads.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/commonjs-preloads.js

@@ -0,0 +1,43 @@
+import { createRequire } from 'module';
+// The packages below were determined by inspecting the implementation of each
+// instrumentation package and finding which packages/files they're patching.
+const PRELOAD_PACKAGES = [
+    // @opentelemetry/instrumentation-aws-sdk
+    '@aws-sdk/middleware-stack/dist/cjs/MiddlewareStack.js',
+    '@aws-sdk/middleware-stack/dist-cjs/MiddlewareStack.js',
+    '@aws-sdk/middleware-stack',
+    '@smithy/middleware-stack',
+    '@aws-sdk/smithy-client',
+    'aws-sdk/lib/core.js',
+    'aws-sdk',
+    // @opentelemetry/instrumentation-connect
+    'connect',
+    // @opentelemetry/instrumentation-dns
+    'dns',
+    'dns/promises',
+    // @opentelemetry/instrumentation-express
+    'express',
+    // @opentelemetry/instrumentation-http
+    'http',
+    'https',
+    // @opentelemetry/instrumentation-ioredis
+    'ioredis',
+    // @opentelemetry/instrumentation-postgres
+    'pg',
+    'pg-pool',
+    // @opentelemetry/instrumentation-redis
+    'redis',
+];
+const require = createRequire(import.meta.url);
+for (const pkg of PRELOAD_PACKAGES) {
+    try {
+        require(pkg);
+    }
+    catch (e) {
+        // If the package is not found, it's fine, it just means that it wasn't
+        // installed. We'll throw any other errors.
+        if (e.code !== 'MODULE_NOT_FOUND')
+            throw e;
+    }
+}
+//# sourceMappingURL=commonjs-preloads.js.map

package/dist/commonjs-preloads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commonjs-preloads.js","sourceRoot":"","sources":["../src/commonjs-preloads.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAEvC,8EAA8E;AAC9E,6EAA6E;AAC7E,MAAM,gBAAgB,GAAG;IACvB,yCAAyC;IACzC,uDAAuD;IACvD,uDAAuD;IACvD,2BAA2B;IAC3B,0BAA0B;IAC1B,wBAAwB;IACxB,qBAAqB;IACrB,SAAS;IACT,yCAAyC;IACzC,SAAS;IACT,qCAAqC;IACrC,KAAK;IACL,cAAc;IACd,yCAAyC;IACzC,SAAS;IACT,sCAAsC;IACtC,MAAM;IACN,OAAO;IACP,yCAAyC;IACzC,SAAS;IACT,0CAA0C;IAC1C,IAAI;IACJ,SAAS;IACT,uCAAuC;IACvC,OAAO;CACR,CAAC;AAEF,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC/C,KAAK,MAAM,GAAG,IAAI,gBAAgB,EAAE,CAAC;IACnC,IAAI,CAAC;QACH,OAAO,CAAC,GAAG,CAAC,CAAC;IACf,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,uEAAuE;QACvE,2CAA2C;QAC3C,IAAI,CAAC,CAAC,IAAI,KAAK,kBAAkB;YAAE,MAAM,CAAC,CAAC;IAC7C,CAAC;AACH,CAAC","sourcesContent":["import { createRequire } from 'module';\n\n// The packages below were determined by inspecting the implementation of each\n// instrumentation package and finding which packages/files they're patching.\nconst PRELOAD_PACKAGES = [\n  // @opentelemetry/instrumentation-aws-sdk\n  '@aws-sdk/middleware-stack/dist/cjs/MiddlewareStack.js',\n  '@aws-sdk/middleware-stack/dist-cjs/MiddlewareStack.js',\n  '@aws-sdk/middleware-stack',\n  '@smithy/middleware-stack',\n  '@aws-sdk/smithy-client',\n  'aws-sdk/lib/core.js',\n  'aws-sdk',\n  // @opentelemetry/instrumentation-connect\n  'connect',\n  // @opentelemetry/instrumentation-dns\n  'dns',\n  'dns/promises',\n  // @opentelemetry/instrumentation-express\n  'express',\n  // @opentelemetry/instrumentation-http\n  'http',\n  'https',\n  // @opentelemetry/instrumentation-ioredis\n  'ioredis',\n  // @opentelemetry/instrumentation-postgres\n  'pg',\n  'pg-pool',\n  // @opentelemetry/instrumentation-redis\n  'redis',\n];\n\nconst require = createRequire(import.meta.url);\nfor (const pkg of PRELOAD_PACKAGES) {\n  try {\n    require(pkg);\n  } catch (e: any) {\n    // If the package is not found, it's fine, it just means that it wasn't\n    // installed. We'll throw any other errors.\n    if (e.code !== 'MODULE_NOT_FOUND') throw e;\n  }\n}\n"]}

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-export { trace, metrics, context, SpanStatusCode, ValueType, TraceFlags, Meter, Counter, Histogram, UpDownCounter, ObservableCounter, ObservableUpDownCounter, ObservableGauge, ObservableResult, } from '@opentelemetry/api';
+export { trace, metrics, context, SpanStatusCode, ValueType, TraceFlags, type Meter, type Counter, type Histogram, type UpDownCounter, type ObservableCounter, type ObservableUpDownCounter, type ObservableGauge, type ObservableResult, } from '@opentelemetry/api';
 export { suppressTracing } from '@opentelemetry/core';
-export { init, shutdown, disableInstrumentations } from './init';
-export { instrumented } from './tracing';
-export { instrumentedWithMetrics, getCounter, getUpDownCounter, getHistogram, getObservableCounter, getObservableUpDownCounter, getObservableGauge, createObservableValueGauges, createObservableValueGaugesOptions, } from './metrics';
+export { init, shutdown, disableInstrumentations } from './init.js';
+export { instrumented } from './tracing.js';
+export { instrumentedWithMetrics, getCounter, getUpDownCounter, getHistogram, getObservableCounter, getObservableUpDownCounter, getObservableGauge, createObservableValueGauges, type CreateObservableValueGaugesOptions, } from './metrics.js';
+import './commonjs-preloads.js';

package/dist/index.js

@@ -1,28 +1,17 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createObservableValueGauges = exports.getObservableGauge = exports.getObservableUpDownCounter = exports.getObservableCounter = exports.getHistogram = exports.getUpDownCounter = exports.getCounter = exports.instrumentedWithMetrics = exports.instrumented = exports.disableInstrumentations = exports.shutdown = exports.init = exports.suppressTracing = exports.TraceFlags = exports.ValueType = exports.SpanStatusCode = exports.context = exports.metrics = exports.trace = void 0;
-var api_1 = require("@opentelemetry/api");
-Object.defineProperty(exports, "trace", { enumerable: true, get: function () { return api_1.trace; } });
-Object.defineProperty(exports, "metrics", { enumerable: true, get: function () { return api_1.metrics; } });
-Object.defineProperty(exports, "context", { enumerable: true, get: function () { return api_1.context; } });
-Object.defineProperty(exports, "SpanStatusCode", { enumerable: true, get: function () { return api_1.SpanStatusCode; } });
-Object.defineProperty(exports, "ValueType", { enumerable: true, get: function () { return api_1.ValueType; } });
-Object.defineProperty(exports, "TraceFlags", { enumerable: true, get: function () { return api_1.TraceFlags; } });
-var core_1 = require("@opentelemetry/core");
-Object.defineProperty(exports, "suppressTracing", { enumerable: true, get: function () { return core_1.suppressTracing; } });
-var init_1 = require("./init");
-Object.defineProperty(exports, "init", { enumerable: true, get: function () { return init_1.init; } });
-Object.defineProperty(exports, "shutdown", { enumerable: true, get: function () { return init_1.shutdown; } });
-Object.defineProperty(exports, "disableInstrumentations", { enumerable: true, get: function () { return init_1.disableInstrumentations; } });
-var tracing_1 = require("./tracing");
-Object.defineProperty(exports, "instrumented", { enumerable: true, get: function () { return tracing_1.instrumented; } });
-var metrics_1 = require("./metrics");
-Object.defineProperty(exports, "instrumentedWithMetrics", { enumerable: true, get: function () { return metrics_1.instrumentedWithMetrics; } });
-Object.defineProperty(exports, "getCounter", { enumerable: true, get: function () { return metrics_1.getCounter; } });
-Object.defineProperty(exports, "getUpDownCounter", { enumerable: true, get: function () { return metrics_1.getUpDownCounter; } });
-Object.defineProperty(exports, "getHistogram", { enumerable: true, get: function () { return metrics_1.getHistogram; } });
-Object.defineProperty(exports, "getObservableCounter", { enumerable: true, get: function () { return metrics_1.getObservableCounter; } });
-Object.defineProperty(exports, "getObservableUpDownCounter", { enumerable: true, get: function () { return metrics_1.getObservableUpDownCounter; } });
-Object.defineProperty(exports, "getObservableGauge", { enumerable: true, get: function () { return metrics_1.getObservableGauge; } });
-Object.defineProperty(exports, "createObservableValueGauges", { enumerable: true, get: function () { return metrics_1.createObservableValueGauges; } });
+export { trace, metrics, context, SpanStatusCode, ValueType, TraceFlags, } from '@opentelemetry/api';
+export { suppressTracing } from '@opentelemetry/core';
+export { init, shutdown, disableInstrumentations } from './init.js';
+export { instrumented } from './tracing.js';
+export { instrumentedWithMetrics, getCounter, getUpDownCounter, getHistogram, getObservableCounter, getObservableUpDownCounter, getObservableGauge, createObservableValueGauges, } from './metrics.js';
+// Extremely stupid workaround for the fact that the OpenTelemetry instrumentations
+// don't currently have robust support for ESM. This hack ensures that instrumented
+// packages are loaded for the first time via CJS, which the OpenTelemetry
+// instrumentation can intercept and patch. Subsequent imports can be ESM, but that
+// doesn't matter because the instrumentation has already been applied.
+//
+// OpenTelemetry introduced experimental support for ESM in
+// https://github.com/open-telemetry/opentelemetry-js/pull/3698. This requires
+// the usage of `--experimental-loader` to load the instrumentations, which
+// we currently want to avoid.
+import './commonjs-preloads.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,0CAe4B;AAd1B,4FAAA,KAAK,OAAA;AACL,8FAAA,OAAO,OAAA;AACP,8FAAA,OAAO,OAAA;AACP,qGAAA,cAAc,OAAA;AACd,gGAAA,SAAS,OAAA;AACT,iGAAA,UAAU,OAAA;AAUZ,4CAAsD;AAA7C,uGAAA,eAAe,OAAA;AAExB,+BAAiE;AAAxD,4FAAA,IAAI,OAAA;AAAE,gGAAA,QAAQ,OAAA;AAAE,+GAAA,uBAAuB,OAAA;AAChD,qCAAyC;AAAhC,uGAAA,YAAY,OAAA;AACrB,qCAUmB;AATjB,kHAAA,uBAAuB,OAAA;AACvB,qGAAA,UAAU,OAAA;AACV,2GAAA,gBAAgB,OAAA;AAChB,uGAAA,YAAY,OAAA;AACZ,+GAAA,oBAAoB,OAAA;AACpB,qHAAA,0BAA0B,OAAA;AAC1B,6GAAA,kBAAkB,OAAA;AAClB,sHAAA,2BAA2B,OAAA","sourcesContent":["export {\n  trace,\n  metrics,\n  context,\n  SpanStatusCode,\n  ValueType,\n  TraceFlags,\n  Meter,\n  Counter,\n  Histogram,\n  UpDownCounter,\n  ObservableCounter,\n  ObservableUpDownCounter,\n  ObservableGauge,\n  ObservableResult,\n} from '@opentelemetry/api';\nexport { suppressTracing } from '@opentelemetry/core';\n\nexport { init, shutdown, disableInstrumentations } from './init';\nexport { instrumented } from './tracing';\nexport {\n  instrumentedWithMetrics,\n  getCounter,\n  getUpDownCounter,\n  getHistogram,\n  getObservableCounter,\n  getObservableUpDownCounter,\n  getObservableGauge,\n  createObservableValueGauges,\n  createObservableValueGaugesOptions,\n} from './metrics';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EACL,OAAO,EACP,OAAO,EACP,cAAc,EACd,SAAS,EACT,UAAU,GASX,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAEtD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAC;AACpE,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EACL,uBAAuB,EACvB,UAAU,EACV,gBAAgB,EAChB,YAAY,EACZ,oBAAoB,EACpB,0BAA0B,EAC1B,kBAAkB,EAClB,2BAA2B,GAE5B,MAAM,cAAc,CAAC;AAEtB,mFAAmF;AACnF,mFAAmF;AACnF,0EAA0E;AAC1E,mFAAmF;AACnF,uEAAuE;AACvE,EAAE;AACF,2DAA2D;AAC3D,8EAA8E;AAC9E,2EAA2E;AAC3E,8BAA8B;AAC9B,OAAO,wBAAwB,CAAC","sourcesContent":["export {\n  trace,\n  metrics,\n  context,\n  SpanStatusCode,\n  ValueType,\n  TraceFlags,\n  type Meter,\n  type Counter,\n  type Histogram,\n  type UpDownCounter,\n  type ObservableCounter,\n  type ObservableUpDownCounter,\n  type ObservableGauge,\n  type ObservableResult,\n} from '@opentelemetry/api';\nexport { suppressTracing } from '@opentelemetry/core';\n\nexport { init, shutdown, disableInstrumentations } from './init.js';\nexport { instrumented } from './tracing.js';\nexport {\n  instrumentedWithMetrics,\n  getCounter,\n  getUpDownCounter,\n  getHistogram,\n  getObservableCounter,\n  getObservableUpDownCounter,\n  getObservableGauge,\n  createObservableValueGauges,\n  type CreateObservableValueGaugesOptions,\n} from './metrics.js';\n\n// Extremely stupid workaround for the fact that the OpenTelemetry instrumentations\n// don't currently have robust support for ESM. This hack ensures that instrumented\n// packages are loaded for the first time via CJS, which the OpenTelemetry\n// instrumentation can intercept and patch. Subsequent imports can be ESM, but that\n// doesn't matter because the instrumentation has already been applied.\n//\n// OpenTelemetry introduced experimental support for ESM in\n// https://github.com/open-telemetry/opentelemetry-js/pull/3698. This requires\n// the usage of `--experimental-loader` to load the instrumentations, which\n// we currently want to avoid.\nimport './commonjs-preloads.js';\n"]}

package/dist/init.js

@@ -1,33 +1,29 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.disableInstrumentations = exports.shutdown = exports.init = void 0;
-const grpc_js_1 = require("@grpc/grpc-js");
-const sdk_trace_node_1 = require("@opentelemetry/sdk-trace-node");
-const sdk_metrics_1 = require("@opentelemetry/sdk-metrics");
-const sdk_trace_base_1 = require("@opentelemetry/sdk-trace-base");
-const resources_1 = require("@opentelemetry/resources");
-const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
-const api_1 = require("@opentelemetry/api");
-const core_1 = require("@opentelemetry/core");
-// Exporters go here.
-const exporter_trace_otlp_grpc_1 = require("@opentelemetry/exporter-trace-otlp-grpc");
-const exporter_metrics_otlp_grpc_1 = require("@opentelemetry/exporter-metrics-otlp-grpc");
-// Instrumentations go here.
-const instrumentation_aws_sdk_1 = require("@opentelemetry/instrumentation-aws-sdk");
-const instrumentation_connect_1 = require("@opentelemetry/instrumentation-connect");
-const instrumentation_dns_1 = require("@opentelemetry/instrumentation-dns");
-const instrumentation_express_1 = require("@opentelemetry/instrumentation-express");
-const instrumentation_http_1 = require("@opentelemetry/instrumentation-http");
-const instrumentation_pg_1 = require("@opentelemetry/instrumentation-pg");
-const instrumentation_redis_1 = require("@opentelemetry/instrumentation-redis");
-// Resource detectors go here.
-const resource_detector_aws_1 = require("@opentelemetry/resource-detector-aws");
+import { Metadata, credentials } from '@grpc/grpc-js';
+import { metrics } from '@opentelemetry/api';
+import { hrTimeToMilliseconds } from '@opentelemetry/core';
+import { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-grpc';
+import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-grpc';
+import { OTLPTraceExporter as OTLPTraceExporterHttp } from '@opentelemetry/exporter-trace-otlp-http';
+import { AwsInstrumentation } from '@opentelemetry/instrumentation-aws-sdk';
+import { ConnectInstrumentation } from '@opentelemetry/instrumentation-connect';
+import { DnsInstrumentation } from '@opentelemetry/instrumentation-dns';
+import { ExpressLayerType, ExpressInstrumentation } from '@opentelemetry/instrumentation-express';
+import { HttpInstrumentation } from '@opentelemetry/instrumentation-http';
+import { IORedisInstrumentation } from '@opentelemetry/instrumentation-ioredis';
+import { PgInstrumentation } from '@opentelemetry/instrumentation-pg';
+import { RedisInstrumentation } from '@opentelemetry/instrumentation-redis';
+import { awsEc2Detector } from '@opentelemetry/resource-detector-aws';
+import { detectResourcesSync, processDetector, envDetector, Resource, } from '@opentelemetry/resources';
+import { PeriodicExportingMetricReader, MeterProvider, ConsoleMetricExporter, AggregationTemporality, } from '@opentelemetry/sdk-metrics';
+import { SimpleSpanProcessor, BatchSpanProcessor, ParentBasedSampler, TraceIdRatioBasedSampler, AlwaysOnSampler, AlwaysOffSampler, ConsoleSpanExporter, } from '@opentelemetry/sdk-trace-base';
+import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
+import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';
 /**
  * Extends `BatchSpanProcessor` to give it the ability to filter out spans
  * before they're queued up to send. This enhances our sampling process so
  * that we can filter spans _after_ they've been emitted.
  */
-class FilterBatchSpanProcessor extends sdk_trace_base_1.BatchSpanProcessor {
+class FilterBatchSpanProcessor extends BatchSpanProcessor {
     filter;
     constructor(exporter, filter) {
         super(exporter);
@@ -57,27 +53,31 @@ function filter(span) {
         // establishing a connection for the first time, which should happen only at
         // bootup, or if a connection errors out. Those are the cases we're
         // interested in, so we'll filter accordingly.
-        return (0, core_1.hrTimeToMilliseconds)(span.duration) > 1;
+        return hrTimeToMilliseconds(span.duration) > 1;
     }
     // Always return true so that we default to including a span.
     return true;
 }
+// When adding new instrumentation here, add the corresponding packages to
+// `commonjs-preloads.ts` so that we can ensure that they're loaded via CJS
+// before anything tries to load them via CJS. This is necessary because the
+// instrumentations can't hook into the ESM loader.
 const instrumentations = [
-    new instrumentation_aws_sdk_1.AwsInstrumentation(),
-    new instrumentation_connect_1.ConnectInstrumentation(),
-    new instrumentation_dns_1.DnsInstrumentation(),
-    new instrumentation_express_1.ExpressInstrumentation({
+    new AwsInstrumentation(),
+    new ConnectInstrumentation(),
+    new DnsInstrumentation(),
+    new ExpressInstrumentation({
         // We use a lot of middleware; it makes the traces way too noisy. If we
         // want telemetry on a particular middleware, we should instrument it
         // manually.
-        ignoreLayersType: [instrumentation_express_1.ExpressLayerType.MIDDLEWARE],
+        ignoreLayersType: [ExpressLayerType.MIDDLEWARE],
         ignoreLayers: [
             // These don't provide useful information to us.
             'router - /',
             'request handler - /*',
         ],
     }),
-    new instrumentation_http_1.HttpInstrumentation({
+    new HttpInstrumentation({
         ignoreIncomingPaths: [
             // socket.io requests are generally just long-polling; they don't add
             // useful information for us.
@@ -87,8 +87,9 @@ const instrumentations = [
             /\/pl\/webhooks\/ping/,
         ],
     }),
-    new instrumentation_pg_1.PgInstrumentation(),
-    new instrumentation_redis_1.RedisInstrumentation(),
+    new IORedisInstrumentation(),
+    new PgInstrumentation(),
+    new RedisInstrumentation(),
 ];
 // Enable all instrumentations now, even though we haven't configured our
 // span processors or trace exporters yet. We'll set those up later.
@@ -101,7 +102,7 @@ function getHoneycombMetadata(config, datasetSuffix = '') {
         throw new Error('Missing Honeycomb API key');
     if (!config.honeycombDataset)
         throw new Error('Missing Honeycomb dataset');
-    const metadata = new grpc_js_1.Metadata();
+    const metadata = new Metadata();
     metadata.set('x-honeycomb-team', config.honeycombApiKey);
     metadata.set('x-honeycomb-dataset', config.honeycombDataset + datasetSuffix);
     return metadata;
@@ -114,18 +115,16 @@ function getTraceExporter(config) {
     }
     switch (config.openTelemetryExporter) {
         case 'console':
-            return new sdk_trace_base_1.ConsoleSpanExporter();
+            return new ConsoleSpanExporter();
         case 'honeycomb':
-            return new exporter_trace_otlp_grpc_1.OTLPTraceExporter({
+            return new OTLPTraceExporter({
                 url: 'grpc://api.honeycomb.io:443/',
-                credentials: grpc_js_1.credentials.createSsl(),
+                credentials: credentials.createSsl(),
                 metadata: getHoneycombMetadata(config),
             });
             break;
         case 'jaeger':
-            return new exporter_trace_otlp_grpc_1.OTLPTraceExporter({
-                url: process.env.OTEL_EXPORTER_JAEGER_ENDPOINT ?? 'grpc://localhost:4317/',
-            });
+            return new OTLPTraceExporterHttp();
         default:
             throw new Error(`Unknown OpenTelemetry exporter: ${config.openTelemetryExporter}`);
     }
@@ -138,18 +137,18 @@ function getMetricExporter(config) {
     }
     switch (config.openTelemetryMetricExporter) {
         case 'console':
-            return new sdk_metrics_1.ConsoleMetricExporter();
+            return new ConsoleMetricExporter();
         case 'honeycomb':
-            return new exporter_metrics_otlp_grpc_1.OTLPMetricExporter({
+            return new OTLPMetricExporter({
                 url: 'grpc://api.honeycomb.io:443/',
-                credentials: grpc_js_1.credentials.createSsl(),
+                credentials: credentials.createSsl(),
                 // Honeycomb recommends using a separate dataset for metrics, so we'll
                 // adopt the convention of appending '-metrics' to the dataset name.
                 metadata: getHoneycombMetadata(config, '-metrics'),
                 // Delta temporality means that sums, histograms, etc. will reset each
                 // time data is collected. This more closely matches how we want to
                 // observe our metrics than the default cumulative temporality.
-                temporalityPreference: sdk_metrics_1.AggregationTemporality.DELTA,
+                temporalityPreference: AggregationTemporality.DELTA,
             });
         default:
             throw new Error(`Unknown OpenTelemetry metric exporter: ${config.openTelemetryMetricExporter}`);
@@ -167,7 +166,7 @@ function getSpanProcessor(config) {
             return new FilterBatchSpanProcessor(traceExporter, filter);
         }
         case 'simple': {
-            return new sdk_trace_base_1.SimpleSpanProcessor(traceExporter);
+            return new SimpleSpanProcessor(traceExporter);
         }
         default: {
             throw new Error(`Unknown OpenTelemetry span processor: ${config.openTelemetrySpanProcessor}`);
@@ -179,7 +178,7 @@ function getSpanProcessor(config) {
  * the correct metadata for the Honeycomb exporter. We don't actually have that
  * information available until we've loaded our config.
  */
-async function init(config) {
+export async function init(config) {
     if (!config.openTelemetryEnabled) {
         // If not enabled, do nothing. We used to disable the instrumentations, but
         // per maintainers, that can actually be problematic. See the comments on
@@ -195,16 +194,16 @@ async function init(config) {
     let sampler;
     switch (config.openTelemetrySamplerType ?? 'always-on') {
         case 'always-on': {
-            sampler = new sdk_trace_base_1.AlwaysOnSampler();
+            sampler = new AlwaysOnSampler();
             break;
         }
         case 'always-off': {
-            sampler = new sdk_trace_base_1.AlwaysOffSampler();
+            sampler = new AlwaysOffSampler();
             break;
         }
         case 'trace-id-ratio': {
-            sampler = new sdk_trace_base_1.ParentBasedSampler({
-                root: new sdk_trace_base_1.TraceIdRatioBasedSampler(config.openTelemetrySampleRate),
+            sampler = new ParentBasedSampler({
+                root: new TraceIdRatioBasedSampler(config.openTelemetrySampleRate),
             });
             break;
         }
@@ -216,14 +215,14 @@ async function init(config) {
     // asynchronously. We need to initialize our instrumentations first; only
     // then can we actually start requiring all of our code that loads our config
     // and ultimately tells us how to configure OpenTelemetry.
-    let resource = (0, resources_1.detectResourcesSync)({
-        detectors: [resource_detector_aws_1.awsEc2Detector, resources_1.processDetector, resources_1.envDetector],
+    let resource = detectResourcesSync({
+        detectors: [awsEc2Detector, processDetector, envDetector],
     });
     if (config.serviceName) {
-        resource = resource.merge(new resources_1.Resource({ [semantic_conventions_1.SemanticResourceAttributes.SERVICE_NAME]: config.serviceName }));
+        resource = resource.merge(new Resource({ [SemanticResourceAttributes.SERVICE_NAME]: config.serviceName }));
     }
     // Set up tracing instrumentation.
-    const nodeTracerProvider = new sdk_trace_node_1.NodeTracerProvider({
+    const nodeTracerProvider = new NodeTracerProvider({
         sampler,
         resource,
     });
@@ -236,36 +235,33 @@ async function init(config) {
     tracerProvider = nodeTracerProvider;
     // Set up metrics instrumentation if it's enabled.
     if (metricExporter) {
-        const meterProvider = new sdk_metrics_1.MeterProvider({
+        const meterProvider = new MeterProvider({
             resource,
             readers: [
-                new sdk_metrics_1.PeriodicExportingMetricReader({
+                new PeriodicExportingMetricReader({
                     exporter: metricExporter,
                     exportIntervalMillis: config.openTelemetryMetricExportIntervalMillis ?? 30_000,
                 }),
             ],
         });
-        api_1.metrics.setGlobalMeterProvider(meterProvider);
+        metrics.setGlobalMeterProvider(meterProvider);
     }
 }
-exports.init = init;
 /**
  * Gracefully shuts down the OpenTelemetry instrumentation. Should be called
  * when a `SIGTERM` signal is handled.
  */
-async function shutdown() {
+export async function shutdown() {
     if (tracerProvider) {
         await tracerProvider.shutdown();
         tracerProvider = null;
     }
 }
-exports.shutdown = shutdown;
 /**
  * Disables all OpenTelemetry instrumentations. This is useful for tests that
  * need to access the unwrapped modules.
  */
-function disableInstrumentations() {
+export function disableInstrumentations() {
     instrumentations.forEach((i) => i.disable());
 }
-exports.disableInstrumentations = disableInstrumentations;
 //# sourceMappingURL=init.js.map

package/dist/init.js.map

@@ -1 +1 @@
-{"version":3,"file":"init.js","sourceRoot":"","sources":["../src/init.ts"],"names":[],"mappings":";;;AAAA,2CAAsD;AAEtD,kEAAmE;AACnE,4DAMoC;AACpC,kEAYuC;AACvC,wDAKkC;AAClC,8EAAiF;AACjF,4CAA6C;AAC7C,8CAA2D;AAE3D,qBAAqB;AACrB,sFAA4E;AAC5E,0FAA+E;AAE/E,4BAA4B;AAC5B,oFAA4E;AAC5E,oFAAgF;AAChF,4EAAwE;AACxE,oFAAkG;AAClG,8EAA0E;AAC1E,0EAAsE;AACtE,gFAA4E;AAE5E,8BAA8B;AAC9B,gFAAsE;AAEtE;;;;GAIG;AACH,MAAM,wBAAyB,SAAQ,mCAAkB;IAC/C,MAAM,CAAkC;IAEhD,YAAY,QAAsB,EAAE,MAAuC;QACzE,KAAK,CAAC,QAAQ,CAAC,CAAC;QAChB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAkB;QACtB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YAAE,OAAO;QAE/B,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;CACF;AAED;;;;GAIG;AACH,SAAS,MAAM,CAAC,IAAkB;IAChC,IAAI,IAAI,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;QACpC,6EAA6E;QAC7E,2EAA2E;QAC3E,mEAAmE;QACnE,4EAA4E;QAC5E,mEAAmE;QACnE,8CAA8C;QAC9C,OAAO,IAAA,2BAAoB,EAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACjD,CAAC;IAED,6DAA6D;IAC7D,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,gBAAgB,GAAG;IACvB,IAAI,4CAAkB,EAAE;IACxB,IAAI,gDAAsB,EAAE;IAC5B,IAAI,wCAAkB,EAAE;IACxB,IAAI,gDAAsB,CAAC;QACzB,uEAAuE;QACvE,qEAAqE;QACrE,YAAY;QACZ,gBAAgB,EAAE,CAAC,0CAAgB,CAAC,UAAU,CAAC;QAC/C,YAAY,EAAE;YACZ,gDAAgD;YAChD,YAAY;YACZ,sBAAsB;SACvB;KACF,CAAC;IACF,IAAI,0CAAmB,CAAC;QACtB,mBAAmB,EAAE;YACnB,qEAAqE;YACrE,6BAA6B;YAC7B,eAAe;YACf,8EAA8E;YAC9E,qDAAqD;YACrD,sBAAsB;SACvB;KACF,CAAC;IACF,IAAI,sCAAiB,EAAE;IACvB,IAAI,4CAAoB,EAAE;CAC3B,CAAC;AAEF,yEAAyE;AACzE,oEAAoE;AACpE,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;IAC7B,CAAC,CAAC,MAAM,EAAE,CAAC;AACb,CAAC,CAAC,CAAC;AAEH,IAAI,cAAyC,CAAC;AAuB9C,SAAS,oBAAoB,CAAC,MAA2B,EAAE,aAAa,GAAG,EAAE;IAC3E,IAAI,CAAC,MAAM,CAAC,eAAe;QAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC1E,IAAI,CAAC,MAAM,CAAC,gBAAgB;QAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAE3E,MAAM,QAAQ,GAAG,IAAI,kBAAQ,EAAE,CAAC;IAEhC,QAAQ,CAAC,GAAG,CAAC,kBAAkB,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;IACzD,QAAQ,CAAC,GAAG,CAAC,qBAAqB,EAAE,MAAM,CAAC,gBAAgB,GAAG,aAAa,CAAC,CAAC;IAE7E,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,gBAAgB,CAAC,MAA2B;IACnD,IAAI,CAAC,MAAM,CAAC,qBAAqB;QAAE,OAAO,IAAI,CAAC;IAE/C,IAAI,OAAO,MAAM,CAAC,qBAAqB,KAAK,QAAQ,EAAE,CAAC;QACrD,OAAO,MAAM,CAAC,qBAAqB,CAAC;IACtC,CAAC;IAED,QAAQ,MAAM,CAAC,qBAAqB,EAAE,CAAC;QACrC,KAAK,SAAS;YACZ,OAAO,IAAI,oCAAmB,EAAE,CAAC;QACnC,KAAK,WAAW;YACd,OAAO,IAAI,4CAAiB,CAAC;gBAC3B,GAAG,EAAE,8BAA8B;gBACnC,WAAW,EAAE,qBAAW,CAAC,SAAS,EAAE;gBACpC,QAAQ,EAAE,oBAAoB,CAAC,MAAM,CAAC;aACvC,CAAC,CAAC;YACH,MAAM;QACR,KAAK,QAAQ;YACX,OAAO,IAAI,4CAAiB,CAAC;gBAC3B,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,6BAA6B,IAAI,wBAAwB;aAC3E,CAAC,CAAC;QACL;YACE,MAAM,IAAI,KAAK,CAAC,mCAAmC,MAAM,CAAC,qBAAqB,EAAE,CAAC,CAAC;IACvF,CAAC;AACH,CAAC;AAED,SAAS,iBAAiB,CAAC,MAA2B;IACpD,IAAI,CAAC,MAAM,CAAC,2BAA2B;QAAE,OAAO,IAAI,CAAC;IAErD,IAAI,OAAO,MAAM,CAAC,2BAA2B,KAAK,QAAQ,EAAE,CAAC;QAC3D,OAAO,MAAM,CAAC,2BAA2B,CAAC;IAC5C,CAAC;IAED,QAAQ,MAAM,CAAC,2BAA2B,EAAE,CAAC;QAC3C,KAAK,SAAS;YACZ,OAAO,IAAI,mCAAqB,EAAE,CAAC;QACrC,KAAK,WAAW;YACd,OAAO,IAAI,+CAAkB,CAAC;gBAC5B,GAAG,EAAE,8BAA8B;gBACnC,WAAW,EAAE,qBAAW,CAAC,SAAS,EAAE;gBACpC,sEAAsE;gBACtE,oEAAoE;gBACpE,QAAQ,EAAE,oBAAoB,CAAC,MAAM,EAAE,UAAU,CAAC;gBAClD,sEAAsE;gBACtE,mEAAmE;gBACnE,+DAA+D;gBAC/D,qBAAqB,EAAE,oCAAsB,CAAC,KAAK;aACpD,CAAC,CAAC;QACL;YACE,MAAM,IAAI,KAAK,CACb,0CAA0C,MAAM,CAAC,2BAA2B,EAAE,CAC/E,CAAC;IACN,CAAC;AACH,CAAC;AAED,SAAS,gBAAgB,CAAC,MAA2B;IACnD,IAAI,OAAO,MAAM,CAAC,0BAA0B,KAAK,QAAQ,EAAE,CAAC;QAC1D,OAAO,MAAM,CAAC,0BAA0B,CAAC;IAC3C,CAAC;IAED,MAAM,aAAa,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC/C,IAAI,CAAC,aAAa;QAAE,OAAO,IAAI,CAAC;IAEhC,QAAQ,MAAM,CAAC,0BAA0B,IAAI,OAAO,EAAE,CAAC;QACrD,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,OAAO,IAAI,wBAAwB,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;QAC7D,CAAC;QACD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,OAAO,IAAI,oCAAmB,CAAC,aAAa,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAI,KAAK,CAAC,yCAAyC,MAAM,CAAC,0BAA0B,EAAE,CAAC,CAAC;QAChG,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,IAAI,CAAC,MAA2B;IACpD,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,CAAC;QACjC,2EAA2E;QAC3E,yEAAyE;QACzE,wEAAwE;QACxE,qEAAqE;QACrE,0EAA0E;QAC1E,+CAA+C;QAC/C,sEAAsE;QACtE,OAAO;IACT,CAAC;IAED,MAAM,cAAc,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACjD,MAAM,aAAa,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAE/C,IAAI,OAAgB,CAAC;IACrB,QAAQ,MAAM,CAAC,wBAAwB,IAAI,WAAW,EAAE,CAAC;QACvD,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,OAAO,GAAG,IAAI,gCAAe,EAAE,CAAC;YAChC,MAAM;QACR,CAAC;QACD,KAAK,YAAY,CAAC,CAAC,CAAC;YAClB,OAAO,GAAG,IAAI,iCAAgB,EAAE,CAAC;YACjC,MAAM;QACR,CAAC;QACD,KAAK,gBAAgB,CAAC,CAAC,CAAC;YACtB,OAAO,GAAG,IAAI,mCAAkB,CAAC;gBAC/B,IAAI,EAAE,IAAI,yCAAwB,CAAC,MAAM,CAAC,uBAAuB,CAAC;aACnE,CAAC,CAAC;YACH,MAAM;QACR,CAAC;QACD;YACE,MAAM,IAAI,KAAK,CAAC,uCAAuC,MAAM,CAAC,wBAAwB,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED,2EAA2E;IAC3E,4EAA4E;IAC5E,yEAAyE;IACzE,6EAA6E;IAC7E,0DAA0D;IAE1D,IAAI,QAAQ,GAAG,IAAA,+BAAmB,EAAC;QACjC,SAAS,EAAE,CAAC,sCAAc,EAAE,2BAAe,EAAE,uBAAW,CAAC;KAC1D,CAAC,CAAC;IAEH,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;QACvB,QAAQ,GAAG,QAAQ,CAAC,KAAK,CACvB,IAAI,oBAAQ,CAAC,EAAE,CAAC,iDAA0B,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC,CAChF,CAAC;IACJ,CAAC;IAED,kCAAkC;IAClC,MAAM,kBAAkB,GAAG,IAAI,mCAAkB,CAAC;QAChD,OAAO;QACP,QAAQ;KACT,CAAC,CAAC;IACH,IAAI,aAAa,EAAE,CAAC;QAClB,kBAAkB,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IACrD,CAAC;IACD,kBAAkB,CAAC,QAAQ,EAAE,CAAC;IAC9B,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAEzE,kDAAkD;IAClD,cAAc,GAAG,kBAAkB,CAAC;IAEpC,kDAAkD;IAClD,IAAI,cAAc,EAAE,CAAC;QACnB,MAAM,aAAa,GAAG,IAAI,2BAAa,CAAC;YACtC,QAAQ;YACR,OAAO,EAAE;gBACP,IAAI,2CAA6B,CAAC;oBAChC,QAAQ,EAAE,cAAc;oBACxB,oBAAoB,EAAE,MAAM,CAAC,uCAAuC,IAAI,MAAM;iBAC/E,CAAC;aACH;SACF,CAAC,CAAC;QACH,aAAO,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;IAChD,CAAC;AACH,CAAC;AA9ED,oBA8EC;AAED;;;GAGG;AACI,KAAK,UAAU,QAAQ;IAC5B,IAAI,cAAc,EAAE,CAAC;QACnB,MAAM,cAAc,CAAC,QAAQ,EAAE,CAAC;QAChC,cAAc,GAAG,IAAI,CAAC;IACxB,CAAC;AACH,CAAC;AALD,4BAKC;AAED;;;GAGG;AACH,SAAgB,uBAAuB;IACrC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/C,CAAC;AAFD,0DAEC","sourcesContent":["import { Metadata, credentials } from '@grpc/grpc-js';\n\nimport { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';\nimport {\n  PeriodicExportingMetricReader,\n  MeterProvider,\n  PushMetricExporter,\n  ConsoleMetricExporter,\n  AggregationTemporality,\n} from '@opentelemetry/sdk-metrics';\nimport {\n  SpanExporter,\n  ReadableSpan,\n  SpanProcessor,\n  SimpleSpanProcessor,\n  BatchSpanProcessor,\n  ParentBasedSampler,\n  TraceIdRatioBasedSampler,\n  AlwaysOnSampler,\n  AlwaysOffSampler,\n  Sampler,\n  ConsoleSpanExporter,\n} from '@opentelemetry/sdk-trace-base';\nimport {\n  detectResourcesSync,\n  processDetector,\n  envDetector,\n  Resource,\n} from '@opentelemetry/resources';\nimport { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';\nimport { metrics } from '@opentelemetry/api';\nimport { hrTimeToMilliseconds } from '@opentelemetry/core';\n\n// Exporters go here.\nimport { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-grpc';\nimport { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-grpc';\n\n// Instrumentations go here.\nimport { AwsInstrumentation } from '@opentelemetry/instrumentation-aws-sdk';\nimport { ConnectInstrumentation } from '@opentelemetry/instrumentation-connect';\nimport { DnsInstrumentation } from '@opentelemetry/instrumentation-dns';\nimport { ExpressLayerType, ExpressInstrumentation } from '@opentelemetry/instrumentation-express';\nimport { HttpInstrumentation } from '@opentelemetry/instrumentation-http';\nimport { PgInstrumentation } from '@opentelemetry/instrumentation-pg';\nimport { RedisInstrumentation } from '@opentelemetry/instrumentation-redis';\n\n// Resource detectors go here.\nimport { awsEc2Detector } from '@opentelemetry/resource-detector-aws';\n\n/**\n * Extends `BatchSpanProcessor` to give it the ability to filter out spans\n * before they're queued up to send. This enhances our sampling process so\n * that we can filter spans _after_ they've been emitted.\n */\nclass FilterBatchSpanProcessor extends BatchSpanProcessor {\n  private filter: (span: ReadableSpan) => boolean;\n\n  constructor(exporter: SpanExporter, filter: (span: ReadableSpan) => boolean) {\n    super(exporter);\n    this.filter = filter;\n  }\n\n  /**\n   * This is invoked after a span is \"finalized\". `super.onEnd` will queue up\n   * the span to be exported, but if we don't call that, we can just drop the\n   * span and the parent will be none the wiser!\n   */\n  onEnd(span: ReadableSpan) {\n    if (!this.filter(span)) return;\n\n    super.onEnd(span);\n  }\n}\n\n/**\n * This will be used with our {@link FilterBatchSpanProcessor} to filter out\n * events that we're not interested in. This helps reduce our event volume\n * but still gives us fine-grained control over which events we keep.\n */\nfunction filter(span: ReadableSpan) {\n  if (span.name === 'pg-pool.connect') {\n    // Looking at historical data, this generally happens in under a millisecond,\n    // precisely because we maintain a pool of long-lived connections. The only\n    // time obtaining a client should take longer than that is if we're\n    // establishing a connection for the first time, which should happen only at\n    // bootup, or if a connection errors out. Those are the cases we're\n    // interested in, so we'll filter accordingly.\n    return hrTimeToMilliseconds(span.duration) > 1;\n  }\n\n  // Always return true so that we default to including a span.\n  return true;\n}\n\nconst instrumentations = [\n  new AwsInstrumentation(),\n  new ConnectInstrumentation(),\n  new DnsInstrumentation(),\n  new ExpressInstrumentation({\n    // We use a lot of middleware; it makes the traces way too noisy. If we\n    // want telemetry on a particular middleware, we should instrument it\n    // manually.\n    ignoreLayersType: [ExpressLayerType.MIDDLEWARE],\n    ignoreLayers: [\n      // These don't provide useful information to us.\n      'router - /',\n      'request handler - /*',\n    ],\n  }),\n  new HttpInstrumentation({\n    ignoreIncomingPaths: [\n      // socket.io requests are generally just long-polling; they don't add\n      // useful information for us.\n      /\\/socket.io\\//,\n      // We get several of these per second; they just chew through our event quota.\n      // They don't really do anything interesting anyways.\n      /\\/pl\\/webhooks\\/ping/,\n    ],\n  }),\n  new PgInstrumentation(),\n  new RedisInstrumentation(),\n];\n\n// Enable all instrumentations now, even though we haven't configured our\n// span processors or trace exporters yet. We'll set those up later.\ninstrumentations.forEach((i) => {\n  i.enable();\n});\n\nlet tracerProvider: NodeTracerProvider | null;\n\ninterface OpenTelemetryConfigEnabled {\n  openTelemetryEnabled: boolean;\n  openTelemetryExporter?: 'console' | 'honeycomb' | 'jaeger' | SpanExporter | null;\n  openTelemetryMetricExporter?: 'console' | 'honeycomb' | PushMetricExporter | null;\n  openTelemetryMetricExportIntervalMillis?: number;\n  openTelemetrySamplerType: 'always-on' | 'always-off' | 'trace-id-ratio';\n  openTelemetrySampleRate?: number;\n  openTelemetrySpanProcessor?: 'batch' | 'simple' | SpanProcessor;\n  honeycombApiKey?: string | null;\n  honeycombDataset?: string | null;\n  serviceName?: string;\n}\n\n// When we know for sure that OpenTelemetry is disabled, we won't require\n// any other attributes to be set.\ninterface OpenTelemetryConfigDisabled extends Partial<OpenTelemetryConfigEnabled> {\n  openTelemetryEnabled: false;\n}\n\nexport type OpenTelemetryConfig = OpenTelemetryConfigEnabled | OpenTelemetryConfigDisabled;\n\nfunction getHoneycombMetadata(config: OpenTelemetryConfig, datasetSuffix = ''): Metadata {\n  if (!config.honeycombApiKey) throw new Error('Missing Honeycomb API key');\n  if (!config.honeycombDataset) throw new Error('Missing Honeycomb dataset');\n\n  const metadata = new Metadata();\n\n  metadata.set('x-honeycomb-team', config.honeycombApiKey);\n  metadata.set('x-honeycomb-dataset', config.honeycombDataset + datasetSuffix);\n\n  return metadata;\n}\n\nfunction getTraceExporter(config: OpenTelemetryConfig): SpanExporter | null {\n  if (!config.openTelemetryExporter) return null;\n\n  if (typeof config.openTelemetryExporter === 'object') {\n    return config.openTelemetryExporter;\n  }\n\n  switch (config.openTelemetryExporter) {\n    case 'console':\n      return new ConsoleSpanExporter();\n    case 'honeycomb':\n      return new OTLPTraceExporter({\n        url: 'grpc://api.honeycomb.io:443/',\n        credentials: credentials.createSsl(),\n        metadata: getHoneycombMetadata(config),\n      });\n      break;\n    case 'jaeger':\n      return new OTLPTraceExporter({\n        url: process.env.OTEL_EXPORTER_JAEGER_ENDPOINT ?? 'grpc://localhost:4317/',\n      });\n    default:\n      throw new Error(`Unknown OpenTelemetry exporter: ${config.openTelemetryExporter}`);\n  }\n}\n\nfunction getMetricExporter(config: OpenTelemetryConfig): PushMetricExporter | null {\n  if (!config.openTelemetryMetricExporter) return null;\n\n  if (typeof config.openTelemetryMetricExporter === 'object') {\n    return config.openTelemetryMetricExporter;\n  }\n\n  switch (config.openTelemetryMetricExporter) {\n    case 'console':\n      return new ConsoleMetricExporter();\n    case 'honeycomb':\n      return new OTLPMetricExporter({\n        url: 'grpc://api.honeycomb.io:443/',\n        credentials: credentials.createSsl(),\n        // Honeycomb recommends using a separate dataset for metrics, so we'll\n        // adopt the convention of appending '-metrics' to the dataset name.\n        metadata: getHoneycombMetadata(config, '-metrics'),\n        // Delta temporality means that sums, histograms, etc. will reset each\n        // time data is collected. This more closely matches how we want to\n        // observe our metrics than the default cumulative temporality.\n        temporalityPreference: AggregationTemporality.DELTA,\n      });\n    default:\n      throw new Error(\n        `Unknown OpenTelemetry metric exporter: ${config.openTelemetryMetricExporter}`,\n      );\n  }\n}\n\nfunction getSpanProcessor(config: OpenTelemetryConfig): SpanProcessor | null {\n  if (typeof config.openTelemetrySpanProcessor === 'object') {\n    return config.openTelemetrySpanProcessor;\n  }\n\n  const traceExporter = getTraceExporter(config);\n  if (!traceExporter) return null;\n\n  switch (config.openTelemetrySpanProcessor ?? 'batch') {\n    case 'batch': {\n      return new FilterBatchSpanProcessor(traceExporter, filter);\n    }\n    case 'simple': {\n      return new SimpleSpanProcessor(traceExporter);\n    }\n    default: {\n      throw new Error(`Unknown OpenTelemetry span processor: ${config.openTelemetrySpanProcessor}`);\n    }\n  }\n}\n\n/**\n * Should be called once we've loaded our config; this will allow us to set up\n * the correct metadata for the Honeycomb exporter. We don't actually have that\n * information available until we've loaded our config.\n */\nexport async function init(config: OpenTelemetryConfig) {\n  if (!config.openTelemetryEnabled) {\n    // If not enabled, do nothing. We used to disable the instrumentations, but\n    // per maintainers, that can actually be problematic. See the comments on\n    // https://github.com/open-telemetry/opentelemetry-js-contrib/issues/970\n    // The Express instrumentation also logs a benign error, which can be\n    // confusing to users. There's a fix in progress if we want to switch back\n    // to disabling instrumentations in the future:\n    // https://github.com/open-telemetry/opentelemetry-js-contrib/pull/972\n    return;\n  }\n\n  const metricExporter = getMetricExporter(config);\n  const spanProcessor = getSpanProcessor(config);\n\n  let sampler: Sampler;\n  switch (config.openTelemetrySamplerType ?? 'always-on') {\n    case 'always-on': {\n      sampler = new AlwaysOnSampler();\n      break;\n    }\n    case 'always-off': {\n      sampler = new AlwaysOffSampler();\n      break;\n    }\n    case 'trace-id-ratio': {\n      sampler = new ParentBasedSampler({\n        root: new TraceIdRatioBasedSampler(config.openTelemetrySampleRate),\n      });\n      break;\n    }\n    default:\n      throw new Error(`Unknown OpenTelemetry sampler type: ${config.openTelemetrySamplerType}`);\n  }\n\n  // Much of this functionality is copied from `@opentelemetry/sdk-node`, but\n  // we can't use the SDK directly because of the fact that we load our config\n  // asynchronously. We need to initialize our instrumentations first; only\n  // then can we actually start requiring all of our code that loads our config\n  // and ultimately tells us how to configure OpenTelemetry.\n\n  let resource = detectResourcesSync({\n    detectors: [awsEc2Detector, processDetector, envDetector],\n  });\n\n  if (config.serviceName) {\n    resource = resource.merge(\n      new Resource({ [SemanticResourceAttributes.SERVICE_NAME]: config.serviceName }),\n    );\n  }\n\n  // Set up tracing instrumentation.\n  const nodeTracerProvider = new NodeTracerProvider({\n    sampler,\n    resource,\n  });\n  if (spanProcessor) {\n    nodeTracerProvider.addSpanProcessor(spanProcessor);\n  }\n  nodeTracerProvider.register();\n  instrumentations.forEach((i) => i.setTracerProvider(nodeTracerProvider));\n\n  // Save the provider so we can shut it down later.\n  tracerProvider = nodeTracerProvider;\n\n  // Set up metrics instrumentation if it's enabled.\n  if (metricExporter) {\n    const meterProvider = new MeterProvider({\n      resource,\n      readers: [\n        new PeriodicExportingMetricReader({\n          exporter: metricExporter,\n          exportIntervalMillis: config.openTelemetryMetricExportIntervalMillis ?? 30_000,\n        }),\n      ],\n    });\n    metrics.setGlobalMeterProvider(meterProvider);\n  }\n}\n\n/**\n * Gracefully shuts down the OpenTelemetry instrumentation. Should be called\n * when a `SIGTERM` signal is handled.\n */\nexport async function shutdown(): Promise<void> {\n  if (tracerProvider) {\n    await tracerProvider.shutdown();\n    tracerProvider = null;\n  }\n}\n\n/**\n * Disables all OpenTelemetry instrumentations. This is useful for tests that\n * need to access the unwrapped modules.\n */\nexport function disableInstrumentations() {\n  instrumentations.forEach((i) => i.disable());\n}\n"]}
+{"version":3,"file":"init.js","sourceRoot":"","sources":["../src/init.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,iBAAiB,EAAE,MAAM,yCAAyC,CAAC;AAC5E,OAAO,EAAE,iBAAiB,IAAI,qBAAqB,EAAE,MAAM,yCAAyC,CAAC;AACrG,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EAAE,sBAAsB,EAAE,MAAM,wCAAwC,CAAC;AAChF,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AACxE,OAAO,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,wCAAwC,CAAC;AAClG,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,EAAE,sBAAsB,EAAE,MAAM,wCAAwC,CAAC;AAChF,OAAO,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AACtE,OAAO,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAC5E,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AACtE,OAAO,EACL,mBAAmB,EACnB,eAAe,EACf,WAAW,EACX,QAAQ,GACT,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,6BAA6B,EAC7B,aAAa,EAEb,qBAAqB,EACrB,sBAAsB,GACvB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAIL,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,EAClB,wBAAwB,EACxB,eAAe,EACf,gBAAgB,EAEhB,mBAAmB,GACpB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AAEjF;;;;GAIG;AACH,MAAM,wBAAyB,SAAQ,kBAAkB;IAC/C,MAAM,CAAkC;IAEhD,YAAY,QAAsB,EAAE,MAAuC;QACzE,KAAK,CAAC,QAAQ,CAAC,CAAC;QAChB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAkB;QACtB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YAAE,OAAO;QAE/B,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;CACF;AAED;;;;GAIG;AACH,SAAS,MAAM,CAAC,IAAkB;IAChC,IAAI,IAAI,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;QACpC,6EAA6E;QAC7E,2EAA2E;QAC3E,mEAAmE;QACnE,4EAA4E;QAC5E,mEAAmE;QACnE,8CAA8C;QAC9C,OAAO,oBAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACjD,CAAC;IAED,6DAA6D;IAC7D,OAAO,IAAI,CAAC;AACd,CAAC;AAED,0EAA0E;AAC1E,2EAA2E;AAC3E,4EAA4E;AAC5E,mDAAmD;AACnD,MAAM,gBAAgB,GAAG;IACvB,IAAI,kBAAkB,EAAE;IACxB,IAAI,sBAAsB,EAAE;IAC5B,IAAI,kBAAkB,EAAE;IACxB,IAAI,sBAAsB,CAAC;QACzB,uEAAuE;QACvE,qEAAqE;QACrE,YAAY;QACZ,gBAAgB,EAAE,CAAC,gBAAgB,CAAC,UAAU,CAAC;QAC/C,YAAY,EAAE;YACZ,gDAAgD;YAChD,YAAY;YACZ,sBAAsB;SACvB;KACF,CAAC;IACF,IAAI,mBAAmB,CAAC;QACtB,mBAAmB,EAAE;YACnB,qEAAqE;YACrE,6BAA6B;YAC7B,eAAe;YACf,8EAA8E;YAC9E,qDAAqD;YACrD,sBAAsB;SACvB;KACF,CAAC;IACF,IAAI,sBAAsB,EAAE;IAC5B,IAAI,iBAAiB,EAAE;IACvB,IAAI,oBAAoB,EAAE;CAC3B,CAAC;AAEF,yEAAyE;AACzE,oEAAoE;AACpE,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;IAC7B,CAAC,CAAC,MAAM,EAAE,CAAC;AACb,CAAC,CAAC,CAAC;AAEH,IAAI,cAAyC,CAAC;AAuB9C,SAAS,oBAAoB,CAAC,MAA2B,EAAE,aAAa,GAAG,EAAE;IAC3E,IAAI,CAAC,MAAM,CAAC,eAAe;QAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC1E,IAAI,CAAC,MAAM,CAAC,gBAAgB;QAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAE3E,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;IAEhC,QAAQ,CAAC,GAAG,CAAC,kBAAkB,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;IACzD,QAAQ,CAAC,GAAG,CAAC,qBAAqB,EAAE,MAAM,CAAC,gBAAgB,GAAG,aAAa,CAAC,CAAC;IAE7E,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,gBAAgB,CAAC,MAA2B;IACnD,IAAI,CAAC,MAAM,CAAC,qBAAqB;QAAE,OAAO,IAAI,CAAC;IAE/C,IAAI,OAAO,MAAM,CAAC,qBAAqB,KAAK,QAAQ,EAAE,CAAC;QACrD,OAAO,MAAM,CAAC,qBAAqB,CAAC;IACtC,CAAC;IAED,QAAQ,MAAM,CAAC,qBAAqB,EAAE,CAAC;QACrC,KAAK,SAAS;YACZ,OAAO,IAAI,mBAAmB,EAAE,CAAC;QACnC,KAAK,WAAW;YACd,OAAO,IAAI,iBAAiB,CAAC;gBAC3B,GAAG,EAAE,8BAA8B;gBACnC,WAAW,EAAE,WAAW,CAAC,SAAS,EAAE;gBACpC,QAAQ,EAAE,oBAAoB,CAAC,MAAM,CAAC;aACvC,CAAC,CAAC;YACH,MAAM;QACR,KAAK,QAAQ;YACX,OAAO,IAAI,qBAAqB,EAAE,CAAC;QACrC;YACE,MAAM,IAAI,KAAK,CAAC,mCAAmC,MAAM,CAAC,qBAAqB,EAAE,CAAC,CAAC;IACvF,CAAC;AACH,CAAC;AAED,SAAS,iBAAiB,CAAC,MAA2B;IACpD,IAAI,CAAC,MAAM,CAAC,2BAA2B;QAAE,OAAO,IAAI,CAAC;IAErD,IAAI,OAAO,MAAM,CAAC,2BAA2B,KAAK,QAAQ,EAAE,CAAC;QAC3D,OAAO,MAAM,CAAC,2BAA2B,CAAC;IAC5C,CAAC;IAED,QAAQ,MAAM,CAAC,2BAA2B,EAAE,CAAC;QAC3C,KAAK,SAAS;YACZ,OAAO,IAAI,qBAAqB,EAAE,CAAC;QACrC,KAAK,WAAW;YACd,OAAO,IAAI,kBAAkB,CAAC;gBAC5B,GAAG,EAAE,8BAA8B;gBACnC,WAAW,EAAE,WAAW,CAAC,SAAS,EAAE;gBACpC,sEAAsE;gBACtE,oEAAoE;gBACpE,QAAQ,EAAE,oBAAoB,CAAC,MAAM,EAAE,UAAU,CAAC;gBAClD,sEAAsE;gBACtE,mEAAmE;gBACnE,+DAA+D;gBAC/D,qBAAqB,EAAE,sBAAsB,CAAC,KAAK;aACpD,CAAC,CAAC;QACL;YACE,MAAM,IAAI,KAAK,CACb,0CAA0C,MAAM,CAAC,2BAA2B,EAAE,CAC/E,CAAC;IACN,CAAC;AACH,CAAC;AAED,SAAS,gBAAgB,CAAC,MAA2B;IACnD,IAAI,OAAO,MAAM,CAAC,0BAA0B,KAAK,QAAQ,EAAE,CAAC;QAC1D,OAAO,MAAM,CAAC,0BAA0B,CAAC;IAC3C,CAAC;IAED,MAAM,aAAa,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC/C,IAAI,CAAC,aAAa;QAAE,OAAO,IAAI,CAAC;IAEhC,QAAQ,MAAM,CAAC,0BAA0B,IAAI,OAAO,EAAE,CAAC;QACrD,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,OAAO,IAAI,wBAAwB,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;QAC7D,CAAC;QACD,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,OAAO,IAAI,mBAAmB,CAAC,aAAa,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAI,KAAK,CAAC,yCAAyC,MAAM,CAAC,0BAA0B,EAAE,CAAC,CAAC;QAChG,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,MAA2B;IACpD,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,CAAC;QACjC,2EAA2E;QAC3E,yEAAyE;QACzE,wEAAwE;QACxE,qEAAqE;QACrE,0EAA0E;QAC1E,+CAA+C;QAC/C,sEAAsE;QACtE,OAAO;IACT,CAAC;IAED,MAAM,cAAc,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACjD,MAAM,aAAa,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAE/C,IAAI,OAAgB,CAAC;IACrB,QAAQ,MAAM,CAAC,wBAAwB,IAAI,WAAW,EAAE,CAAC;QACvD,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,OAAO,GAAG,IAAI,eAAe,EAAE,CAAC;YAChC,MAAM;QACR,CAAC;QACD,KAAK,YAAY,CAAC,CAAC,CAAC;YAClB,OAAO,GAAG,IAAI,gBAAgB,EAAE,CAAC;YACjC,MAAM;QACR,CAAC;QACD,KAAK,gBAAgB,CAAC,CAAC,CAAC;YACtB,OAAO,GAAG,IAAI,kBAAkB,CAAC;gBAC/B,IAAI,EAAE,IAAI,wBAAwB,CAAC,MAAM,CAAC,uBAAuB,CAAC;aACnE,CAAC,CAAC;YACH,MAAM;QACR,CAAC;QACD;YACE,MAAM,IAAI,KAAK,CAAC,uCAAuC,MAAM,CAAC,wBAAwB,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED,2EAA2E;IAC3E,4EAA4E;IAC5E,yEAAyE;IACzE,6EAA6E;IAC7E,0DAA0D;IAE1D,IAAI,QAAQ,GAAG,mBAAmB,CAAC;QACjC,SAAS,EAAE,CAAC,cAAc,EAAE,eAAe,EAAE,WAAW,CAAC;KAC1D,CAAC,CAAC;IAEH,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;QACvB,QAAQ,GAAG,QAAQ,CAAC,KAAK,CACvB,IAAI,QAAQ,CAAC,EAAE,CAAC,0BAA0B,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC,CAChF,CAAC;IACJ,CAAC;IAED,kCAAkC;IAClC,MAAM,kBAAkB,GAAG,IAAI,kBAAkB,CAAC;QAChD,OAAO;QACP,QAAQ;KACT,CAAC,CAAC;IACH,IAAI,aAAa,EAAE,CAAC;QAClB,kBAAkB,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IACrD,CAAC;IACD,kBAAkB,CAAC,QAAQ,EAAE,CAAC;IAC9B,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAEzE,kDAAkD;IAClD,cAAc,GAAG,kBAAkB,CAAC;IAEpC,kDAAkD;IAClD,IAAI,cAAc,EAAE,CAAC;QACnB,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC;YACtC,QAAQ;YACR,OAAO,EAAE;gBACP,IAAI,6BAA6B,CAAC;oBAChC,QAAQ,EAAE,cAAc;oBACxB,oBAAoB,EAAE,MAAM,CAAC,uCAAuC,IAAI,MAAM;iBAC/E,CAAC;aACH;SACF,CAAC,CAAC;QACH,OAAO,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;IAChD,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ;IAC5B,IAAI,cAAc,EAAE,CAAC;QACnB,MAAM,cAAc,CAAC,QAAQ,EAAE,CAAC;QAChC,cAAc,GAAG,IAAI,CAAC;IACxB,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,uBAAuB;IACrC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;AAC/C,CAAC","sourcesContent":["import { Metadata, credentials } from '@grpc/grpc-js';\nimport { metrics } from '@opentelemetry/api';\nimport { hrTimeToMilliseconds } from '@opentelemetry/core';\nimport { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-grpc';\nimport { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-grpc';\nimport { OTLPTraceExporter as OTLPTraceExporterHttp } from '@opentelemetry/exporter-trace-otlp-http';\nimport { AwsInstrumentation } from '@opentelemetry/instrumentation-aws-sdk';\nimport { ConnectInstrumentation } from '@opentelemetry/instrumentation-connect';\nimport { DnsInstrumentation } from '@opentelemetry/instrumentation-dns';\nimport { ExpressLayerType, ExpressInstrumentation } from '@opentelemetry/instrumentation-express';\nimport { HttpInstrumentation } from '@opentelemetry/instrumentation-http';\nimport { IORedisInstrumentation } from '@opentelemetry/instrumentation-ioredis';\nimport { PgInstrumentation } from '@opentelemetry/instrumentation-pg';\nimport { RedisInstrumentation } from '@opentelemetry/instrumentation-redis';\nimport { awsEc2Detector } from '@opentelemetry/resource-detector-aws';\nimport {\n  detectResourcesSync,\n  processDetector,\n  envDetector,\n  Resource,\n} from '@opentelemetry/resources';\nimport {\n  PeriodicExportingMetricReader,\n  MeterProvider,\n  PushMetricExporter,\n  ConsoleMetricExporter,\n  AggregationTemporality,\n} from '@opentelemetry/sdk-metrics';\nimport {\n  SpanExporter,\n  ReadableSpan,\n  SpanProcessor,\n  SimpleSpanProcessor,\n  BatchSpanProcessor,\n  ParentBasedSampler,\n  TraceIdRatioBasedSampler,\n  AlwaysOnSampler,\n  AlwaysOffSampler,\n  Sampler,\n  ConsoleSpanExporter,\n} from '@opentelemetry/sdk-trace-base';\nimport { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';\nimport { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';\n\n/**\n * Extends `BatchSpanProcessor` to give it the ability to filter out spans\n * before they're queued up to send. This enhances our sampling process so\n * that we can filter spans _after_ they've been emitted.\n */\nclass FilterBatchSpanProcessor extends BatchSpanProcessor {\n  private filter: (span: ReadableSpan) => boolean;\n\n  constructor(exporter: SpanExporter, filter: (span: ReadableSpan) => boolean) {\n    super(exporter);\n    this.filter = filter;\n  }\n\n  /**\n   * This is invoked after a span is \"finalized\". `super.onEnd` will queue up\n   * the span to be exported, but if we don't call that, we can just drop the\n   * span and the parent will be none the wiser!\n   */\n  onEnd(span: ReadableSpan) {\n    if (!this.filter(span)) return;\n\n    super.onEnd(span);\n  }\n}\n\n/**\n * This will be used with our {@link FilterBatchSpanProcessor} to filter out\n * events that we're not interested in. This helps reduce our event volume\n * but still gives us fine-grained control over which events we keep.\n */\nfunction filter(span: ReadableSpan) {\n  if (span.name === 'pg-pool.connect') {\n    // Looking at historical data, this generally happens in under a millisecond,\n    // precisely because we maintain a pool of long-lived connections. The only\n    // time obtaining a client should take longer than that is if we're\n    // establishing a connection for the first time, which should happen only at\n    // bootup, or if a connection errors out. Those are the cases we're\n    // interested in, so we'll filter accordingly.\n    return hrTimeToMilliseconds(span.duration) > 1;\n  }\n\n  // Always return true so that we default to including a span.\n  return true;\n}\n\n// When adding new instrumentation here, add the corresponding packages to\n// `commonjs-preloads.ts` so that we can ensure that they're loaded via CJS\n// before anything tries to load them via CJS. This is necessary because the\n// instrumentations can't hook into the ESM loader.\nconst instrumentations = [\n  new AwsInstrumentation(),\n  new ConnectInstrumentation(),\n  new DnsInstrumentation(),\n  new ExpressInstrumentation({\n    // We use a lot of middleware; it makes the traces way too noisy. If we\n    // want telemetry on a particular middleware, we should instrument it\n    // manually.\n    ignoreLayersType: [ExpressLayerType.MIDDLEWARE],\n    ignoreLayers: [\n      // These don't provide useful information to us.\n      'router - /',\n      'request handler - /*',\n    ],\n  }),\n  new HttpInstrumentation({\n    ignoreIncomingPaths: [\n      // socket.io requests are generally just long-polling; they don't add\n      // useful information for us.\n      /\\/socket.io\\//,\n      // We get several of these per second; they just chew through our event quota.\n      // They don't really do anything interesting anyways.\n      /\\/pl\\/webhooks\\/ping/,\n    ],\n  }),\n  new IORedisInstrumentation(),\n  new PgInstrumentation(),\n  new RedisInstrumentation(),\n];\n\n// Enable all instrumentations now, even though we haven't configured our\n// span processors or trace exporters yet. We'll set those up later.\ninstrumentations.forEach((i) => {\n  i.enable();\n});\n\nlet tracerProvider: NodeTracerProvider | null;\n\ninterface OpenTelemetryConfigEnabled {\n  openTelemetryEnabled: boolean;\n  openTelemetryExporter?: 'console' | 'honeycomb' | 'jaeger' | SpanExporter | null;\n  openTelemetryMetricExporter?: 'console' | 'honeycomb' | PushMetricExporter | null;\n  openTelemetryMetricExportIntervalMillis?: number;\n  openTelemetrySamplerType: 'always-on' | 'always-off' | 'trace-id-ratio';\n  openTelemetrySampleRate?: number;\n  openTelemetrySpanProcessor?: 'batch' | 'simple' | SpanProcessor;\n  honeycombApiKey?: string | null;\n  honeycombDataset?: string | null;\n  serviceName?: string;\n}\n\n// When we know for sure that OpenTelemetry is disabled, we won't require\n// any other attributes to be set.\ninterface OpenTelemetryConfigDisabled extends Partial<OpenTelemetryConfigEnabled> {\n  openTelemetryEnabled: false;\n}\n\nexport type OpenTelemetryConfig = OpenTelemetryConfigEnabled | OpenTelemetryConfigDisabled;\n\nfunction getHoneycombMetadata(config: OpenTelemetryConfig, datasetSuffix = ''): Metadata {\n  if (!config.honeycombApiKey) throw new Error('Missing Honeycomb API key');\n  if (!config.honeycombDataset) throw new Error('Missing Honeycomb dataset');\n\n  const metadata = new Metadata();\n\n  metadata.set('x-honeycomb-team', config.honeycombApiKey);\n  metadata.set('x-honeycomb-dataset', config.honeycombDataset + datasetSuffix);\n\n  return metadata;\n}\n\nfunction getTraceExporter(config: OpenTelemetryConfig): SpanExporter | null {\n  if (!config.openTelemetryExporter) return null;\n\n  if (typeof config.openTelemetryExporter === 'object') {\n    return config.openTelemetryExporter;\n  }\n\n  switch (config.openTelemetryExporter) {\n    case 'console':\n      return new ConsoleSpanExporter();\n    case 'honeycomb':\n      return new OTLPTraceExporter({\n        url: 'grpc://api.honeycomb.io:443/',\n        credentials: credentials.createSsl(),\n        metadata: getHoneycombMetadata(config),\n      });\n      break;\n    case 'jaeger':\n      return new OTLPTraceExporterHttp();\n    default:\n      throw new Error(`Unknown OpenTelemetry exporter: ${config.openTelemetryExporter}`);\n  }\n}\n\nfunction getMetricExporter(config: OpenTelemetryConfig): PushMetricExporter | null {\n  if (!config.openTelemetryMetricExporter) return null;\n\n  if (typeof config.openTelemetryMetricExporter === 'object') {\n    return config.openTelemetryMetricExporter;\n  }\n\n  switch (config.openTelemetryMetricExporter) {\n    case 'console':\n      return new ConsoleMetricExporter();\n    case 'honeycomb':\n      return new OTLPMetricExporter({\n        url: 'grpc://api.honeycomb.io:443/',\n        credentials: credentials.createSsl(),\n        // Honeycomb recommends using a separate dataset for metrics, so we'll\n        // adopt the convention of appending '-metrics' to the dataset name.\n        metadata: getHoneycombMetadata(config, '-metrics'),\n        // Delta temporality means that sums, histograms, etc. will reset each\n        // time data is collected. This more closely matches how we want to\n        // observe our metrics than the default cumulative temporality.\n        temporalityPreference: AggregationTemporality.DELTA,\n      });\n    default:\n      throw new Error(\n        `Unknown OpenTelemetry metric exporter: ${config.openTelemetryMetricExporter}`,\n      );\n  }\n}\n\nfunction getSpanProcessor(config: OpenTelemetryConfig): SpanProcessor | null {\n  if (typeof config.openTelemetrySpanProcessor === 'object') {\n    return config.openTelemetrySpanProcessor;\n  }\n\n  const traceExporter = getTraceExporter(config);\n  if (!traceExporter) return null;\n\n  switch (config.openTelemetrySpanProcessor ?? 'batch') {\n    case 'batch': {\n      return new FilterBatchSpanProcessor(traceExporter, filter);\n    }\n    case 'simple': {\n      return new SimpleSpanProcessor(traceExporter);\n    }\n    default: {\n      throw new Error(`Unknown OpenTelemetry span processor: ${config.openTelemetrySpanProcessor}`);\n    }\n  }\n}\n\n/**\n * Should be called once we've loaded our config; this will allow us to set up\n * the correct metadata for the Honeycomb exporter. We don't actually have that\n * information available until we've loaded our config.\n */\nexport async function init(config: OpenTelemetryConfig) {\n  if (!config.openTelemetryEnabled) {\n    // If not enabled, do nothing. We used to disable the instrumentations, but\n    // per maintainers, that can actually be problematic. See the comments on\n    // https://github.com/open-telemetry/opentelemetry-js-contrib/issues/970\n    // The Express instrumentation also logs a benign error, which can be\n    // confusing to users. There's a fix in progress if we want to switch back\n    // to disabling instrumentations in the future:\n    // https://github.com/open-telemetry/opentelemetry-js-contrib/pull/972\n    return;\n  }\n\n  const metricExporter = getMetricExporter(config);\n  const spanProcessor = getSpanProcessor(config);\n\n  let sampler: Sampler;\n  switch (config.openTelemetrySamplerType ?? 'always-on') {\n    case 'always-on': {\n      sampler = new AlwaysOnSampler();\n      break;\n    }\n    case 'always-off': {\n      sampler = new AlwaysOffSampler();\n      break;\n    }\n    case 'trace-id-ratio': {\n      sampler = new ParentBasedSampler({\n        root: new TraceIdRatioBasedSampler(config.openTelemetrySampleRate),\n      });\n      break;\n    }\n    default:\n      throw new Error(`Unknown OpenTelemetry sampler type: ${config.openTelemetrySamplerType}`);\n  }\n\n  // Much of this functionality is copied from `@opentelemetry/sdk-node`, but\n  // we can't use the SDK directly because of the fact that we load our config\n  // asynchronously. We need to initialize our instrumentations first; only\n  // then can we actually start requiring all of our code that loads our config\n  // and ultimately tells us how to configure OpenTelemetry.\n\n  let resource = detectResourcesSync({\n    detectors: [awsEc2Detector, processDetector, envDetector],\n  });\n\n  if (config.serviceName) {\n    resource = resource.merge(\n      new Resource({ [SemanticResourceAttributes.SERVICE_NAME]: config.serviceName }),\n    );\n  }\n\n  // Set up tracing instrumentation.\n  const nodeTracerProvider = new NodeTracerProvider({\n    sampler,\n    resource,\n  });\n  if (spanProcessor) {\n    nodeTracerProvider.addSpanProcessor(spanProcessor);\n  }\n  nodeTracerProvider.register();\n  instrumentations.forEach((i) => i.setTracerProvider(nodeTracerProvider));\n\n  // Save the provider so we can shut it down later.\n  tracerProvider = nodeTracerProvider;\n\n  // Set up metrics instrumentation if it's enabled.\n  if (metricExporter) {\n    const meterProvider = new MeterProvider({\n      resource,\n      readers: [\n        new PeriodicExportingMetricReader({\n          exporter: metricExporter,\n          exportIntervalMillis: config.openTelemetryMetricExportIntervalMillis ?? 30_000,\n        }),\n      ],\n    });\n    metrics.setGlobalMeterProvider(meterProvider);\n  }\n}\n\n/**\n * Gracefully shuts down the OpenTelemetry instrumentation. Should be called\n * when a `SIGTERM` signal is handled.\n */\nexport async function shutdown(): Promise<void> {\n  if (tracerProvider) {\n    await tracerProvider.shutdown();\n    tracerProvider = null;\n  }\n}\n\n/**\n * Disables all OpenTelemetry instrumentations. This is useful for tests that\n * need to access the unwrapped modules.\n */\nexport function disableInstrumentations() {\n  instrumentations.forEach((i) => i.disable());\n}\n"]}

package/dist/metrics.d.ts

@@ -6,7 +6,7 @@ export declare function getObservableCounter(meter: Meter, name: string, options
 export declare function getObservableUpDownCounter(meter: Meter, name: string, options?: MetricOptions): ObservableUpDownCounter<import("@opentelemetry/api").Attributes>;
 export declare function getObservableGauge(meter: Meter, name: string, options?: MetricOptions): ObservableGauge<import("@opentelemetry/api").Attributes>;
 export declare function instrumentedWithMetrics<T>(meter: Meter, name: string, fn: () => Promise<T> | T): Promise<T>;
-export interface createObservableValueGaugesOptions extends MetricOptions {
+export interface CreateObservableValueGaugesOptions extends MetricOptions {
     interval: number;
 }
 /**
@@ -20,7 +20,7 @@ export interface createObservableValueGaugesOptions extends MetricOptions {
  * - `${name}.max`
  * - `${name}.avg`
  */
-export declare function createObservableValueGauges(meter: Meter, name: string, options: createObservableValueGaugesOptions, observe: () => number): {
+export declare function createObservableValueGauges(meter: Meter, name: string, options: CreateObservableValueGaugesOptions, observe: () => number): {
     minGauge: ObservableGauge<import("@opentelemetry/api").Attributes>;
     maxGauge: ObservableGauge<import("@opentelemetry/api").Attributes>;
     averageGauge: ObservableGauge<import("@opentelemetry/api").Attributes>;

package/dist/metrics.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createObservableValueGauges = exports.instrumentedWithMetrics = exports.getObservableGauge = exports.getObservableUpDownCounter = exports.getObservableCounter = exports.getUpDownCounter = exports.getCounter = exports.getHistogram = void 0;
-const api_1 = require("@opentelemetry/api");
+import { ValueType, } from '@opentelemetry/api';
 const histogramCache = new WeakMap();
 const counterCache = new WeakMap();
 const upDownCounterCache = new WeakMap();
@@ -21,35 +18,29 @@ function getCachedMetric(cache, meter, name, create) {
     }
     return metric;
 }
-function getHistogram(meter, name, options) {
+export function getHistogram(meter, name, options) {
     return getCachedMetric(histogramCache, meter, name, () => meter.createHistogram(name, options));
 }
-exports.getHistogram = getHistogram;
-function getCounter(meter, name, options) {
+export function getCounter(meter, name, options) {
     return getCachedMetric(counterCache, meter, name, () => meter.createCounter(name, options));
 }
-exports.getCounter = getCounter;
-function getUpDownCounter(meter, name, options) {
+export function getUpDownCounter(meter, name, options) {
     return getCachedMetric(upDownCounterCache, meter, name, () => meter.createUpDownCounter(name, options));
 }
-exports.getUpDownCounter = getUpDownCounter;
-function getObservableCounter(meter, name, options) {
+export function getObservableCounter(meter, name, options) {
     return getCachedMetric(observableCounterCache, meter, name, () => meter.createObservableCounter(name, options));
 }
-exports.getObservableCounter = getObservableCounter;
-function getObservableUpDownCounter(meter, name, options) {
+export function getObservableUpDownCounter(meter, name, options) {
     return getCachedMetric(observableUpDownCounterCache, meter, name, () => meter.createObservableUpDownCounter(name, options));
 }
-exports.getObservableUpDownCounter = getObservableUpDownCounter;
-function getObservableGauge(meter, name, options) {
+export function getObservableGauge(meter, name, options) {
     return getCachedMetric(observableGaugeCache, meter, name, () => meter.createObservableGauge(name, options));
 }
-exports.getObservableGauge = getObservableGauge;
-async function instrumentedWithMetrics(meter, name, fn) {
-    const error = getCounter(meter, `${name}.error`, { valueType: api_1.ValueType.INT });
+export async function instrumentedWithMetrics(meter, name, fn) {
+    const error = getCounter(meter, `${name}.error`, { valueType: ValueType.INT });
     const histogram = getHistogram(meter, `${name}.duration`, {
         unit: 'milliseconds',
-        valueType: api_1.ValueType.DOUBLE,
+        valueType: ValueType.DOUBLE,
     });
     const start = performance.now();
     try {
@@ -63,7 +54,6 @@ async function instrumentedWithMetrics(meter, name, fn) {
         histogram.record(performance.now() - start);
     }
 }
-exports.instrumentedWithMetrics = instrumentedWithMetrics;
 /**
  * Creates a set of gauges that track the min, max, and average of a value over
  * time. The value is observed on a regular interval.
@@ -75,7 +65,7 @@ exports.instrumentedWithMetrics = instrumentedWithMetrics;
  * - `${name}.max`
  * - `${name}.avg`
  */
-function createObservableValueGauges(meter, name, options, observe) {
+export function createObservableValueGauges(meter, name, options, observe) {
     const { interval, ...metricOptions } = options;
     let min = 0;
     let max = 0;
@@ -99,7 +89,7 @@ function createObservableValueGauges(meter, name, options, observe) {
     const averageGauge = getObservableGauge(meter, `${name}.avg`, {
         ...metricOptions,
         // Average is always a double, even if the observed value is an int.
-        valueType: api_1.ValueType.DOUBLE,
+        valueType: ValueType.DOUBLE,
     });
     minGauge.addCallback((observableResult) => {
         observableResult.observe(min);
@@ -117,5 +107,4 @@ function createObservableValueGauges(meter, name, options, observe) {
     });
     return { minGauge, maxGauge, averageGauge, stop: () => clearInterval(intervalId) };
 }
-exports.createObservableValueGauges = createObservableValueGauges;
 //# sourceMappingURL=metrics.js.map