feat(hono): Filter noisy transactions (favicon etc) (#21365)

Similar to #21145

Author: s1gr1d

packages/hono/src/bun/sdk.ts

@@ -3,6 +3,7 @@ import { applySdkMetadata, consoleSandbox, getClient } from '@sentry/core';
 import { init as initBun } from '@sentry/bun';
 import type { HonoBunOptions } from './middleware';
 import { buildFilteredIntegrations } from '../shared/buildFilteredIntegrations';
+import { LOW_QUALITY_TRANSACTION_PATTERNS } from '../shared/lowQualityTransactionPatterns';
 
 /**
  * Initializes Sentry for Hono running in a Bun runtime environment.
@@ -23,9 +24,10 @@ export function init(options: HonoBunOptions): Client | undefined {
 
   applySdkMetadata(options, 'hono', ['hono', 'bun']);
 
-  // Remove Hono from the SDK defaults to prevent double instrumentation: @sentry/bun
   const filteredOptions: HonoBunOptions = {
     ...options,
+    ignoreSpans: [...(options.ignoreSpans || []), ...LOW_QUALITY_TRANSACTION_PATTERNS],
+    // Remove Hono from the SDK defaults to prevent double instrumentation: @sentry/bun
     integrations: buildFilteredIntegrations(options.integrations, false),
   };
 

packages/hono/src/cloudflare/middleware.ts

@@ -2,6 +2,7 @@ import { withSentry } from '@sentry/cloudflare';
 import { applySdkMetadata, type BaseTransportOptions, debug, type Options } from '@sentry/core';
 import type { Env, Hono, MiddlewareHandler } from 'hono';
 import { buildFilteredIntegrations } from '../shared/buildFilteredIntegrations';
+import { LOW_QUALITY_TRANSACTION_PATTERNS } from '../shared/lowQualityTransactionPatterns';
 import { requestHandler, responseHandler } from '../shared/middlewareHandlers';
 import { applyPatches } from '../shared/applyPatches';
 import type { SentryHonoMiddlewareOptions } from '../shared/types';
@@ -25,6 +26,7 @@ export function sentry<E extends Env>(
 
       return {
         ...honoOptions,
+        ignoreSpans: [...(honoOptions.ignoreSpans || []), ...LOW_QUALITY_TRANSACTION_PATTERNS],
         // Always filter out the Hono integration from defaults and user integrations.
         // The Hono integration is already set up by withSentry, so adding it again would cause capturing too early (in Cloudflare SDK) and non-parametrized URLs.
         integrations: buildFilteredIntegrations(honoOptions.integrations, true),

packages/hono/src/node/sdk.ts

@@ -3,6 +3,7 @@ import { applySdkMetadata, debug, getClient } from '@sentry/core';
 import { init as initNode } from '@sentry/node';
 import type { HonoNodeOptions } from './middleware';
 import { buildFilteredIntegrations } from '../shared/buildFilteredIntegrations';
+import { LOW_QUALITY_TRANSACTION_PATTERNS } from '../shared/lowQualityTransactionPatterns';
 
 /**
  * Initializes Sentry for Hono running in a Node runtime environment.
@@ -20,6 +21,7 @@ export function init(options: HonoNodeOptions): Client | undefined {
 
   const filteredOptions: HonoNodeOptions = {
     ...options,
+    ignoreSpans: [...(options.ignoreSpans || []), ...LOW_QUALITY_TRANSACTION_PATTERNS],
     integrations: buildFilteredIntegrations(options.integrations, false),
   };
 

packages/hono/src/shared/lowQualityTransactionPatterns.ts

@@ -0,0 +1,11 @@
+/**
+ * Patterns for low-quality transactions that should be filtered out.
+ * Covers e.g. browser noise (favicon) and Vite dev-server artifacts (`@hono/vite-dev-server`).
+ */
+export const LOW_QUALITY_TRANSACTION_PATTERNS: (string | RegExp)[] = [
+  /\/node_modules\//,
+  /\/favicon\.ico/,
+  /\/@id\//,
+  /\/@fs\//,
+  /\/@vite\//,
+];

packages/hono/test/bun/middleware.test.ts

@@ -4,6 +4,7 @@ import { Hono } from 'hono';
 import { beforeEach, describe, expect, it, type Mock, vi } from 'vitest';
 import { sentry } from '../../src/bun/middleware';
 import { init } from '../../src/bun/sdk';
+import { LOW_QUALITY_TRANSACTION_PATTERNS } from '../../src/shared/lowQualityTransactionPatterns';
 
 vi.mock('@sentry/bun', () => ({
   init: vi.fn(),
@@ -205,4 +206,35 @@ describe('Hono Bun Middleware', () => {
       expect(initBunMock).toHaveBeenCalledTimes(1);
     });
   });
+
+  describe('ignoreSpans (low-quality transaction filtering)', () => {
+    it('adds default low-quality transaction patterns to ignoreSpans', () => {
+      const app = new Hono();
+      sentry(app, { dsn: 'https://public@dsn.ingest.sentry.io/1337' });
+
+      const callArgs = (initBunMock as Mock).mock.calls[0]?.[0];
+      expect(callArgs.ignoreSpans).toEqual(expect.arrayContaining(LOW_QUALITY_TRANSACTION_PATTERNS));
+    });
+
+    it('preserves user-supplied ignoreSpans and appends defaults', () => {
+      const app = new Hono();
+      const userPattern = /^GET \/health$/;
+      sentry(app, {
+        dsn: 'https://public@dsn.ingest.sentry.io/1337',
+        ignoreSpans: [userPattern],
+      });
+
+      const callArgs = (initBunMock as Mock).mock.calls[0]?.[0];
+      expect(callArgs.ignoreSpans[0]).toBe(userPattern);
+      expect(callArgs.ignoreSpans).toEqual(expect.arrayContaining(LOW_QUALITY_TRANSACTION_PATTERNS));
+    });
+
+    it('handles undefined ignoreSpans gracefully', () => {
+      const app = new Hono();
+      sentry(app, { dsn: 'https://public@dsn.ingest.sentry.io/1337' });
+
+      const callArgs = (initBunMock as Mock).mock.calls[0]?.[0];
+      expect(callArgs.ignoreSpans).toHaveLength(LOW_QUALITY_TRANSACTION_PATTERNS.length);
+    });
+  });
 });

