-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
fix(node): Do not emit fetch spans when tracing is disabled #13003
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
2 changes: 1 addition & 1 deletion
2
dev-packages/e2e-tests/test-applications/node-otel-sdk-node/package.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 change: 1 addition & 0 deletions
1
dev-packages/e2e-tests/test-applications/node-otel-without-tracing/.gitignore
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
dist |
2 changes: 2 additions & 0 deletions
2
dev-packages/e2e-tests/test-applications/node-otel-without-tracing/.npmrc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
@sentry:registry=http://127.0.0.1:4873 | ||
@sentry-internal:registry=http://127.0.0.1:4873 |
34 changes: 34 additions & 0 deletions
34
dev-packages/e2e-tests/test-applications/node-otel-without-tracing/package.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
{ | ||
"name": "node-otel-without-tracing", | ||
"version": "1.0.0", | ||
"private": true, | ||
"scripts": { | ||
"build": "tsc", | ||
"start": "node dist/app.js", | ||
"test": "playwright test", | ||
"clean": "npx rimraf node_modules pnpm-lock.yaml", | ||
"test:build": "pnpm install && pnpm build", | ||
"test:assert": "pnpm test" | ||
}, | ||
"dependencies": { | ||
"@opentelemetry/sdk-trace-node": "1.25.1", | ||
"@opentelemetry/exporter-trace-otlp-http": "0.52.1", | ||
"@opentelemetry/instrumentation-undici": "0.4.0", | ||
"@opentelemetry/instrumentation": "0.52.1", | ||
"@sentry/core": "latest || *", | ||
"@sentry/node": "latest || *", | ||
"@sentry/opentelemetry": "latest || *", | ||
"@sentry/types": "latest || *", | ||
"@types/express": "4.17.17", | ||
"@types/node": "18.15.1", | ||
"express": "4.19.2", | ||
"typescript": "4.9.5" | ||
}, | ||
"devDependencies": { | ||
"@playwright/test": "^1.44.1", | ||
"@sentry-internal/test-utils": "link:../../../test-utils" | ||
}, | ||
"volta": { | ||
"extends": "../../package.json" | ||
} | ||
} |
34 changes: 34 additions & 0 deletions
34
dev-packages/e2e-tests/test-applications/node-otel-without-tracing/playwright.config.mjs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
import { getPlaywrightConfig } from '@sentry-internal/test-utils'; | ||
|
||
const config = getPlaywrightConfig( | ||
{ | ||
startCommand: `pnpm start`, | ||
}, | ||
{ | ||
webServer: [ | ||
{ | ||
command: `node ./start-event-proxy.mjs`, | ||
port: 3031, | ||
stdout: 'pipe', | ||
stderr: 'pipe', | ||
}, | ||
{ | ||
command: `node ./start-otel-proxy.mjs`, | ||
port: 3032, | ||
stdout: 'pipe', | ||
stderr: 'pipe', | ||
}, | ||
{ | ||
command: 'pnpm start', | ||
port: 3030, | ||
stdout: 'pipe', | ||
stderr: 'pipe', | ||
env: { | ||
PORT: 3030, | ||
}, | ||
}, | ||
], | ||
}, | ||
); | ||
|
||
export default config; |
55 changes: 55 additions & 0 deletions
55
dev-packages/e2e-tests/test-applications/node-otel-without-tracing/src/app.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
import './instrument'; | ||
|
||
// Other imports below | ||
import * as Sentry from '@sentry/node'; | ||
import express from 'express'; | ||
|
||
const app = express(); | ||
const port = 3030; | ||
|
||
app.get('/test-success', function (req, res) { | ||
res.send({ version: 'v1' }); | ||
}); | ||
|
||
app.get('/test-param/:param', function (req, res) { | ||
res.send({ paramWas: req.params.param }); | ||
}); | ||
|
||
app.get('/test-transaction', function (req, res) { | ||
Sentry.withActiveSpan(null, async () => { | ||
Sentry.startSpan({ name: 'test-transaction', op: 'e2e-test' }, () => { | ||
Sentry.startSpan({ name: 'test-span' }, () => undefined); | ||
}); | ||
|
||
await fetch('http://localhost:3030/test-success'); | ||
|
||
await Sentry.flush(); | ||
|
||
res.send({}); | ||
}); | ||
}); | ||
|
||
app.get('/test-error', async function (req, res) { | ||
const exceptionId = Sentry.captureException(new Error('This is an error')); | ||
|
||
await Sentry.flush(2000); | ||
|
||
res.send({ exceptionId }); | ||
}); | ||
|
||
app.get('/test-exception/:id', function (req, _res) { | ||
throw new Error(`This is an exception with id ${req.params.id}`); | ||
}); | ||
|
||
Sentry.setupExpressErrorHandler(app); | ||
|
||
app.use(function onError(err: unknown, req: any, res: any, next: any) { | ||
// The error id is attached to `res.sentry` to be returned | ||
// and optionally displayed to the user for support. | ||
res.statusCode = 500; | ||
res.end(res.sentry + '\n'); | ||
}); | ||
|
||
app.listen(port, () => { | ||
console.log(`Example app listening on port ${port}`); | ||
}); |
41 changes: 41 additions & 0 deletions
41
dev-packages/e2e-tests/test-applications/node-otel-without-tracing/src/instrument.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
const { NodeTracerProvider, BatchSpanProcessor } = require('@opentelemetry/sdk-trace-node'); | ||
const { OTLPTraceExporter } = require('@opentelemetry/exporter-trace-otlp-http'); | ||
const Sentry = require('@sentry/node'); | ||
const { SentrySpanProcessor, SentryPropagator } = require('@sentry/opentelemetry'); | ||
const { UndiciInstrumentation } = require('@opentelemetry/instrumentation-undici'); | ||
const { registerInstrumentations } = require('@opentelemetry/instrumentation'); | ||
|
||
const sentryClient = Sentry.init({ | ||
environment: 'qa', // dynamic sampling bias to keep transactions | ||
dsn: | ||
process.env.E2E_TEST_DSN || | ||
'https://3b6c388182fb435097f41d181be2b2ba@o4504321058471936.ingest.sentry.io/4504321066008576', | ||
includeLocalVariables: true, | ||
debug: !!process.env.DEBUG, | ||
tunnel: `http://localhost:3031/`, // proxy server | ||
// Tracing is completely disabled | ||
|
||
// Custom OTEL setup | ||
skipOpenTelemetrySetup: true, | ||
}); | ||
|
||
// Create and configure NodeTracerProvider | ||
const provider = new NodeTracerProvider({}); | ||
|
||
provider.addSpanProcessor( | ||
new BatchSpanProcessor( | ||
new OTLPTraceExporter({ | ||
url: 'http://localhost:3032/', | ||
}), | ||
), | ||
); | ||
|
||
// Initialize the provider | ||
provider.register({ | ||
propagator: new SentryPropagator(), | ||
contextManager: new Sentry.SentryContextManager(), | ||
}); | ||
|
||
registerInstrumentations({ | ||
instrumentations: [new UndiciInstrumentation()], | ||
}); |
6 changes: 6 additions & 0 deletions
6
dev-packages/e2e-tests/test-applications/node-otel-without-tracing/start-event-proxy.mjs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
import { startEventProxyServer } from '@sentry-internal/test-utils'; | ||
|
||
startEventProxyServer({ | ||
port: 3031, | ||
proxyServerName: 'node-otel-without-tracing', | ||
}); |
6 changes: 6 additions & 0 deletions
6
dev-packages/e2e-tests/test-applications/node-otel-without-tracing/start-otel-proxy.mjs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
import { startProxyServer } from '@sentry-internal/test-utils'; | ||
|
||
startProxyServer({ | ||
port: 3032, | ||
proxyServerName: 'node-otel-without-tracing-otel', | ||
}); |
30 changes: 30 additions & 0 deletions
30
dev-packages/e2e-tests/test-applications/node-otel-without-tracing/tests/errors.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
import { expect, test } from '@playwright/test'; | ||
import { waitForError } from '@sentry-internal/test-utils'; | ||
|
||
test('Sends correct error event', async ({ baseURL }) => { | ||
const errorEventPromise = waitForError('node-otel-without-tracing', event => { | ||
return !event.type && event.exception?.values?.[0]?.value === 'This is an exception with id 123'; | ||
}); | ||
|
||
await fetch(`${baseURL}/test-exception/123`); | ||
|
||
const errorEvent = await errorEventPromise; | ||
|
||
expect(errorEvent.exception?.values).toHaveLength(1); | ||
expect(errorEvent.exception?.values?.[0]?.value).toBe('This is an exception with id 123'); | ||
|
||
expect(errorEvent.request).toEqual({ | ||
method: 'GET', | ||
cookies: {}, | ||
headers: expect.any(Object), | ||
url: 'http://localhost:3030/test-exception/123', | ||
}); | ||
|
||
// This is unparametrized here because we do not have the express instrumentation | ||
expect(errorEvent.transaction).toEqual('GET /test-exception/123'); | ||
|
||
expect(errorEvent.contexts?.trace).toEqual({ | ||
trace_id: expect.any(String), | ||
span_id: expect.any(String), | ||
}); | ||
}); |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
noticed this name was actually not consistent.