add client report generation, also for child spans, add tests for sampling

Author: Lms24

dev-packages/node-integration-tests/suites/tracing/ignoreSpans-streamed/children/instrument.mjs

@@ -0,0 +1,12 @@
+import * as Sentry from '@sentry/node';
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
+
+Sentry.init({
+  dsn: 'https://public@dsn.ingest.sentry.io/1337',
+  release: '1.0',
+  tracesSampleRate: 1.0,
+  transport: loggingTransport,
+  traceLifecycle: 'stream',
+  ignoreSpans: ['middleware - expressInit', 'custom-to-drop'],
+  clientReportFlushInterval: 1_000,
+});

dev-packages/node-integration-tests/suites/tracing/ignoreSpans-streamed/children/server.mjs

@@ -0,0 +1,31 @@
+import express from 'express';
+import cors from 'cors';
+import * as Sentry from '@sentry/node';
+import { startExpressServerAndSendPortToRunner } from '@sentry-internal/node-integration-tests';
+
+const app = express();
+
+app.use(cors());
+
+app.get('/test/express', (_req, res) => {
+  Sentry.startSpan(
+    {
+      name: 'custom-to-drop',
+      op: 'custom',
+    },
+    () => {
+      Sentry.startSpan(
+        {
+          name: 'custom',
+          op: 'custom',
+        },
+        () => {},
+      );
+    },
+  );
+  res.send({ response: 'response 1' });
+});
+
+Sentry.setupExpressErrorHandler(app);
+
+startExpressServerAndSendPortToRunner(app);

…tes/tracing/ignoreSpans/children/test.ts …ng/ignoreSpans-streamed/children/test.tsdev-packages/node-integration-tests/suites/tracing/ignoreSpans/children/test.ts renamed to dev-packages/node-integration-tests/suites/tracing/ignoreSpans-streamed/children/test.ts dev-packages/node-integration-tests/suites/tracing/ignoreSpans/children/test.ts renamed to dev-packages/node-integration-tests/suites/tracing/ignoreSpans-streamed/children/test.ts

@@ -1,15 +1,27 @@
-import { afterAll, describe, expect, test } from 'vitest';
-import { cleanupChildProcesses, createRunner } from '../../../../utils/runner';
+import { afterAll, describe, expect } from 'vitest';
+import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../../utils/runner';
 import { SEMANTIC_ATTRIBUTE_SENTRY_OP } from '@sentry/core';
 
 describe('filtering child spans with ignoreSpans (streaming)', () => {
   afterAll(() => {
     cleanupChildProcesses();
   });
 
-  describe('CJS', () => {
+  createEsmAndCjsTests(__dirname, 'server.mjs', 'instrument.mjs', (createRunner, test) => {
     test('child spans are dropped and remaining spans correctly parented', async () => {
-      const runner = createRunner(__dirname, 'server.js')
+      const runner = createRunner()
+        .unignore('client_report')
+        .expect({
+          client_report: {
+            discarded_events: [
+              {
+                category: 'span',
+                quantity: 2,
+                reason: 'ignored',
+              },
+            ],
+          },
+        })
         .expect({
           span: container => {
             // 5 spans: 1 root, 2 middleware, 1 request handler, 1 custom
@@ -44,27 +56,5 @@ describe('filtering child spans with ignoreSpans (streaming)', () => {
 
       await runner.completed();
     });
-
-    test('client report contains discarded spans', async () => {
-      const runner = createRunner(__dirname, 'server.js')
-        .ignore('span')
-        .unignore('client_report')
-        .expect({
-          client_report: {
-            discarded_events: [
-              {
-                category: 'span',
-                quantity: 2,
-                reason: 'ignored',
-              },
-            ],
-          },
-        })
-        .start();
-
-      runner.makeRequest('get', '/test/express');
-
-      await runner.completed();
-    });
   });
 });

dev-packages/node-integration-tests/suites/tracing/ignoreSpans-streamed/segments/instrument.mjs

@@ -0,0 +1,12 @@
+import * as Sentry from '@sentry/node';
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
+
+Sentry.init({
+  dsn: 'https://public@dsn.ingest.sentry.io/1337',
+  release: '1.0',
+  tracesSampleRate: 1.0,
+  transport: loggingTransport,
+  traceLifecycle: 'stream',
+  ignoreSpans: [/\/health/],
+  clientReportFlushInterval: 1_000,
+});

dev-packages/node-integration-tests/suites/tracing/ignoreSpans-streamed/segments/server.mjs

@@ -0,0 +1,20 @@
+import express from 'express';
+import cors from 'cors';
+import * as Sentry from '@sentry/node';
+import { startExpressServerAndSendPortToRunner } from '@sentry-internal/node-integration-tests';
+
+const app = express();
+
+app.use(cors());
+
+app.get('/health', (_req, res) => {
+  res.send({ status: 'ok-health' });
+});
+
+app.get('/ok', (_req, res) => {
+  res.send({ status: 'ok' });
+});
+
+Sentry.setupExpressErrorHandler(app);
+
+startExpressServerAndSendPortToRunner(app);

dev-packages/node-integration-tests/suites/tracing/ignoreSpans-streamed/segments/test.ts

@@ -0,0 +1,45 @@
+import { afterAll, describe, expect } from 'vitest';
+import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../../utils/runner';
+
+describe('filtering segment spans with ignoreSpans (streaming)', () => {
+  afterAll(() => {
+    cleanupChildProcesses();
+  });
+
+  createEsmAndCjsTests(__dirname, 'server.mjs', 'instrument.mjs', (createRunner, test) => {
+    test('segment spans matching ignoreSpans are dropped including all children', async () => {
+      const runner = createRunner()
+        .unignore('client_report')
+        .expect({
+          client_report: {
+            discarded_events: [
+              {
+                category: 'span',
+                quantity: 5, // 1 segment ignored + 4 child spans (implicitly ignored)
+                reason: 'ignored',
+              },
+            ],
+          },
+        })
+        .expect({
+          span: container => {
+            expect(container.items).toHaveLength(5);
+            const segmentSpan = container.items.find(s => s.name === 'GET /ok' && !!s.is_segment);
+
+            expect(segmentSpan).toBeDefined();
+            expect(container.items.every(s => s.trace_id === segmentSpan!.trace_id)).toBe(true);
+          },
+        })
+
+        .start();
+
+      const res = await runner.makeRequest('get', '/health');
+      expect((res as { status: string }).status).toBe('ok-health');
+
+      const res2 = await runner.makeRequest('get', '/ok'); // contains all spans
+      expect((res2 as { status: string }).status).toBe('ok');
+
+      await runner.completed();
+    });
+  });
+});

dev-packages/node-integration-tests/suites/tracing/ignoreSpans/children/server.js

@@ -0,0 +1,15 @@
+import * as Sentry from '@sentry/node';
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
+
+Sentry.init({
+  dsn: 'https://public@dsn.ingest.sentry.io/1337',
+  release: '1.0',
+  tracesSampler: ({ inheritOrSampleWith, name }) => {
+    if (name === 'GET /health') {
+      return inheritOrSampleWith(0);
+    }
+    return inheritOrSampleWith(1);
+  },
+  transport: loggingTransport,
+  clientReportFlushInterval: 1_000,
+});