chore: improvements to OTEL system (#752)

Author: BlankParticle

apps/mail-bridge/queue/mail-processor.ts

@@ -295,8 +295,7 @@ export const worker = createWorker<MailProcessorJobData>(
     tracer.startActiveSpan('Mail Processor', async (span) => {
       try {
         span?.setAttributes({
-          'job.id': job.id,
-          'job.data': JSON.stringify(job.data)
+          'job.id': job.id
         });
 
         const { rawMessage, params } = job.data;
@@ -1034,7 +1033,6 @@ export const worker = createWorker<MailProcessorJobData>(
             ? e.message
             : 'Unknown Error in Mail Processor, Check Logs'
         );
-        span?.recordException(e as Error);
         // Throw the error to be caught by the worker, and moving to failed jobs
         throw e;
       }

packages/database/index.ts

@@ -12,27 +12,25 @@ if (opentelemetryEnabled) {
   const originalExecute = Connection.prototype.execute;
 
   Connection.prototype.execute = async function (query, args, options) {
-    return databaseTracer.startActiveSpan(`Database Query`, async (span) => {
+    return databaseTracer.startActiveSpan(`Database Call`, async (span) => {
       if (span) {
-        span.addEvent('database.query.start');
-        span.setAttribute('database.statement', query);
+        span.addEvent('db.call.start');
+        span.setAttribute('db.statement', query);
         if (Array.isArray(args)) {
           span.setAttribute(
-            'database.values',
-            args.map(
-              (v: string | null | number) => v?.toString?.() ?? 'Unknown'
-            )
+            'db.values',
+            args.map((v: string | null | number) => {
+              if (v === null) return 'null';
+              if (typeof v === 'undefined') return 'undefined';
+              return v?.toString?.() ?? 'Unknown';
+            })
           );
         }
       }
       const result = await originalExecute
         // @ts-expect-error, don't care about types here
-        .call(this, query, args, options)
-        .catch((err: Error) => {
-          span?.recordException(err);
-          throw err;
-        });
-      span?.addEvent('database.query.end');
+        .call(this, query, args, options);
+      span?.addEvent('db.call.end');
       return result;
     });
   };

packages/otel/helpers.ts

@@ -6,26 +6,18 @@ const { trace } = opentelemetryEnabled
   ? await import('@opentelemetry/api')
   : { trace: undefined };
 
+const { wrapTracer } = opentelemetryEnabled
+  ? await import('@opentelemetry/api/experimental')
+  : { wrapTracer: undefined };
+
 export function getTracer(name: string) {
-  if (!trace)
+  if (!trace || !wrapTracer)
     return {
       startActiveSpan: <Fn>(name: string, fn: (span?: Span) => Fn) => fn()
     };
-
-  const tracer = trace.getTracer(name);
+  const tracer = wrapTracer(trace.getTracer(name));
   return {
-    startActiveSpan<Fn>(name: string, fn: (span?: Span) => Fn) {
-      return tracer.startActiveSpan(name, (span) => {
-        const result = fn(span);
-        if (result instanceof Promise) {
-          void result.finally(() => span.end());
-          return result;
-        } else {
-          span.end();
-          return result;
-        }
-      });
-    }
+    startActiveSpan: tracer.withActiveSpan.bind(tracer)
   };
 }
 

packages/otel/setup.ts

@@ -23,6 +23,7 @@ export const setupOpentelemetry = ({
   name: string;
   version: string;
 }) => {
+  console.info(`Setting up OpenTelemetry for ${name}@${version}`);
   const resource = new Resource({
     'service.name': name,
     'service.version': version
@@ -52,8 +53,8 @@ export const setupOpentelemetry = ({
 
   registerInstrumentations({
     instrumentations: [
-      new UndiciInstrumentation(),
       new HttpInstrumentation(),
+      new UndiciInstrumentation(),
       new WinstonInstrumentation()
     ]
   });