feat(opentelemetry): remove auto-setup from configuration

Author: EmrysMyrddin

.changeset/@graphql-hive_gateway-1171-dependencies.md

@@ -0,0 +1,17 @@
+---
+'@graphql-hive/gateway': patch
+---
+
+dependencies updates: 
+
+- Added dependency [`@opentelemetry/api@^1.9.0` ↗︎](https://www.npmjs.com/package/@opentelemetry/api/v/1.9.0) (to `dependencies`)
+- Added dependency [`@opentelemetry/auto-instrumentations-node@^0.59.0` ↗︎](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node/v/0.59.0) (to `dependencies`)
+- Added dependency [`@opentelemetry/context-zone@^2.0.1` ↗︎](https://www.npmjs.com/package/@opentelemetry/context-zone/v/2.0.1) (to `dependencies`)
+- Added dependency [`@opentelemetry/core@^2.0.0` ↗︎](https://www.npmjs.com/package/@opentelemetry/core/v/2.0.0) (to `dependencies`)
+- Added dependency [`@opentelemetry/exporter-jaeger@^2.0.1` ↗︎](https://www.npmjs.com/package/@opentelemetry/exporter-jaeger/v/2.0.1) (to `dependencies`)
+- Added dependency [`@opentelemetry/exporter-zipkin@^2.0.1` ↗︎](https://www.npmjs.com/package/@opentelemetry/exporter-zipkin/v/2.0.1) (to `dependencies`)
+- Added dependency [`@opentelemetry/propagator-b3@^2.0.1` ↗︎](https://www.npmjs.com/package/@opentelemetry/propagator-b3/v/2.0.1) (to `dependencies`)
+- Added dependency [`@opentelemetry/propagator-jaeger@^2.0.1` ↗︎](https://www.npmjs.com/package/@opentelemetry/propagator-jaeger/v/2.0.1) (to `dependencies`)
+- Added dependency [`@opentelemetry/sampler-jaeger-remote@^0.201.1` ↗︎](https://www.npmjs.com/package/@opentelemetry/sampler-jaeger-remote/v/0.201.1) (to `dependencies`)
+- Added dependency [`@opentelemetry/sdk-node@^0.201.1` ↗︎](https://www.npmjs.com/package/@opentelemetry/sdk-node/v/0.201.1) (to `dependencies`)
+- Added dependency [`@opentelemetry/sdk-trace-node@^2.0.1` ↗︎](https://www.npmjs.com/package/@opentelemetry/sdk-trace-node/v/2.0.1) (to `dependencies`)

.yarn/patches/@opentelemetry-exporter-trace-otlp-http-npm-0.202.0-8ec36b4f28.patch

@@ -0,0 +1,29 @@
+diff --git a/build/esnext/transport/http-exporter-transport.js b/build/esnext/transport/http-exporter-transport.js
+index 7977489487a2236fbd0e4c2273ef53fd3c7b93a8..93e9701d10f6aea530f38330daea87199e514452 100644
+--- a/build/esnext/transport/http-exporter-transport.js
++++ b/build/esnext/transport/http-exporter-transport.js
+@@ -20,7 +20,7 @@ class HttpExporterTransport {
+         this._parameters = _parameters;
+     }
+     async send(data, timeoutMillis) {
+-        const { agent, send } = this._loadUtils();
++        const { agent, send } = await this._loadUtils();
+         return new Promise(resolve => {
+             send(this._parameters, agent, data, result => {
+                 resolve(result);
+@@ -30,13 +30,11 @@ class HttpExporterTransport {
+     shutdown() {
+         // intentionally left empty, nothing to do.
+     }
+-    _loadUtils() {
++    async _loadUtils() {
+         let utils = this._utils;
+         if (utils === null) {
+             // Lazy require to ensure that http/https is not required before instrumentations can wrap it.
+-            const { sendWithHttp, createHttpAgent,
+-            // eslint-disable-next-line @typescript-eslint/no-var-requires
+-             } = require('./http-transport-utils');
++            const { sendWithHttp, createHttpAgent } = await import('./http-transport-utils');
+             utils = this._utils = {
+                 agent: createHttpAgent(this._parameters.url, this._parameters.agentOptions),
+                 send: sendWithHttp,

.yarn/patches/@opentelemetry-otlp-exporter-base-npm-0.202.0-f6f29c2eeb.patch

@@ -0,0 +1,48 @@
+diff --git a/dist/es/index.js b/dist/es/index.js
+index 505218ea7b14fb8773fe805b622f9071d5da59dd..263631008120b7bf2bd678220dca6394ed30c026 100644
+--- a/dist/es/index.js
++++ b/dist/es/index.js
+@@ -478,28 +478,10 @@ async function resolvePackageTarget(context, { target, patternMatch, isImports }
+     }
+     // Otherwise, if target is a non-null Object, then
+     if (target && typeof target === 'object') {
+-        // For each property of target
+-        for (const [key, value] of Object.entries(target)) {
+-            // If exports contains any index property keys, as defined in ECMA-262 6.1.7 Array Index, throw an Invalid Package Configuration error.
+-            // TODO: We do not check if the key is a number here...
+-            // If key equals "default" or conditions contains an entry for the key, then
+-            if (key === 'default' || context.conditions.includes(key)) {
+-                // Let targetValue be the value of the property in target.
+-                // Let resolved be the result of PACKAGE_TARGET_RESOLVE of the targetValue
+-                const resolved = await resolvePackageTarget(context, {
+-                    target: value,
+-                    patternMatch,
+-                    isImports
+-                });
+-                // If resolved is equal to undefined, continue the loop.
+-                // Return resolved.
+-                if (resolved !== undefined) {
+-                    return resolved;
+-                }
+-            }
+-        }
+-        // Return undefined.
+-        return undefined;
++        const key = context.conditions.find(condition => condition in target) ?? 'default';
++        return key in target
++          ? resolvePackageTarget(context, { target: target[key], patternMatch, isImports })
++          : undefined;
+     }
+     // Otherwise, if target is null, return null.
+     if (target === null) {
+@@ -1072,8 +1054,8 @@ function nodeResolve(opts = {}) {
+             ? 'development'
+             : 'production'
+         ];
+-  const conditionsEsm = [...baseConditionsEsm, ...exportConditions, ...devProdCondition];
+-  const conditionsCjs = [...baseConditionsCjs, ...exportConditions, ...devProdCondition];
++  const conditionsEsm = [...baseConditionsEsm, ...exportConditions, ...devProdCondition].reverse();
++  const conditionsCjs = [...baseConditionsCjs, ...exportConditions, ...devProdCondition].reverse();
+   const packageInfoCache = new Map();
+   const idToPackageInfo = new Map();
+   const mainFields = getMainFields(options);

.yarn/patches/@rollup-plugin-node-resolve-npm-16.0.1-2936474bab.patch

@@ -41,15 +41,18 @@ describe.skipIf(gatewayRunner !== 'node' || process.version.startsWith('v1'))(
     type JaegerTracesApiResponse = {
       data: Array<{
         traceID: string;
-        spans: Array<{
-          traceID: string;
-          spanID: string;
-          operationName: string;
-          tags: Array<{ key: string; value: string; type: string }>;
-        }>;
+        spans: JaegerTraceSpan[];
       }>;
     };
 
+    type JaegerTraceSpan = {
+      traceID: string;
+      spanID: string;
+      operationName: string;
+      tags: Array<{ key: string; value: string; type: string }>;
+      references: Array<{ refType: string; spanID: string; traceID: string }>;
+    };
+
     async function getJaegerTraces(
       service: string,
       expectedDataLength: number,

e2e/cloudflare-workers/cloudflare-workers.e2e.ts

@@ -4,10 +4,16 @@ import {
   GatewayPlugin,
 } from '@graphql-hive/gateway-runtime';
 import {
-  createOtlpHttpExporter,
+  SEMRESATTRS_SERVICE_NAME,
   useOpenTelemetry,
 } from '@graphql-mesh/plugin-opentelemetry';
 import http from '@graphql-mesh/transport-http';
+import { diag } from '@opentelemetry/api';
+import { setGlobalErrorHandler } from '@opentelemetry/core';
+import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
+import { resourceFromAttributes } from '@opentelemetry/resources';
+import { SimpleSpanProcessor } from '@opentelemetry/sdk-trace-base';
+import { WebTracerProvider } from '@opentelemetry/sdk-trace-web';
 
 interface Env {
   OTLP_EXPORTER_URL: string;
@@ -38,28 +44,38 @@ const useOnFetchTracer = (): GatewayPlugin => {
 let runtime: ReturnType<typeof createGatewayRuntime>;
 function getRuntime(env: Env) {
   if (!runtime) {
+    setGlobalErrorHandler((err) => diag.error('Uncaught Error', err));
+
+    new WebTracerProvider({
+      resource: resourceFromAttributes({
+        [SEMRESATTRS_SERVICE_NAME]: env.OTLP_SERVICE_NAME,
+      }),
+      spanProcessors: [
+        // Do not batch for test
+        new SimpleSpanProcessor(
+          new OTLPTraceExporter({
+            url: env.OTLP_EXPORTER_URL,
+          }),
+        ),
+      ],
+    }).register();
+
     console.log(env);
     runtime = createGatewayRuntime({
       proxy: { endpoint: 'https://countries.trevorblades.com' },
       transports: { http },
       plugins: (ctx) => [
         useOpenTelemetry({
           ...ctx,
-          exporters: [
-            createOtlpHttpExporter(
-              { url: env['OTLP_EXPORTER_URL'] },
-              // Batching config is set in order to make it easier to test.
-              false,
-            ),
-          ],
-          serviceName: env['OTLP_SERVICE_NAME'],
+          traces: true,
         }),
         useOnFetchTracer(),
       ],
     });
   }
   return runtime;
 }
+
 export default {
   async fetch(req, env, ctx) {
     const res = await getRuntime(env)(req, env, ctx);

e2e/cloudflare-workers/src/index.ts

@@ -1,9 +1,7 @@
+import './otel-setup.js';
 import { createGatewayRuntime, Logger } from '@graphql-hive/gateway-runtime';
 import { PinoLogWriter } from '@graphql-hive/logger/writers/pino';
-import {
-  createOtlpHttpExporter,
-  useOpenTelemetry,
-} from '@graphql-mesh/plugin-opentelemetry';
+import { useOpenTelemetry } from '@graphql-mesh/plugin-opentelemetry';
 import { Opts } from '@internal/testing';
 import fastify, { type FastifyReply, type FastifyRequest } from 'fastify';
 
@@ -71,16 +69,7 @@ const gw = createGatewayRuntime<FastifyContext>({
   plugins: (ctx) => [
     useOpenTelemetry({
       ...ctx,
-      exporters: [
-        createOtlpHttpExporter(
-          {
-            url: process.env['OTLP_EXPORTER_URL'],
-          },
-          {
-            scheduledDelayMillis: 1,
-          },
-        ),
-      ],
+      traces: true,
     }),
   ],
 });

e2e/graphos-polling/services/gateway-fastify.ts

@@ -0,0 +1,34 @@
+import { SEMRESATTRS_SERVICE_NAME } from '@graphql-mesh/plugin-opentelemetry';
+import { diag } from '@opentelemetry/api';
+import { AsyncLocalStorageContextManager } from '@opentelemetry/context-async-hooks';
+import { setGlobalErrorHandler } from '@opentelemetry/core';
+import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
+import { resourceFromAttributes } from '@opentelemetry/resources';
+import { SimpleSpanProcessor } from '@opentelemetry/sdk-trace-base';
+import {
+  AlwaysOnSampler,
+  WebTracerProvider,
+} from '@opentelemetry/sdk-trace-web';
+
+setGlobalErrorHandler((err) => diag.error('Uncaught Error', err));
+
+const tracerProvider = new WebTracerProvider({
+  resource: resourceFromAttributes({
+    [SEMRESATTRS_SERVICE_NAME]: process.env['OTLP_SERVICE_NAME'],
+  }),
+  spanProcessors: [
+    // Do not batch for test
+    new SimpleSpanProcessor(
+      new OTLPTraceExporter({
+        url: process.env['OTLP_EXPORTER_URL'],
+      }),
+    ),
+  ],
+  sampler: new AlwaysOnSampler(),
+});
+
+tracerProvider.register({
+  contextManager: new AsyncLocalStorageContextManager(),
+});
+
+export { tracerProvider };

e2e/graphos-polling/services/otel-setup.ts

@@ -1,11 +1,13 @@
 import {
-  createOtlpGrpcExporter,
-  createOtlpHttpExporter,
   defineConfig,
   GatewayPlugin,
-  OpenTelemetryDiagLogLevel,
+  SEMRESATTRS_SERVICE_NAME,
 } from '@graphql-hive/gateway';
+import { AsyncLocalStorageContextManager } from '@graphql-mesh/plugin-opentelemetry/async-context-manager';
+import { opentelemetrySetup } from '@graphql-mesh/plugin-opentelemetry/setup';
 import type { MeshFetchRequestInit } from '@graphql-mesh/types';
+import { trace } from '@opentelemetry/api';
+import { resourceFromAttributes } from '@opentelemetry/resources';
 
 // The following plugin is used to trace the fetch calls made by Mesh.
 const useOnFetchTracer = (): GatewayPlugin => {
@@ -27,38 +29,39 @@ const useOnFetchTracer = (): GatewayPlugin => {
   };
 };
 
+const exporterModule =
+  process.env['OTLP_EXPORTER_TYPE'] === 'http'
+    ? await import(`@opentelemetry/exporter-trace-otlp-http`)
+    : await import(`@opentelemetry/exporter-trace-otlp-grpc`);
+
+const OTLPTraceExporter =
+  exporterModule.OTLPTraceExporter ?? exporterModule.default.OTLPTraceExporter;
+
+opentelemetrySetup({
+  contextManager: new AsyncLocalStorageContextManager(),
+  resource: resourceFromAttributes({
+    [SEMRESATTRS_SERVICE_NAME]: process.env['OTLP_SERVICE_NAME'],
+  }),
+  traces: {
+    exporter: new OTLPTraceExporter({ url: process.env['OTLP_EXPORTER_URL'] }),
+    batching: { maxExportBatchSize: 1, scheduledDelayMillis: 1 },
+  },
+});
+
 export const gatewayConfig = defineConfig({
   openTelemetry: {
-    diagLevel: OpenTelemetryDiagLogLevel.INFO,
-    exporters: [
-      process.env['OTLP_EXPORTER_TYPE'] === 'grpc'
-        ? createOtlpGrpcExporter(
-            {
-              url: process.env['OTLP_EXPORTER_URL'],
-            },
-            // Batching config is set in order to make it easier to test.
-            {
-              maxExportBatchSize: 1,
-              scheduledDelayMillis: 1,
-            },
-          )
-        : createOtlpHttpExporter(
-            {
-              url: process.env['OTLP_EXPORTER_URL'],
-            },
-            // Batching config is set in order to make it easier to test.
-            {
-              maxExportBatchSize: 1,
-              scheduledDelayMillis: 1,
-            },
-          ),
-    ],
-    serviceName: process.env['OTLP_SERVICE_NAME'],
+    traces: true,
   },
-  plugins: () =>
-    process.env['MEMTEST']
+  plugins: () => [
+    {
+      onExecute() {
+        trace.getActiveSpan()?.setAttribute('custom.attribute', 'custom value');
+      },
+    },
+    ...(process.env['MEMTEST']
       ? [
           // disable the plugin in memtests because the upstreamCallHeaders will grew forever reporting a false positive leak
         ]
-      : [useOnFetchTracer()],
+      : [useOnFetchTracer()]),
+  ],
 });