cursor cleanup

Author: AbhiPrasad

PR_DESCRIPTION.md

@@ -1,6 +1,6 @@
 import type * as http from 'node:http';
 import type { Span } from '@opentelemetry/api';
-import type { ExpressRequestInfo } from '@opentelemetry/instrumentation-express';
+import type { ExpressLayerType, ExpressRequestInfo } from '@opentelemetry/instrumentation-express';
 import { ExpressInstrumentation } from '@opentelemetry/instrumentation-express';
 import type { IntegrationFn } from '@sentry/core';
 import {
@@ -26,11 +26,33 @@ type IgnoreMatcher = string | RegExp | ((path: string) => boolean);
 
 interface ExpressOptions {
   /**
-   * Ignore specific layers based on their path
+   * Ignore specific layers based on their path.
+   *
+   * Accepts an array of matchers that can be:
+   * - String: exact path match
+   * - RegExp: pattern matching
+   * - Function: custom logic that receives the path and returns boolean
    */
   ignoreLayers?: IgnoreMatcher[];
   /**
-   * Ignore specific layers based on their type
+   * Ignore specific layers based on their type.
+   *
+   * Available layer types:
+   * - 'router': Express router layers
+   * - 'middleware': Express middleware layers
+   * - 'request_handler': Express request handler layers
+   *
+   * @example
+   * ```javascript
+   * // Ignore only middleware layers
+   * ignoreLayersType: ['middleware']
+   *
+   * // Ignore multiple layer types
+   * ignoreLayersType: ['middleware', 'router']
+   *
+   * // Ignore all layer types (effectively disables tracing)
+   * ignoreLayersType: ['middleware', 'router', 'request_handler']
+   * ```
    */
   ignoreLayersType?: ('router' | 'middleware' | 'request_handler')[];
 }
@@ -74,7 +96,7 @@ export const instrumentExpress = generateInstrumentOnce(
       requestHook: span => requestHook(span),
       spanNameHook: (info, defaultName) => spanNameHook(info, defaultName),
       ignoreLayers: options.ignoreLayers,
-      ignoreLayersType: options.ignoreLayersType as any,
+      ignoreLayersType: options.ignoreLayersType as ExpressLayerType[],
     }),
 );
 
@@ -85,7 +107,7 @@ export const instrumentExpressV5 = generateInstrumentOnce(
       requestHook: span => requestHook(span),
       spanNameHook: (info, defaultName) => spanNameHook(info, defaultName),
       ignoreLayers: options.ignoreLayers,
-      ignoreLayersType: options.ignoreLayersType as any,
+      ignoreLayersType: options.ignoreLayersType as ExpressLayerType[],
     }),
 );
 

packages/node/src/integrations/tracing/express.ts

@@ -86,7 +86,7 @@ describe('Express', () => {
     it('passes both options to instrumentation', () => {
       instrumentExpress({
         ignoreLayers: ['/health'],
-        ignoreLayersType: ['request_handler']
+        ignoreLayersType: ['request_handler'],
       });
 
       expect(ExpressInstrumentation).toHaveBeenCalledTimes(1);
@@ -115,7 +115,7 @@ describe('Express', () => {
     it('passes options to instrumentExpressV5', () => {
       instrumentExpressV5({
         ignoreLayers: [(path: string) => path.startsWith('/admin')],
-        ignoreLayersType: ['middleware', 'router']
+        ignoreLayersType: ['middleware', 'router'],
       });
 
       expect(ExpressInstrumentationV5).toHaveBeenCalledTimes(1);
@@ -152,7 +152,7 @@ describe('Express', () => {
     it('passes options from expressIntegration to both instrumentations', () => {
       expressIntegration({
         ignoreLayers: [/^\/api\/v1/],
-        ignoreLayersType: ['middleware']
+        ignoreLayersType: ['middleware'],
       }).setupOnce!();
 
       expect(ExpressInstrumentation).toHaveBeenCalledTimes(1);
@@ -174,7 +174,7 @@ describe('Express', () => {
 
     it('passes all layer types from expressIntegration to instrumentation', () => {
       expressIntegration({
-        ignoreLayersType: ['router', 'middleware', 'request_handler']
+        ignoreLayersType: ['router', 'middleware', 'request_handler'],
       }).setupOnce!();
 
       expect(ExpressInstrumentation).toHaveBeenCalledTimes(1);