@adonisjs/otel 1.0.0-next.3 → 1.0.0-next.4

package/build/src/http_url_filter.d.ts

@@ -0,0 +1,24 @@
+import type { InstrumentationConfigMap } from '@opentelemetry/auto-instrumentations-node';
+import type { HttpInstrumentationConfig } from './types/instrumentations.js';
+/**
+ * Handles URL filtering for OpenTelemetry HTTP instrumentation.
+ * Determines which requests should be ignored (not traced).
+ */
+export declare class HttpUrlFilter {
+    #private;
+    static readonly DEFAULT_IGNORED_URLS: string[];
+    static readonly STATIC_FILE_EXTENSIONS: Set<string>;
+    constructor(config?: HttpInstrumentationConfig);
+    /**
+     * Check if a URL should be ignored (not traced).
+     * A URL is ignored if:
+     * - It's a static file and ignoreStaticFiles is true (default)
+     * - It matches the ignored URLs list (exact or prefix pattern)
+     * - The user's custom hook returns true
+     */
+    shouldIgnore(url: string | undefined): boolean;
+    /**
+     * Apply HTTP instrumentation config to the merged config map
+     */
+    applyToConfig(mergedConfig: InstrumentationConfigMap, userHttpConfig?: HttpInstrumentationConfig): void;
+}

package/build/src/http_url_filter.js

