@prairielearn/opentelemetry 1.0.1 → 1.3.0

package/.turbo/turbo-build.log

@@ -1,3 +1,3 @@
-@prairielearn/opentelemetry:build: cache hit, replaying output 97ac9cdfa1cb193f
+@prairielearn/opentelemetry:build: cache hit, replaying output e17abcb154da23a6
 @prairielearn/opentelemetry:build: warning package.json: No license field
 @prairielearn/opentelemetry:build: $ tsc

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @prairielearn/opentelemetry
 
+## 1.3.0
+
+### Minor Changes
+
+- 24a37b4b7: Bump OpenTelemetry dependencies to their latest versions
+
+## 1.2.0
+
+### Minor Changes
+
+- 2ef7a73e8: Add `instrumented()` helper to instrument function calls
+
+## 1.1.0
+
+### Minor Changes
+
+- ff23653ef: Don't handle `SIGTERM`; expose `shutdown()` function
+
 ## 1.0.1
 
 ### Patch Changes

package/README.md

@@ -23,13 +23,28 @@ await init({
 
 This will automatically instrument a variety of commonly-used Node packages.
 
-To manually instrument code, you can use the `trace` export:
+To easily instrument individual pieces of functionality, you can use the `instrumented()` helper function:
 
 ```ts
-import { trace } from '@prairielearn/opentelemetry';
+import { instrumented } from '@prairielearn/opentelemetry';
+
+async function doThing() {
+  return instrumented('span.name', async (span) => {
+    span.setAttribute('attribute.name', 'value');
+    await doThing();
+  });
+}
+```
+
+This will automatically set the span status and record any exceptions that occur.
+
+If you have a more complex use case, you can manually instrument code with the `trace` export:
+
+```ts
+import { trace, SpanStatusCode } from '@prairielearn/opentelemetry';
 
-const tracer = trace.getTracer('lib-name');
-await tracer.startActiveSpan('span-name', async (span) => {
+const tracer = trace.getTracer('default');
+await tracer.startActiveSpan('span.name', async (span) => {
   try {
     await doWork();
     span.setStatus({ status: SpanStatusCode.OK });

package/dist/index.d.ts

@@ -1,8 +1,11 @@
+import { SpanExporter } from '@opentelemetry/sdk-trace-base';
+import { Span } from '@opentelemetry/api';
 export interface OpenTelemetryConfig {
     openTelemetryEnabled: boolean;
-    openTelemetryExporter?: 'console' | 'honeycomb';
-    openTelemetrySamplerType?: 'always-on' | 'always-off' | 'trace-id-ratio';
+    openTelemetryExporter: 'console' | 'honeycomb' | SpanExporter;
+    openTelemetrySamplerType: 'always-on' | 'always-off' | 'trace-id-ratio';
     openTelemetrySampleRate?: number;
+    openTelemetrySpanProcessor?: 'batch' | 'simple';
     honeycombApiKey?: string;
     honeycombDataset?: string;
     serviceName?: string;
@@ -13,5 +16,11 @@ export interface OpenTelemetryConfig {
  * information available until we've loaded our config.
  */
 export declare function init(config: OpenTelemetryConfig): Promise<void>;
+/**
+ * Gracefully shuts down the OpenTelemetry instrumentation. Should be called
+ * when a `SIGTERM` signal is handled.
+ */
+export declare function shutdown(): Promise<void>;
+export declare function instrumented<T>(name: string, fn: (span: Span) => Promise<T> | T): Promise<T>;
 export { trace, context, SpanStatusCode } from '@opentelemetry/api';
 export { suppressTracing } from '@opentelemetry/core';

package/dist/index.js

@@ -1,18 +1,16 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.suppressTracing = exports.SpanStatusCode = exports.context = exports.trace = exports.init = void 0;
-const process_1 = __importDefault(require("process"));
+exports.suppressTracing = exports.SpanStatusCode = exports.context = exports.trace = exports.instrumented = exports.shutdown = exports.init = void 0;
 const grpc_js_1 = require("@grpc/grpc-js");
 const sdk_node_1 = require("@opentelemetry/sdk-node");
 const sdk_trace_node_1 = require("@opentelemetry/sdk-trace-node");
+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 exporter_otlp_grpc_1 = require("@opentelemetry/exporter-otlp-grpc");
 const instrumentation_express_1 = require("@opentelemetry/instrumentation-express");
-const sdk_trace_base_1 = require("@opentelemetry/sdk-trace-base");
+const sdk_trace_base_2 = require("@opentelemetry/sdk-trace-base");
+const api_1 = require("@opentelemetry/api");
 const core_1 = require("@opentelemetry/core");
 // Instrumentations go here.
 const instrumentation_aws_sdk_1 = require("@opentelemetry/instrumentation-aws-sdk");
@@ -30,7 +28,7 @@ const resources_2 = require("@opentelemetry/resources");
  * before they're queued up to send. This enhances our samping process so
  * that we can filter spans _after_ they've been emitted.
  */
-class FilterBatchSpanProcessor extends sdk_trace_base_1.BatchSpanProcessor {
+class FilterBatchSpanProcessor extends sdk_trace_base_2.BatchSpanProcessor {
     constructor(exporter, filter) {
         super(exporter);
         this.filter = filter;
@@ -97,6 +95,7 @@ const instrumentations = [
 instrumentations.forEach((i) => {
     i.enable();
 });
+let tracerProvider;
 /**
  * Should be called once we've loaded our config; this will allow us to set up
  * the correct metadata for the Honeycomb exporter. We don't actually have that
@@ -114,30 +113,35 @@ async function init(config) {
         return;
     }
     let exporter;
-    switch (config.openTelemetryExporter) {
-        case 'console': {
-            // Export spans to the console for testing purposes.
-            exporter = new sdk_node_1.tracing.ConsoleSpanExporter();
-            break;
-        }
-        case 'honeycomb': {
-            // Create a Honeycomb exporter with the appropriate metadata from the
-            // config we've been provided with.
-            const metadata = new grpc_js_1.Metadata();
-            metadata.set('x-honeycomb-team', config.honeycombApiKey);
-            metadata.set('x-honeycomb-dataset', config.honeycombDataset);
-            exporter = new exporter_otlp_grpc_1.OTLPTraceExporter({
-                url: 'grpc://api.honeycomb.io:443/',
-                credentials: grpc_js_1.credentials.createSsl(),
-                metadata,
-            });
-            break;
+    if (typeof config.openTelemetryExporter === 'object') {
+        exporter = config.openTelemetryExporter;
+    }
+    else {
+        switch (config.openTelemetryExporter) {
+            case 'console': {
+                // Export spans to the console for testing purposes.
+                exporter = new sdk_node_1.tracing.ConsoleSpanExporter();
+                break;
+            }
+            case 'honeycomb': {
+                // Create a Honeycomb exporter with the appropriate metadata from the
+                // config we've been provided with.
+                const metadata = new grpc_js_1.Metadata();
+                metadata.set('x-honeycomb-team', config.honeycombApiKey);
+                metadata.set('x-honeycomb-dataset', config.honeycombDataset);
+                exporter = new exporter_otlp_grpc_1.OTLPTraceExporter({
+                    url: 'grpc://api.honeycomb.io:443/',
+                    credentials: grpc_js_1.credentials.createSsl(),
+                    metadata,
+                });
+                break;
+            }
+            default:
+                throw new Error(`Unknown OpenTelemetry exporter: ${config.openTelemetryExporter}`);
         }
-        default:
-            throw new Error(`Unknown OpenTelemetry exporter: ${config.openTelemetryExporter}`);
     }
     let sampler;
-    switch (config.openTelemetrySamplerType) {
+    switch (config.openTelemetrySamplerType ?? 'always-on') {
         case 'always-on': {
             sampler = new core_1.AlwaysOnSampler();
             break;
@@ -155,6 +159,20 @@ async function init(config) {
         default:
             throw new Error(`Unknown OpenTelemetry sampler type: ${config.openTelemetrySamplerType}`);
     }
+    let spanProcessor;
+    switch (config.openTelemetrySpanProcessor ?? 'batch') {
+        case 'batch': {
+            spanProcessor = new FilterBatchSpanProcessor(exporter, filter);
+            break;
+        }
+        case 'simple': {
+            spanProcessor = new sdk_trace_base_1.SimpleSpanProcessor(exporter);
+            break;
+        }
+        default: {
+            throw new Error(`Unknown OpenTelemetry span processor: ${config.openTelemetrySpanProcessor}`);
+        }
+    }
     // Much of this functionality is copied from `@opentelemetry/sdk-node`, but
     // we can't use the SDK directly because of the fact that we load our config
     // asynchronously. We need to initialize our instrumentations first; only
@@ -166,24 +184,53 @@ async function init(config) {
     if (config.serviceName) {
         resource = resource.merge(new resources_1.Resource({ [semantic_conventions_1.SemanticResourceAttributes.SERVICE_NAME]: config.serviceName }));
     }
-    const tracerProvider = new sdk_trace_node_1.NodeTracerProvider({
+    tracerProvider = new sdk_trace_node_1.NodeTracerProvider({
         sampler,
         resource,
     });
-    const spanProcessor = new FilterBatchSpanProcessor(exporter, filter);
     tracerProvider.addSpanProcessor(spanProcessor);
     tracerProvider.register();
     instrumentations.forEach((i) => i.setTracerProvider(tracerProvider));
-    // When the process starts shutting down, terminate OTEL stuff.
-    process_1.default.on('SIGTERM', () => {
-        tracerProvider.shutdown().catch((error) => console.error('Error terminating tracing', error));
-    });
 }
 exports.init = init;
-var api_1 = require("@opentelemetry/api");
-Object.defineProperty(exports, "trace", { enumerable: true, get: function () { return api_1.trace; } });
-Object.defineProperty(exports, "context", { enumerable: true, get: function () { return api_1.context; } });
-Object.defineProperty(exports, "SpanStatusCode", { enumerable: true, get: function () { return api_1.SpanStatusCode; } });
+/**
+ * Gracefully shuts down the OpenTelemetry instrumentation. Should be called
+ * when a `SIGTERM` signal is handled.
+ */
+async function shutdown() {
+    if (tracerProvider) {
+        await tracerProvider.shutdown();
+        tracerProvider = null;
+    }
+}
+exports.shutdown = shutdown;
+async function instrumented(name, fn) {
+    return api_1.trace
+        .getTracer('default')
+        .startActiveSpan(name, async (span) => {
+        try {
+            const result = await fn(span);
+            span.setStatus({ code: api_1.SpanStatusCode.OK });
+            return result;
+        }
+        catch (e) {
+            span.setStatus({
+                code: api_1.SpanStatusCode.ERROR,
+                message: e.message,
+            });
+            span.recordException(e);
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    });
+}
+exports.instrumented = instrumented;
+var api_2 = require("@opentelemetry/api");
+Object.defineProperty(exports, "trace", { enumerable: true, get: function () { return api_2.trace; } });
+Object.defineProperty(exports, "context", { enumerable: true, get: function () { return api_2.context; } });
+Object.defineProperty(exports, "SpanStatusCode", { enumerable: true, get: function () { return api_2.SpanStatusCode; } });
 var core_2 = require("@opentelemetry/core");
 Object.defineProperty(exports, "suppressTracing", { enumerable: true, get: function () { return core_2.suppressTracing; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA8B;AAC9B,2CAAsD;AAEtD,sDAAkD;AAClD,kEAAmE;AAEnE,wDAAqE;AACrE,8EAAiF;AACjF,0EAAsE;AACtE,oFAA0E;AAC1E,kEAAmE;AAEnE,8CAM6B;AAE7B,4BAA4B;AAC5B,oFAA4E;AAC5E,oFAAgF;AAChF,4EAAwE;AACxE,oFAAgF;AAChF,8EAA0E;AAC1E,0EAAsE;AACtE,gFAA4E;AAE5E,8BAA8B;AAC9B,gFAAsE;AACtE,wDAAwE;AAExE;;;;GAIG;AACH,MAAM,wBAAyB,SAAQ,mCAAkB;IAGvD,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;QACnC,6EAA6E;QAC7E,2EAA2E;QAC3E,mEAAmE;QACnE,4EAA4E;QAC5E,mEAAmE;QACnE,8CAA8C;QAC9C,OAAO,IAAA,2BAAoB,EAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;KAChD;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,sEAAsE;QACtE,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;AAYH;;;;GAIG;AACI,KAAK,UAAU,IAAI,CAAC,MAA2B;IACpD,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE;QAChC,2EAA2E;QAC3E,yEAAyE;QACzE,wEAAwE;QACxE,qEAAqE;QACrE,0EAA0E;QAC1E,+CAA+C;QAC/C,sEAAsE;QACtE,OAAO;KACR;IAED,IAAI,QAAsB,CAAC;IAC3B,QAAQ,MAAM,CAAC,qBAAqB,EAAE;QACpC,KAAK,SAAS,CAAC,CAAC;YACd,oDAAoD;YACpD,QAAQ,GAAG,IAAI,kBAAO,CAAC,mBAAmB,EAAE,CAAC;YAC7C,MAAM;SACP;QACD,KAAK,WAAW,CAAC,CAAC;YAChB,qEAAqE;YACrE,mCAAmC;YACnC,MAAM,QAAQ,GAAG,IAAI,kBAAQ,EAAE,CAAC;YAEhC,QAAQ,CAAC,GAAG,CAAC,kBAAkB,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;YACzD,QAAQ,CAAC,GAAG,CAAC,qBAAqB,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC;YAE7D,QAAQ,GAAG,IAAI,sCAAiB,CAAC;gBAC/B,GAAG,EAAE,8BAA8B;gBACnC,WAAW,EAAE,qBAAW,CAAC,SAAS,EAAE;gBACpC,QAAQ;aACT,CAAC,CAAC;YACH,MAAM;SACP;QACD;YACE,MAAM,IAAI,KAAK,CAAC,mCAAmC,MAAM,CAAC,qBAAqB,EAAE,CAAC,CAAC;KACtF;IAED,IAAI,OAAgB,CAAC;IACrB,QAAQ,MAAM,CAAC,wBAAwB,EAAE;QACvC,KAAK,WAAW,CAAC,CAAC;YAChB,OAAO,GAAG,IAAI,sBAAe,EAAE,CAAC;YAChC,MAAM;SACP;QACD,KAAK,YAAY,CAAC,CAAC;YACjB,OAAO,GAAG,IAAI,uBAAgB,EAAE,CAAC;YACjC,MAAM;SACP;QACD,KAAK,gBAAgB,CAAC,CAAC;YACrB,OAAO,GAAG,IAAI,yBAAkB,CAAC;gBAC/B,IAAI,EAAE,IAAI,+BAAwB,CAAC,MAAM,CAAC,uBAAuB,CAAC;aACnE,CAAC,CAAC;YACH,MAAM;SACP;QACD;YACE,MAAM,IAAI,KAAK,CAAC,uCAAuC,MAAM,CAAC,wBAAwB,EAAE,CAAC,CAAC;KAC7F;IAED,2EAA2E;IAC3E,4EAA4E;IAC5E,yEAAyE;IACzE,6EAA6E;IAC7E,0DAA0D;IAE1D,IAAI,QAAQ,GAAG,MAAM,IAAA,2BAAe,EAAC;QACnC,SAAS,EAAE,CAAC,sCAAc,EAAE,2BAAe,EAAE,uBAAW,CAAC;KAC1D,CAAC,CAAC;IAEH,IAAI,MAAM,CAAC,WAAW,EAAE;QACtB,QAAQ,GAAG,QAAQ,CAAC,KAAK,CACvB,IAAI,oBAAQ,CAAC,EAAE,CAAC,iDAA0B,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC,CAChF,CAAC;KACH;IAED,MAAM,cAAc,GAAG,IAAI,mCAAkB,CAAC;QAC5C,OAAO;QACP,QAAQ;KACT,CAAC,CAAC;IACH,MAAM,aAAa,GAAG,IAAI,wBAAwB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACrE,cAAc,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC/C,cAAc,CAAC,QAAQ,EAAE,CAAC;IAE1B,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC,CAAC;IAErE,+DAA+D;IAC/D,iBAAO,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;QACzB,cAAc,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,2BAA2B,EAAE,KAAK,CAAC,CAAC,CAAC;IAChG,CAAC,CAAC,CAAC;AACL,CAAC;AAxFD,oBAwFC;AAED,0CAAoE;AAA3D,4FAAA,KAAK,OAAA;AAAE,8FAAA,OAAO,OAAA;AAAE,qGAAA,cAAc,OAAA;AACvC,4CAAsD;AAA7C,uGAAA,eAAe,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,2CAAsD;AAEtD,sDAAkD;AAClD,kEAAmE;AACnE,kEAKuC;AACvC,wDAAqE;AACrE,8EAAiF;AACjF,0EAAsE;AACtE,oFAA0E;AAC1E,kEAAmE;AACnE,4CAAmF;AACnF,8CAM6B;AAE7B,4BAA4B;AAC5B,oFAA4E;AAC5E,oFAAgF;AAChF,4EAAwE;AACxE,oFAAgF;AAChF,8EAA0E;AAC1E,0EAAsE;AACtE,gFAA4E;AAE5E,8BAA8B;AAC9B,gFAAsE;AACtE,wDAAwE;AAGxE;;;;GAIG;AACH,MAAM,wBAAyB,SAAQ,mCAAkB;IAGvD,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;QACnC,6EAA6E;QAC7E,2EAA2E;QAC3E,mEAAmE;QACnE,4EAA4E;QAC5E,mEAAmE;QACnE,8CAA8C;QAC9C,OAAO,IAAA,2BAAoB,EAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;KAChD;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,sEAAsE;QACtE,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,cAAkC,CAAC;AAavC;;;;GAIG;AACI,KAAK,UAAU,IAAI,CAAC,MAA2B;IACpD,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE;QAChC,2EAA2E;QAC3E,yEAAyE;QACzE,wEAAwE;QACxE,qEAAqE;QACrE,0EAA0E;QAC1E,+CAA+C;QAC/C,sEAAsE;QACtE,OAAO;KACR;IAED,IAAI,QAAsB,CAAC;IAC3B,IAAI,OAAO,MAAM,CAAC,qBAAqB,KAAK,QAAQ,EAAE;QACpD,QAAQ,GAAG,MAAM,CAAC,qBAAqB,CAAC;KACzC;SAAM;QACL,QAAQ,MAAM,CAAC,qBAAqB,EAAE;YACpC,KAAK,SAAS,CAAC,CAAC;gBACd,oDAAoD;gBACpD,QAAQ,GAAG,IAAI,kBAAO,CAAC,mBAAmB,EAAE,CAAC;gBAC7C,MAAM;aACP;YACD,KAAK,WAAW,CAAC,CAAC;gBAChB,qEAAqE;gBACrE,mCAAmC;gBACnC,MAAM,QAAQ,GAAG,IAAI,kBAAQ,EAAE,CAAC;gBAEhC,QAAQ,CAAC,GAAG,CAAC,kBAAkB,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;gBACzD,QAAQ,CAAC,GAAG,CAAC,qBAAqB,EAAE,MAAM,CAAC,gBAAgB,CAAC,CAAC;gBAE7D,QAAQ,GAAG,IAAI,sCAAiB,CAAC;oBAC/B,GAAG,EAAE,8BAA8B;oBACnC,WAAW,EAAE,qBAAW,CAAC,SAAS,EAAE;oBACpC,QAAQ;iBACT,CAAC,CAAC;gBACH,MAAM;aACP;YACD;gBACE,MAAM,IAAI,KAAK,CAAC,mCAAmC,MAAM,CAAC,qBAAqB,EAAE,CAAC,CAAC;SACtF;KACF;IAED,IAAI,OAAgB,CAAC;IACrB,QAAQ,MAAM,CAAC,wBAAwB,IAAI,WAAW,EAAE;QACtD,KAAK,WAAW,CAAC,CAAC;YAChB,OAAO,GAAG,IAAI,sBAAe,EAAE,CAAC;YAChC,MAAM;SACP;QACD,KAAK,YAAY,CAAC,CAAC;YACjB,OAAO,GAAG,IAAI,uBAAgB,EAAE,CAAC;YACjC,MAAM;SACP;QACD,KAAK,gBAAgB,CAAC,CAAC;YACrB,OAAO,GAAG,IAAI,yBAAkB,CAAC;gBAC/B,IAAI,EAAE,IAAI,+BAAwB,CAAC,MAAM,CAAC,uBAAuB,CAAC;aACnE,CAAC,CAAC;YACH,MAAM;SACP;QACD;YACE,MAAM,IAAI,KAAK,CAAC,uCAAuC,MAAM,CAAC,wBAAwB,EAAE,CAAC,CAAC;KAC7F;IAED,IAAI,aAA4B,CAAC;IACjC,QAAQ,MAAM,CAAC,0BAA0B,IAAI,OAAO,EAAE;QACpD,KAAK,OAAO,CAAC,CAAC;YACZ,aAAa,GAAG,IAAI,wBAAwB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAC/D,MAAM;SACP;QACD,KAAK,QAAQ,CAAC,CAAC;YACb,aAAa,GAAG,IAAI,oCAAmB,CAAC,QAAQ,CAAC,CAAC;YAClD,MAAM;SACP;QACD,OAAO,CAAC,CAAC;YACP,MAAM,IAAI,KAAK,CAAC,yCAAyC,MAAM,CAAC,0BAA0B,EAAE,CAAC,CAAC;SAC/F;KACF;IAED,2EAA2E;IAC3E,4EAA4E;IAC5E,yEAAyE;IACzE,6EAA6E;IAC7E,0DAA0D;IAE1D,IAAI,QAAQ,GAAG,MAAM,IAAA,2BAAe,EAAC;QACnC,SAAS,EAAE,CAAC,sCAAc,EAAE,2BAAe,EAAE,uBAAW,CAAC;KAC1D,CAAC,CAAC;IAEH,IAAI,MAAM,CAAC,WAAW,EAAE;QACtB,QAAQ,GAAG,QAAQ,CAAC,KAAK,CACvB,IAAI,oBAAQ,CAAC,EAAE,CAAC,iDAA0B,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC,CAChF,CAAC;KACH;IAED,cAAc,GAAG,IAAI,mCAAkB,CAAC;QACtC,OAAO;QACP,QAAQ;KACT,CAAC,CAAC;IACH,cAAc,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC/C,cAAc,CAAC,QAAQ,EAAE,CAAC;IAE1B,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC,CAAC;AACvE,CAAC;AArGD,oBAqGC;AAED;;;GAGG;AACI,KAAK,UAAU,QAAQ;IAC5B,IAAI,cAAc,EAAE;QAClB,MAAM,cAAc,CAAC,QAAQ,EAAE,CAAC;QAChC,cAAc,GAAG,IAAI,CAAC;KACvB;AACH,CAAC;AALD,4BAKC;AAEM,KAAK,UAAU,YAAY,CAChC,IAAY,EACZ,EAAkC;IAElC,OAAO,WAAK;SACT,SAAS,CAAC,SAAS,CAAC;SACpB,eAAe,CAA6B,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QAChE,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,oBAAc,CAAC,EAAE,EAAE,CAAC,CAAC;YAC5C,OAAO,MAAM,CAAC;SACf;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,CAAC,SAAS,CAAC;gBACb,IAAI,EAAE,oBAAc,CAAC,KAAK;gBAC1B,OAAO,EAAE,CAAC,CAAC,OAAO;aACnB,CAAC,CAAC;YACH,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;YACxB,MAAM,CAAC,CAAC;SACT;gBAAS;YACR,IAAI,CAAC,GAAG,EAAE,CAAC;SACZ;IACH,CAAC,CAAC,CAAC;AACP,CAAC;AAtBD,oCAsBC;AAED,0CAAoE;AAA3D,4FAAA,KAAK,OAAA;AAAE,8FAAA,OAAO,OAAA;AAAE,qGAAA,cAAc,OAAA;AACvC,4CAAsD;AAA7C,uGAAA,eAAe,OAAA"}

package/dist/index.test.d.ts

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

package/dist/index.test.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const sdk_node_1 = require("@opentelemetry/sdk-node");
+const chai_1 = require("chai");
+const index_1 = require("./index");
+const context_async_hooks_1 = require("@opentelemetry/context-async-hooks");
+describe('instrumented', () => {
+    let contextManager;
+    let exporter = new sdk_node_1.tracing.InMemorySpanExporter();
+    before(async () => {
+        await (0, index_1.init)({
+            openTelemetryEnabled: true,
+            openTelemetryExporter: exporter,
+            openTelemetrySamplerType: 'always-on',
+            openTelemetrySpanProcessor: 'simple',
+        });
+    });
+    beforeEach(async () => {
+        contextManager = new context_async_hooks_1.AsyncHooksContextManager();
+        index_1.context.setGlobalContextManager(contextManager.enable());
+    });
+    afterEach(async () => {
+        exporter.reset();
+        index_1.context.disable();
+    });
+    it('returns the value from the function', async () => {
+        const res = await (0, index_1.instrumented)('test', () => 'foo');
+        chai_1.assert.equal(res, 'foo');
+    });
+    it('records a span on success', async () => {
+        await (0, index_1.instrumented)('test-success', () => 'foo');
+        const spans = exporter.getFinishedSpans();
+        chai_1.assert.lengthOf(spans, 1);
+        chai_1.assert.equal(spans[0].name, 'test-success');
+        chai_1.assert.equal(spans[0].status.code, index_1.SpanStatusCode.OK);
+    });
+    it('records a span on failure', async () => {
+        let maybeError = null;
+        await (0, index_1.instrumented)('test-failure', () => {
+            throw new Error('foo');
+        }).catch((err) => {
+            maybeError = err;
+        });
+        // Ensure the error was propagated back to the caller.
+        chai_1.assert.isOk(maybeError);
+        chai_1.assert.equal(maybeError.message, 'foo');
+        // Ensure the correct span was recorded.
+        const spans = exporter.getFinishedSpans();
+        chai_1.assert.lengthOf(spans, 1);
+        chai_1.assert.equal(spans[0].name, 'test-failure');
+        chai_1.assert.equal(spans[0].status.code, index_1.SpanStatusCode.ERROR);
+        chai_1.assert.equal(spans[0].status.message, 'foo');
+        chai_1.assert.equal(spans[0].events[0].name, 'exception');
+    });
+    it('sets up context correctly', async () => {
+        const tracer = index_1.trace.getTracer('default');
+        const parentSpan = tracer.startSpan('parentSpan');
+        const parentContext = index_1.trace.setSpan(index_1.context.active(), parentSpan);
+        await (0, index_1.instrumented)('test', async () => {
+            const childContext = index_1.context.active();
+            chai_1.assert.notStrictEqual(childContext, parentContext);
+        });
+    });
+});
+//# sourceMappingURL=index.test.js.map

package/dist/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":";;AAAA,sDAAkD;AAClD,+BAA8B;AAE9B,mCAAuF;AACvF,4EAA8E;AAE9E,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,IAAI,cAAwC,CAAC;IAC7C,IAAI,QAAQ,GAAG,IAAI,kBAAO,CAAC,oBAAoB,EAAE,CAAC;IAElD,MAAM,CAAC,KAAK,IAAI,EAAE;QAChB,MAAM,IAAA,YAAI,EAAC;YACT,oBAAoB,EAAE,IAAI;YAC1B,qBAAqB,EAAE,QAAQ;YAC/B,wBAAwB,EAAE,WAAW;YACrC,0BAA0B,EAAE,QAAQ;SACrC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,UAAU,CAAC,KAAK,IAAI,EAAE;QACpB,cAAc,GAAG,IAAI,8CAAwB,EAAE,CAAC;QAChD,eAAO,CAAC,uBAAuB,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,QAAQ,CAAC,KAAK,EAAE,CAAC;QACjB,eAAO,CAAC,OAAO,EAAE,CAAC;IACpB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;QACnD,MAAM,GAAG,GAAG,MAAM,IAAA,oBAAY,EAAC,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;QACpD,aAAM,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,IAAA,oBAAY,EAAC,cAAc,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;QAEhD,MAAM,KAAK,GAAG,QAAQ,CAAC,gBAAgB,EAAE,CAAC;QAC1C,aAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC1B,aAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QAC5C,aAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,sBAAc,CAAC,EAAE,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QACzC,IAAI,UAAU,GAAG,IAAI,CAAC;QACtB,MAAM,IAAA,oBAAY,EAAC,cAAc,EAAE,GAAG,EAAE;YACtC,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YACf,UAAU,GAAG,GAAG,CAAC;QACnB,CAAC,CAAC,CAAC;QAEH,sDAAsD;QACtD,aAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxB,aAAM,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAExC,wCAAwC;QACxC,MAAM,KAAK,GAAG,QAAQ,CAAC,gBAAgB,EAAE,CAAC;QAC1C,aAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC1B,aAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QAC5C,aAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,sBAAc,CAAC,KAAK,CAAC,CAAC;QACzD,aAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC7C,aAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,MAAM,GAAG,aAAK,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC1C,MAAM,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QAClD,MAAM,aAAa,GAAG,aAAK,CAAC,OAAO,CAAC,eAAO,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC;QAElE,MAAM,IAAA,oBAAY,EAAC,MAAM,EAAE,KAAK,IAAI,EAAE;YACpC,MAAM,YAAY,GAAG,eAAO,CAAC,MAAM,EAAE,CAAC;YACtC,aAAM,CAAC,cAAc,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,31 +1,35 @@
 {
   "name": "@prairielearn/opentelemetry",
-  "version": "1.0.1",
+  "version": "1.3.0",
   "main": "dist/index.js",
   "scripts": {
     "build": "tsc",
-    "dev": "tsc --watch --preserveWatchOutput"
+    "dev": "tsc --watch --preserveWatchOutput",
+    "test": "mocha --no-config --require ts-node/register src/index.test.ts"
   },
   "dependencies": {
-    "@grpc/grpc-js": "^1.5.5",
-    "@opentelemetry/api": "^1.0.4",
-    "@opentelemetry/core": "^1.0.1",
+    "@grpc/grpc-js": "^1.6.7",
+    "@opentelemetry/api": "^1.1.0",
+    "@opentelemetry/core": "^1.3.1",
     "@opentelemetry/exporter-otlp-grpc": "^0.26.0",
-    "@opentelemetry/instrumentation-aws-sdk": "^0.5.0",
-    "@opentelemetry/instrumentation-connect": "^0.27.1",
-    "@opentelemetry/instrumentation-dns": "^0.27.1",
-    "@opentelemetry/instrumentation-express": "^0.28.0",
-    "@opentelemetry/instrumentation-http": "^0.27.0",
-    "@opentelemetry/instrumentation-pg": "^0.28.0",
-    "@opentelemetry/instrumentation-redis": "^0.28.0",
-    "@opentelemetry/resource-detector-aws": "^1.0.3",
-    "@opentelemetry/resources": "^1.0.1",
-    "@opentelemetry/sdk-node": "^0.27.0",
-    "@opentelemetry/sdk-trace-base": "^1.0.1",
-    "@opentelemetry/sdk-trace-node": "^1.0.1",
-    "@opentelemetry/semantic-conventions": "^1.0.1"
+    "@opentelemetry/instrumentation-aws-sdk": "^0.7.0",
+    "@opentelemetry/instrumentation-connect": "^0.28.0",
+    "@opentelemetry/instrumentation-dns": "^0.28.0",
+    "@opentelemetry/instrumentation-express": "^0.29.0",
+    "@opentelemetry/instrumentation-http": "^0.29.2",
+    "@opentelemetry/instrumentation-pg": "^0.29.0",
+    "@opentelemetry/instrumentation-redis": "^0.31.0",
+    "@opentelemetry/resource-detector-aws": "^1.1.0",
+    "@opentelemetry/resources": "^1.3.1",
+    "@opentelemetry/sdk-node": "^0.29.2",
+    "@opentelemetry/sdk-trace-base": "^1.3.1",
+    "@opentelemetry/sdk-trace-node": "^1.3.1",
+    "@opentelemetry/semantic-conventions": "^1.3.1"
   },
   "devDependencies": {
-    "typescript": "^4.5.5"
+    "@prairielearn/tsconfig": "*",
+    "mocha": "^10.0.0",
+    "ts-node": "^10.8.0",
+    "typescript": "^4.7.2"
   }
 }

package/src/index.test.ts

@@ -0,0 +1,75 @@
+import { tracing } from '@opentelemetry/sdk-node';
+import { assert } from 'chai';
+
+import { context, init, instrumented, shutdown, trace, SpanStatusCode } from './index';
+import { AsyncHooksContextManager } from '@opentelemetry/context-async-hooks';
+
+describe('instrumented', () => {
+  let contextManager: AsyncHooksContextManager;
+  let exporter = new tracing.InMemorySpanExporter();
+
+  before(async () => {
+    await init({
+      openTelemetryEnabled: true,
+      openTelemetryExporter: exporter,
+      openTelemetrySamplerType: 'always-on',
+      openTelemetrySpanProcessor: 'simple',
+    });
+  });
+
+  beforeEach(async () => {
+    contextManager = new AsyncHooksContextManager();
+    context.setGlobalContextManager(contextManager.enable());
+  });
+
+  afterEach(async () => {
+    exporter.reset();
+    context.disable();
+  });
+
+  it('returns the value from the function', async () => {
+    const res = await instrumented('test', () => 'foo');
+    assert.equal(res, 'foo');
+  });
+
+  it('records a span on success', async () => {
+    await instrumented('test-success', () => 'foo');
+
+    const spans = exporter.getFinishedSpans();
+    assert.lengthOf(spans, 1);
+    assert.equal(spans[0].name, 'test-success');
+    assert.equal(spans[0].status.code, SpanStatusCode.OK);
+  });
+
+  it('records a span on failure', async () => {
+    let maybeError = null;
+    await instrumented('test-failure', () => {
+      throw new Error('foo');
+    }).catch((err) => {
+      maybeError = err;
+    });
+
+    // Ensure the error was propagated back to the caller.
+    assert.isOk(maybeError);
+    assert.equal(maybeError.message, 'foo');
+
+    // Ensure the correct span was recorded.
+    const spans = exporter.getFinishedSpans();
+    assert.lengthOf(spans, 1);
+    assert.equal(spans[0].name, 'test-failure');
+    assert.equal(spans[0].status.code, SpanStatusCode.ERROR);
+    assert.equal(spans[0].status.message, 'foo');
+    assert.equal(spans[0].events[0].name, 'exception');
+  });
+
+  it('sets up context correctly', async () => {
+    const tracer = trace.getTracer('default');
+    const parentSpan = tracer.startSpan('parentSpan');
+    const parentContext = trace.setSpan(context.active(), parentSpan);
+
+    await instrumented('test', async () => {
+      const childContext = context.active();
+      assert.notStrictEqual(childContext, parentContext);
+    });
+  });
+});

package/src/index.ts

@@ -1,15 +1,19 @@
-import process from 'process';
 import { Metadata, credentials } from '@grpc/grpc-js';
 
 import { tracing } from '@opentelemetry/sdk-node';
 import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
-import type { SpanExporter, ReadableSpan } from '@opentelemetry/sdk-trace-base';
+import {
+  SpanExporter,
+  ReadableSpan,
+  SpanProcessor,
+  SimpleSpanProcessor,
+} from '@opentelemetry/sdk-trace-base';
 import { detectResources, Resource } from '@opentelemetry/resources';
 import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';
 import { OTLPTraceExporter } from '@opentelemetry/exporter-otlp-grpc';
 import { ExpressLayerType } from '@opentelemetry/instrumentation-express';
 import { BatchSpanProcessor } from '@opentelemetry/sdk-trace-base';
-import { Sampler } from '@opentelemetry/api';
+import { Sampler, Span, SpanStatusCode, context, trace } from '@opentelemetry/api';
 import {
   ParentBasedSampler,
   TraceIdRatioBasedSampler,
@@ -30,6 +34,7 @@ import { RedisInstrumentation } from '@opentelemetry/instrumentation-redis';
 // Resource detectors go here.
 import { awsEc2Detector } from '@opentelemetry/resource-detector-aws';
 import { processDetector, envDetector } from '@opentelemetry/resources';
+import { createBaggage } from '@opentelemetry/api/build/src/baggage/utils';
 
 /**
  * Extends `BatchSpanProcessor` to give it the ability to filter out spans
@@ -111,11 +116,14 @@ instrumentations.forEach((i) => {
   i.enable();
 });
 
+let tracerProvider: NodeTracerProvider;
+
 export interface OpenTelemetryConfig {
   openTelemetryEnabled: boolean;
-  openTelemetryExporter?: 'console' | 'honeycomb';
-  openTelemetrySamplerType?: 'always-on' | 'always-off' | 'trace-id-ratio';
+  openTelemetryExporter: 'console' | 'honeycomb' | SpanExporter;
+  openTelemetrySamplerType: 'always-on' | 'always-off' | 'trace-id-ratio';
   openTelemetrySampleRate?: number;
+  openTelemetrySpanProcessor?: 'batch' | 'simple';
   honeycombApiKey?: string;
   honeycombDataset?: string;
   serviceName?: string;
@@ -139,33 +147,37 @@ export async function init(config: OpenTelemetryConfig) {
   }
 
   let exporter: SpanExporter;
-  switch (config.openTelemetryExporter) {
-    case 'console': {
-      // Export spans to the console for testing purposes.
-      exporter = new tracing.ConsoleSpanExporter();
-      break;
-    }
-    case 'honeycomb': {
-      // Create a Honeycomb exporter with the appropriate metadata from the
-      // config we've been provided with.
-      const metadata = new Metadata();
-
-      metadata.set('x-honeycomb-team', config.honeycombApiKey);
-      metadata.set('x-honeycomb-dataset', config.honeycombDataset);
-
-      exporter = new OTLPTraceExporter({
-        url: 'grpc://api.honeycomb.io:443/',
-        credentials: credentials.createSsl(),
-        metadata,
-      });
-      break;
+  if (typeof config.openTelemetryExporter === 'object') {
+    exporter = config.openTelemetryExporter;
+  } else {
+    switch (config.openTelemetryExporter) {
+      case 'console': {
+        // Export spans to the console for testing purposes.
+        exporter = new tracing.ConsoleSpanExporter();
+        break;
+      }
+      case 'honeycomb': {
+        // Create a Honeycomb exporter with the appropriate metadata from the
+        // config we've been provided with.
+        const metadata = new Metadata();
+
+        metadata.set('x-honeycomb-team', config.honeycombApiKey);
+        metadata.set('x-honeycomb-dataset', config.honeycombDataset);
+
+        exporter = new OTLPTraceExporter({
+          url: 'grpc://api.honeycomb.io:443/',
+          credentials: credentials.createSsl(),
+          metadata,
+        });
+        break;
+      }
+      default:
+        throw new Error(`Unknown OpenTelemetry exporter: ${config.openTelemetryExporter}`);
     }
-    default:
-      throw new Error(`Unknown OpenTelemetry exporter: ${config.openTelemetryExporter}`);
   }
 
   let sampler: Sampler;
-  switch (config.openTelemetrySamplerType) {
+  switch (config.openTelemetrySamplerType ?? 'always-on') {
     case 'always-on': {
       sampler = new AlwaysOnSampler();
       break;
@@ -184,6 +196,21 @@ export async function init(config: OpenTelemetryConfig) {
       throw new Error(`Unknown OpenTelemetry sampler type: ${config.openTelemetrySamplerType}`);
   }
 
+  let spanProcessor: SpanProcessor;
+  switch (config.openTelemetrySpanProcessor ?? 'batch') {
+    case 'batch': {
+      spanProcessor = new FilterBatchSpanProcessor(exporter, filter);
+      break;
+    }
+    case 'simple': {
+      spanProcessor = new SimpleSpanProcessor(exporter);
+      break;
+    }
+    default: {
+      throw new Error(`Unknown OpenTelemetry span processor: ${config.openTelemetrySpanProcessor}`);
+    }
+  }
+
   // Much of this functionality is copied from `@opentelemetry/sdk-node`, but
   // we can't use the SDK directly because of the fact that we load our config
   // asynchronously. We need to initialize our instrumentations first; only
@@ -200,20 +227,49 @@ export async function init(config: OpenTelemetryConfig) {
     );
   }
 
-  const tracerProvider = new NodeTracerProvider({
+  tracerProvider = new NodeTracerProvider({
     sampler,
     resource,
   });
-  const spanProcessor = new FilterBatchSpanProcessor(exporter, filter);
   tracerProvider.addSpanProcessor(spanProcessor);
   tracerProvider.register();
 
   instrumentations.forEach((i) => i.setTracerProvider(tracerProvider));
+}
 
-  // When the process starts shutting down, terminate OTEL stuff.
-  process.on('SIGTERM', () => {
-    tracerProvider.shutdown().catch((error) => console.error('Error terminating tracing', error));
-  });
+/**
+ * Gracefully shuts down the OpenTelemetry instrumentation. Should be called
+ * when a `SIGTERM` signal is handled.
+ */
+export async function shutdown(): Promise<void> {
+  if (tracerProvider) {
+    await tracerProvider.shutdown();
+    tracerProvider = null;
+  }
+}
+
+export async function instrumented<T>(
+  name: string,
+  fn: (span: Span) => Promise<T> | T
+): Promise<T> {
+  return trace
+    .getTracer('default')
+    .startActiveSpan<(span: Span) => Promise<T>>(name, async (span) => {
+      try {
+        const result = await fn(span);
+        span.setStatus({ code: SpanStatusCode.OK });
+        return result;
+      } catch (e) {
+        span.setStatus({
+          code: SpanStatusCode.ERROR,
+          message: e.message,
+        });
+        span.recordException(e);
+        throw e;
+      } finally {
+        span.end();
+      }
+    });
 }
 
 export { trace, context, SpanStatusCode } from '@opentelemetry/api';

package/tsconfig.json

@@ -1,16 +1,7 @@
 {
+  "extends": "@prairielearn/tsconfig",
   "compilerOptions": {
-    "allowJs": true,
-    "declaration": true,
-    "esModuleInterop": true,
     "outDir": "./dist",
-    "rootDir": "src/",
-    "sourceMap": true,
-    // This package will only be used server-side on Node 14+, so target the
-    // newest version of the ES spec that Node 14 supports.
-    "target": "ES2020",
-    // However, we don't yet make extensive use of ES Modules, so specifically
-    // compile `import`/`export` down to CommonJS.
-    "module": "CommonJS",
+    "rootDir": "./src",
   }
 }