@adonisjs/otel 1.1.0 → 1.1.2

package/build/src/debug.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("util").DebugLogger;
+export default _default;

package/build/src/debug.js

@@ -0,0 +1,2 @@
+import { debuglog } from 'node:util';
+export default debuglog('adonisjs:otel');

package/build/src/http_url_filter.d.ts

@@ -8,6 +8,7 @@ export declare class HttpUrlFilter {
     #private;
     static readonly DEFAULT_IGNORED_URLS: string[];
     static readonly STATIC_FILE_EXTENSIONS: Set<string>;
+    static readonly DEV_SERVER_PATTERNS: string[];
     constructor(config?: HttpInstrumentationConfig);
     /**
      * Check if a request should be ignored (not traced).

package/build/src/http_url_filter.js

@@ -1,3 +1,4 @@
+import debug from './debug.js';
 /**
  * Handles URL filtering for OpenTelemetry HTTP instrumentation.
  * Determines which requests should be ignored (not traced).
@@ -11,6 +12,13 @@ export class HttpUrlFilter {
         '/readiness',
         '/metrics',
         '/internal/metrics',
+        '/favicon.ico',
+        '/robots.txt',
+        '/sitemap.xml',
+        '/manifest.json',
+        '/site.webmanifest',
+        '/browserconfig.xml',
+        '/ads.txt',
     ];
     static STATIC_FILE_EXTENSIONS = new Set([
         'css',
@@ -40,7 +48,13 @@ export class HttpUrlFilter {
         'ogg',
         'wav',
         'pdf',
+        'vue',
+        'svelte',
+        'webmanifest',
+        'txt',
+        'xml',
     ]);
+    static DEV_SERVER_PATTERNS = ['/@vite/', '/@id/', '/@fs/', '/__vite', '/@react-refresh'];
     #ignoredUrls;
     #ignoreStaticFiles;
     #ignoreOptionsRequests;
@@ -66,6 +80,9 @@ export class HttpUrlFilter {
         const extension = lastSegment.slice(dotIndex + 1).toLowerCase();
         return HttpUrlFilter.STATIC_FILE_EXTENSIONS.has(extension);
     }
+    #isDevServerRequest(url) {
+        return HttpUrlFilter.DEV_SERVER_PATTERNS.some((pattern) => url.startsWith(pattern));
+    }
     #matchesPattern(urlPath, pattern) {
         if (pattern.endsWith('/*')) {
             const prefix = pattern.slice(0, -2);
@@ -83,17 +100,29 @@ export class HttpUrlFilter {
      */
     shouldIgnore(request) {
         const { url, method } = request;
-        if (this.#ignoreOptionsRequests && method === 'OPTIONS')
+        if (this.#ignoreOptionsRequests && method === 'OPTIONS') {
+            debug('ignoring request "%s %s" (reason: OPTIONS method)', method, url);
             return true;
+        }
         if (!url)
             return false;
         const urlPath = url.split('?')[0];
-        if (this.#ignoreStaticFiles && this.#isStaticFile(urlPath))
+        if (this.#ignoreStaticFiles && this.#isStaticFile(urlPath)) {
+            debug('ignoring request "%s %s" (reason: static file)', method, urlPath);
+            return true;
+        }
+        if (this.#ignoreStaticFiles && this.#isDevServerRequest(urlPath)) {
+            debug('ignoring request "%s %s" (reason: dev server pattern)', method, urlPath);
             return true;
-        if (this.#ignoredUrls.some((pattern) => this.#matchesPattern(urlPath, pattern)))
+        }
+        if (this.#ignoredUrls.some((pattern) => this.#matchesPattern(urlPath, pattern))) {
+            debug('ignoring request "%s %s" (reason: ignored url pattern)', method, urlPath);
+            return true;
+        }
+        if (this.#userIgnoreHook && this.#userIgnoreHook(request)) {
+            debug('ignoring request "%s %s" (reason: user hook)', method, urlPath);
             return true;
-        if (this.#userIgnoreHook)
-            return this.#userIgnoreHook(request);
+        }
         return false;
     }
     /**

package/build/src/otel.js

@@ -6,6 +6,7 @@ import { ATTR_HTTP_ROUTE, ATTR_SERVICE_NAME, ATTR_SERVICE_VERSION, } from '@open
 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';
+import debug from './debug.js';
 /**
  * OpenTelemetry SDK manager for AdonisJS.
  *
@@ -140,6 +141,10 @@ export class OtelManager {
      */
     #buildInstrumentations() {
         const { customInstances, disabledSet, configOverrides, httpConfig, pinoConfig } = this.#processUserInstrumentations(this.#config.instrumentations);
+        if (disabledSet.size > 0)
+            debug('disabled instrumentations: %O', [...disabledSet]);
+        if (customInstances.length > 0)
+            debug('custom instrumentations: %O', customInstances.map((i) => i.instrumentationName));
         const mergedConfig = this.#buildBaseInstrumentationConfig();
         for (const [name, config] of Object.entries(configOverrides)) {
             mergedConfig[name] = {
@@ -221,12 +226,14 @@ export class OtelManager {
      * Start the OpenTelemetry SDK
      */
     start() {
+        debug('starting otel sdk for service "%s" v%s (%s)', this.serviceName, this.serviceVersion, this.environment);
         this.sdk.start();
     }
     /**
      * Gracefully shutdown the OpenTelemetry SDK
      */
     async shutdown() {
+        debug('shutting down otel sdk');
         await this.sdk.shutdown();
     }
     /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@adonisjs/otel",
   "description": "OpenTelemetry integration for AdonisJS with sensible defaults and zero-config setup",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "engines": {
     "node": ">=20.6.0"
   },