fix(instrumentation-fastify): do not wrap preClose and onRequestAbort…

… hooks (#1764) Fixes: #1762
open-telemetry · Nov 6, 2023 · de6156a · de6156a
1 parent 1b0caa6
commit de6156a
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 9 deletions.
diff --git a/plugins/node/opentelemetry-instrumentation-fastify/src/constants.ts b/plugins/node/opentelemetry-instrumentation-fastify/src/constants.ts
@@ -18,9 +18,18 @@ export const spanRequestSymbol = Symbol(
   'opentelemetry.instrumentation.fastify.request_active_span'
 );
 
-export const applicationHookNames = [
-  'onRegister',
-  'onRoute',
-  'onReady',
-  'onClose',
-];
+// The instrumentation creates a span for invocations of lifecycle hook handlers
+// that take `(request, reply, ...[, done])` arguments. Currently this is all
+// lifecycle hooks except `onRequestAbort`.
+// https://fastify.dev/docs/latest/Reference/Hooks
+export const hooksNamesToWrap = new Set([
+  'onTimeout',
+  'onRequest',
+  'preParsing',
+  'preValidation',
+  'preSerialization',
+  'preHandler',
+  'onSend',
+  'onResponse',
+  'onError',
+]);
diff --git a/plugins/node/opentelemetry-instrumentation-fastify/src/instrumentation.ts b/plugins/node/opentelemetry-instrumentation-fastify/src/instrumentation.ts
@@ -33,7 +33,7 @@ import type {
   FastifyRequest,
   FastifyReply,
 } from 'fastify';
-import { applicationHookNames } from './constants';
+import { hooksNamesToWrap } from './constants';
 import {
   AttributeNames,
   FastifyNames,
@@ -178,8 +178,8 @@ export class FastifyInstrumentation extends InstrumentationBase {
         const name = args[0] as string;
         const handler = args[1] as HandlerOriginal;
         const pluginName = this.pluginName;
-        if (applicationHookNames.includes(name)) {
-          return original.apply(this, [name, handler] as never);
+        if (!hooksNamesToWrap.has(name)) {
+          return original.apply(this, args);
         }
 
         const syncFunctionWithDone =

diff --git a/plugins/node/opentelemetry-instrumentation-fastify/test/instrumentation.test.ts b/plugins/node/opentelemetry-instrumentation-fastify/test/instrumentation.test.ts
@@ -424,6 +424,14 @@ describe('fastify', () => {
         await startServer();
       });
 
+      it('preClose is not instrumented', async () => {
+        app.addHook('preClose', () => {
+          assertRootContextActive();
+        });
+
+        await startServer();
+      });
+
       it('onClose is not instrumented', async () => {
         app.addHook('onClose', () => {
           assertRootContextActive();