packages/hono/test/cloudflare/middleware.test.ts

@@ -4,6 +4,7 @@ import { SDK_VERSION } from '@sentry/core';
 import { Hono } from 'hono';
 import { beforeEach, describe, expect, it, type Mock, vi } from 'vitest';
 import { sentry } from '../../src/cloudflare/middleware';
+import { LOW_QUALITY_TRANSACTION_PATTERNS } from '../../src/shared/lowQualityTransactionPatterns';
 
 vi.mock('@sentry/cloudflare', { spy: true });
 vi.mock('@sentry/core', async () => {
@@ -117,6 +118,33 @@ describe('Hono Cloudflare Middleware', () => {
       expect(middleware.constructor.name).toBe('AsyncFunction');
     });
 
+    describe('ignoreSpans', () => {
+      it('adds universal low-quality transaction patterns to ignoreSpans', () => {
+        const app = new Hono();
+        sentry(app, { dsn: 'https://public@dsn.ingest.sentry.io/1337' });
+
+        const optionsCallback = withSentryMock.mock.calls[0]?.[0];
+        const result = optionsCallback();
+
+        expect(result.ignoreSpans).toEqual(expect.arrayContaining(LOW_QUALITY_TRANSACTION_PATTERNS));
+      });
+
+      it('preserves user-supplied ignoreSpans and appends defaults', () => {
+        const app = new Hono();
+        const userPattern = /^GET \/health$/;
+        sentry(app, {
+          dsn: 'https://public@dsn.ingest.sentry.io/1337',
+          ignoreSpans: [userPattern],
+        });
+
+        const optionsCallback = withSentryMock.mock.calls[0]?.[0];
+        const result = optionsCallback();
+
+        expect(result.ignoreSpans[0]).toBe(userPattern);
+        expect(result.ignoreSpans).toEqual(expect.arrayContaining(LOW_QUALITY_TRANSACTION_PATTERNS));
+      });
+    });
+
     describe('when options is a function (env callback)', () => {
       it('calls the options function with the env argument passed by withSentry', () => {
         type Bindings = { SENTRY_DSN: string };

packages/hono/test/node/sdk.test.ts

@@ -2,6 +2,7 @@ import * as SentryCore from '@sentry/core';
 import { SDK_VERSION } from '@sentry/core';
 import { beforeEach, describe, expect, it, type Mock, vi } from 'vitest';
 import { init } from '../../src/node/sdk';
+import { LOW_QUALITY_TRANSACTION_PATTERNS } from '../../src/shared/lowQualityTransactionPatterns';
 
 vi.mock('@sentry/node', () => ({
   init: vi.fn().mockReturnValue({
@@ -172,4 +173,30 @@ describe('Hono Node SDK – init()', () => {
     expect(initNodeMock).toHaveBeenCalledTimes(1);
     expect(applySdkMetadataMock).toHaveBeenCalledTimes(1);
   });
+
+  it('adds default low-quality transaction patterns to ignoreSpans', () => {
+    init({ dsn: 'https://public@dsn.ingest.sentry.io/1337' });
+
+    const callArgs = (initNodeMock as Mock).mock.calls[0]?.[0];
+    expect(callArgs.ignoreSpans).toEqual(expect.arrayContaining(LOW_QUALITY_TRANSACTION_PATTERNS));
+  });
+
+  it('preserves user-supplied ignoreSpans and appends defaults', () => {
+    const userPattern = /^GET \/health$/;
+    init({
+      dsn: 'https://public@dsn.ingest.sentry.io/1337',
+      ignoreSpans: [userPattern],
+    });
+
+    const callArgs = (initNodeMock as Mock).mock.calls[0]?.[0];
+    expect(callArgs.ignoreSpans[0]).toBe(userPattern);
+    expect(callArgs.ignoreSpans).toEqual(expect.arrayContaining(LOW_QUALITY_TRANSACTION_PATTERNS));
+  });
+
+  it('handles undefined ignoreSpans gracefully', () => {
+    init({ dsn: 'https://public@dsn.ingest.sentry.io/1337' });
+
+    const callArgs = (initNodeMock as Mock).mock.calls[0]?.[0];
+    expect(callArgs.ignoreSpans).toHaveLength(LOW_QUALITY_TRANSACTION_PATTERNS.length);
+  });
 });