@@ -0,0 +1,108 @@
+/**
+ * Handles URL filtering for OpenTelemetry HTTP instrumentation.
+ * Determines which requests should be ignored (not traced).
+ */
+export class HttpUrlFilter {
+    static DEFAULT_IGNORED_URLS = [
+        '/health',
+        '/healthz',
+        '/internal/healthz',
+        '/ready',
+        '/readiness',
+        '/metrics',
+        '/internal/metrics',
+    ];
+    static STATIC_FILE_EXTENSIONS = new Set([
+        'css',
+        'js',
+        'mjs',
+        'cjs',
+        'ts',
+        'tsx',
+        'jsx',
+        'map',
+        'woff',
+        'woff2',
+        'ttf',
+        'eot',
+        'otf',
+        'svg',
+        'png',
+        'jpg',
+        'jpeg',
+        'gif',
+        'webp',
+        'ico',
+        'avif',
+        'mp4',
+        'webm',
+        'mp3',
+        'ogg',
+        'wav',
+        'pdf',
+    ]);
+    #ignoredUrls;
+    #ignoreStaticFiles;
+    #userIgnoreHook;
+    constructor(config) {
+        this.#ignoredUrls = this.#buildIgnoredUrls(config);
+        this.#ignoreStaticFiles = config?.ignoreStaticFiles !== false;
+        this.#userIgnoreHook = config?.ignoreIncomingRequestHook;
+    }
+    #buildIgnoredUrls(config) {
+        const userUrls = config?.ignoredUrls || [];
+        const mergeWithDefaults = config?.mergeIgnoredUrls !== false;
+        if (!mergeWithDefaults)
+            return userUrls;
+        return [...HttpUrlFilter.DEFAULT_IGNORED_URLS, ...userUrls];
+    }
+    #isStaticFile(url) {
+        const lastSegment = url.split('/').pop() || '';
+        const dotIndex = lastSegment.lastIndexOf('.');
+        if (dotIndex === -1)
+            return false;
+        const extension = lastSegment.slice(dotIndex + 1).toLowerCase();
+        return HttpUrlFilter.STATIC_FILE_EXTENSIONS.has(extension);
+    }
+    #matchesPattern(urlPath, pattern) {
+        if (pattern.endsWith('/*')) {
+            const prefix = pattern.slice(0, -2);
+            return urlPath === prefix || urlPath.startsWith(prefix + '/');
+        }
+        return urlPath === pattern || urlPath.startsWith(pattern + '/');
+    }
+    /**
+     * Check if a URL should be ignored (not traced).
+     * A URL is ignored if:
+     * - It's a static file and ignoreStaticFiles is true (default)
+     * - It matches the ignored URLs list (exact or prefix pattern)
+     * - The user's custom hook returns true
+     */
+    shouldIgnore(url) {
+        if (!url)
+            return false;
+        const urlPath = url.split('?')[0];
+        if (this.#ignoreStaticFiles && this.#isStaticFile(urlPath))
+            return true;
+        if (this.#ignoredUrls.some((pattern) => this.#matchesPattern(urlPath, pattern)))
+            return true;
+        if (this.#userIgnoreHook)
+            return this.#userIgnoreHook({ url });
+        return false;
+    }
+    /**
+     * Apply HTTP instrumentation config to the merged config map
+     */
+    applyToConfig(mergedConfig, userHttpConfig) {
+        const httpKey = '@opentelemetry/instrumentation-http';
+        const currentConfig = mergedConfig[httpKey];
+        if (currentConfig && 'enabled' in currentConfig && currentConfig.enabled === false) {
+            return;
+        }
+        mergedConfig[httpKey] = {
+            ...currentConfig,
+            ...userHttpConfig,
+            ignoreIncomingRequestHook: (req) => this.shouldIgnore(req.url),
+        };
+    }
+}

package/build/src/otel.d.ts

@@ -20,7 +20,6 @@ import type { OtelConfig } from './types/index.js';
  */
 export declare class OtelManager {
     #private;
-    static readonly DEFAULT_IGNORED_URLS: string[];
     readonly sdk: NodeSDK;
     readonly serviceName: string;
     readonly serviceVersion: string;

package/build/src/otel.js

@@ -5,6 +5,7 @@ import { ConsoleSpanExporter, ParentBasedSampler, SimpleSpanProcessor, TraceIdRa
 import { ATTR_SERVICE_NAME, ATTR_SERVICE_VERSION } from '@opentelemetry/semantic-conventions';
 import { ATTR_DEPLOYMENT_ENVIRONMENT_NAME, ATTR_SERVICE_INSTANCE_ID, } from '@opentelemetry/semantic-conventions/incubating';
 import { HttpContext } from '@adonisjs/core/http';
+import { HttpUrlFilter } from './http_url_filter.js';
 /**
  * OpenTelemetry SDK manager for AdonisJS.
  *
@@ -24,16 +25,6 @@ import { HttpContext } from '@adonisjs/core/http';
  * ```
  */
 export class OtelManager {
-    static DEFAULT_IGNORED_URLS = [
-        '/health',
-        '/healthz',
-        '/internal/healthz',
-        '/ready',
-        '/readiness',
-        '/metrics',
-        '/internal/metrics',
-        '/favicon.ico',
-    ];
     static #instance = null;
     sdk;
     serviceName;
@@ -80,32 +71,6 @@ export class OtelManager {
             ...this.#config.resourceAttributes,
         });
     }
-    /**
-     * Get the resolved list of ignored URLs from HTTP instrumentation config
-     */
-    #getIgnoredUrls(httpConfig) {
-        const userUrls = httpConfig?.ignoredUrls || [];
-        const mergeWithDefaults = httpConfig?.mergeIgnoredUrls !== false;
-        if (!mergeWithDefaults) {
-            return userUrls;
-        }
-        return [...OtelManager.DEFAULT_IGNORED_URLS, ...userUrls];
-    }
-    /**
-     * Check if a URL should be ignored based on the ignored URLs list.
-     * Supports exact matches and wildcard patterns (e.g., '/internal/*')
-     */
-    #shouldIgnoreUrl(url, ignoredUrls) {
-        if (!url)
-            return false;
-        return ignoredUrls.some((pattern) => {
-            if (pattern.endsWith('/*')) {
-                const prefix = pattern.slice(0, -1);
-                return url.startsWith(prefix);
-            }
-            return url.startsWith(pattern);
-        });
-    }
     /**
      * Check if a value is an Instrumentation instance
      */
@@ -185,34 +150,12 @@ export class OtelManager {
         for (const name of disabledSet) {
             mergedConfig[name] = { enabled: false };
         }
-        this.#applyHttpInstrumentationConfig(mergedConfig, httpConfig);
+        const httpUrlFilter = new HttpUrlFilter(httpConfig);
+        httpUrlFilter.applyToConfig(mergedConfig, httpConfig);
         this.#applyPinoInstrumentationConfig(mergedConfig, pinoConfig);
         const autoInstrumentations = getNodeAutoInstrumentations(mergedConfig);
         return [...autoInstrumentations, ...customInstances];
     }
-    /**
-     * Apply HTTP instrumentation configuration with smart merging of ignoreIncomingRequestHook
-     */
-    #applyHttpInstrumentationConfig(mergedConfig, userHttpConfig) {
-        const httpKey = '@opentelemetry/instrumentation-http';
-        const currentConfig = mergedConfig[httpKey];
-        if (currentConfig && 'enabled' in currentConfig && currentConfig.enabled === false) {
-            return;
-        }
-        const ignoredUrls = this.#getIgnoredUrls(userHttpConfig);
-        const userIgnoreHook = userHttpConfig?.ignoreIncomingRequestHook;
-        mergedConfig[httpKey] = {
-            ...currentConfig,
-            ...userHttpConfig,
-            ignoreIncomingRequestHook: (req) => {
-                if (this.#shouldIgnoreUrl(req.url, ignoredUrls))
-                    return true;
-                if (userIgnoreHook)
-                    return userIgnoreHook(req);
-                return false;
-            },
-        };
-    }
     /**
      * Apply Pino instrumentation configuration with smart merging of logHook
      */

package/build/src/types/instrumentations.d.ts

@@ -21,9 +21,9 @@ export interface HttpInstrumentationConfig extends Omit<NonNullable<Instrumentat
     /**
      * URLs to ignore in HTTP instrumentation.
      * Merged with defaults unless `mergeIgnoredUrls` is false.
-     * Supports wildcards: '/internal/*'
+     * Supports exact matches and prefix patterns ('/internal/*').
      *
-     * @default ['/health', '/healthz', '/ready', '/metrics', '/favicon.ico', ...]
+     * @default ['/health', '/healthz', '/ready', '/metrics', ...]
      */
     ignoredUrls?: string[];
     /**
@@ -31,9 +31,14 @@ export interface HttpInstrumentationConfig extends Omit<NonNullable<Instrumentat
      * @default true
      */
     mergeIgnoredUrls?: boolean;
+    /**
+     * Whether to automatically ignore static files (css, js, images, fonts, etc.).
+     * @default true
+     */
+    ignoreStaticFiles?: boolean;
     /**
      * Custom hook to ignore specific incoming requests.
-     * Called AFTER the ignoredUrls check.
+     * Called AFTER the ignoredUrls and static files checks.
      */
     ignoreIncomingRequestHook?: (request: {
         url?: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@adonisjs/otel",
   "description": "OpenTelemetry integration for AdonisJS with sensible defaults and zero-config setup",
-  "version": "1.0.0-next.3",
+  "version": "1.0.0-next.4",
   "engines": {
     "node": ">=20.6.0"
   },
@@ -37,6 +37,7 @@
     "test": "c8 npm run quick:test",
     "prebuild": "npm run lint && npm run clean",
     "build": "tsc",
+    "checks": "npm run lint && npm run typecheck && npm run test",
     "postbuild": "npm run copy:templates",
     "release": "release-it",
     "version": "npm run build",