fix: Don't disable instrumentation if OpenTelemetry isn't enabled

PrairieLearn · Apr 13, 2022 · fb3d0be · fb3d0be
1 parent 0eabfdc
commit fb3d0be
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/.changeset/stale-actors-repeat.md b/.changeset/stale-actors-repeat.md
@@ -0,0 +1,5 @@
+---
+'@prairielearn/opentelemetry': patch
+---
+
+Don't disable instrumentation if OpenTelemetry isn't enabled
diff --git a/packages/opentelemetry/src/index.ts b/packages/opentelemetry/src/index.ts
@@ -128,8 +128,13 @@ export interface OpenTelemetryConfig {
  */
 export async function init(config: OpenTelemetryConfig) {
   if (!config.openTelemetryEnabled) {
-    // Just disable all of the OTEL instrumentations to avoid any unnecessary overhead.
-    instrumentations.forEach((i) => i.disable());
+    // If not enabled, do nothing. We used to disable the instrumentations, but
+    // per maintainers, that can actually be problematic. See the comments on
+    // https://github.com/open-telemetry/opentelemetry-js-contrib/issues/970
+    // The Express instrumentation also logs a benign error, which can be
+    // confusing to users. There's a fix in progress if we want to switch back
+    // to disabling instrumentations in the future:
+    // https://github.com/open-telemetry/opentelemetry-js-contrib/pull/972
     return;
   }