Skip to content

feat(server-utils): Migrate @opentelemetry/instrumentation-graphql to orchestrion #21885

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.

Sign up for GitHub

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

Draft
chargome wants to merge 3 commits into
base: develop
Choose a base branch
from
Draft

feat(server-utils): Migrate @opentelemetry/instrumentation-graphql to orchestrion #21885

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d2e1942
wip
chargome Jul 1, 2026
d573508
bugbot
chargome Jul 1, 2026
2f13aa2
fix(server-utils): Include current graphql operation in root span name
chargome Jul 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions dev-packages/node-integration-tests/suites/tracing/apollo-graphql/instrument-orchestrion.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// `Sentry.init()` swaps the OTel `Graphql` instrumentation for the
// diagnostics-channel one and synchronously installs the module hooks that
// inject the `orchestrion:graphql:{parse,validate,execute}` channels into
// `graphql`.
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.experimentalUseDiagnosticsChannelInjection();

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
tracesSampleRate: 1.0,
transport: loggingTransport,
});
268 changes: 142 additions & 126 deletions dev-packages/node-integration-tests/suites/tracing/apollo-graphql/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,151 +6,167 @@ const EXPECTED_START_SERVER_TRANSACTION = {
transaction: 'Test Server Start',
};

// The OTel and diagnostics-channel (orchestrion) instrumentations must produce identical spans — only
// the injection mechanism and the span origin differ. Each scenario runs against both, asserting the
// matching origin, so the orchestrion path is proven a drop-in replacement without duplicating cases.
const VARIANTS = [
{ label: 'otel', instrument: 'instrument.mjs', origin: 'auto.graphql.otel.graphql' },
{ label: 'orchestrion', instrument: 'instrument-orchestrion.mjs', origin: 'auto.graphql.orchestrion.graphql' },
] as const;

describe('GraphQL/Apollo Tests', () => {
afterAll(() => {
cleanupChildProcesses();
});

describe('query', () => {
const EXPECTED_TRANSACTION = {
transaction: 'Test Transaction (query)',
spans: expect.arrayContaining([
expect.objectContaining({
data: {
'graphql.operation.type': 'query',
'graphql.source': '{hello}',
'sentry.origin': 'auto.graphql.otel.graphql',
},
description: 'query',
status: 'ok',
origin: 'auto.graphql.otel.graphql',
}),
]),
};
for (const { label, instrument, origin } of VARIANTS) {
const EXPECTED_TRANSACTION = {
transaction: 'Test Transaction (query)',
spans: expect.arrayContaining([
expect.objectContaining({
data: {
'graphql.operation.type': 'query',
'graphql.source': '{hello}',
'sentry.origin': origin,
},
description: 'query',
status: 'ok',
origin,
}),
]),
};

createEsmAndCjsTests(
__dirname,
'scenario-query.mjs',
'instrument.mjs',
(createTestRunner, test) => {
test('should instrument GraphQL queries used from Apollo Server.', async () => {
await createTestRunner()
.expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
.expect({ transaction: EXPECTED_TRANSACTION })
.unordered()
.start()
.completed();
});
},
{ copyPaths: ['apollo-server.mjs'] },
);
createEsmAndCjsTests(
__dirname,
'scenario-query.mjs',
instrument,
(createTestRunner, test) => {
test(`should instrument GraphQL queries used from Apollo Server (${label}).`, async () => {
await createTestRunner()
.expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
.expect({ transaction: EXPECTED_TRANSACTION })
.unordered()
.start()
.completed();
});
},
{ copyPaths: ['apollo-server.mjs'] },
);
}
});

describe('mutation', () => {
const EXPECTED_TRANSACTION = {
transaction: 'Test Transaction (mutation Mutation)',
spans: expect.arrayContaining([
expect.objectContaining({
data: {
'graphql.operation.name': 'Mutation',
'graphql.operation.type': 'mutation',
'graphql.source': 'mutation Mutation($email: String) {\n login(email: $email)\n}',
'sentry.origin': 'auto.graphql.otel.graphql',
},
description: 'mutation Mutation',
status: 'ok',
origin: 'auto.graphql.otel.graphql',
}),
]),
};
for (const { label, instrument, origin } of VARIANTS) {
const EXPECTED_TRANSACTION = {
transaction: 'Test Transaction (mutation Mutation)',
spans: expect.arrayContaining([
expect.objectContaining({
data: {
'graphql.operation.name': 'Mutation',
'graphql.operation.type': 'mutation',
'graphql.source': 'mutation Mutation($email: String) {\n login(email: $email)\n}',
'sentry.origin': origin,
},
description: 'mutation Mutation',
status: 'ok',
origin,
}),
]),
};

createEsmAndCjsTests(
__dirname,
'scenario-mutation.mjs',
'instrument.mjs',
(createTestRunner, test) => {
test('should instrument GraphQL mutations used from Apollo Server.', async () => {
await createTestRunner()
.expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
.expect({ transaction: EXPECTED_TRANSACTION })
.unordered()
.start()
.completed();
});
},
{ copyPaths: ['apollo-server.mjs'] },
);
createEsmAndCjsTests(
__dirname,
'scenario-mutation.mjs',
instrument,
(createTestRunner, test) => {
test(`should instrument GraphQL mutations used from Apollo Server (${label}).`, async () => {
await createTestRunner()
.expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
.expect({ transaction: EXPECTED_TRANSACTION })
.unordered()
.start()
.completed();
});
},
{ copyPaths: ['apollo-server.mjs'] },
);
}
});

describe('redaction', () => {
const EXPECTED_TRANSACTION = {
transaction: 'Test Transaction (mutation)',
spans: expect.arrayContaining([
expect.objectContaining({
description: 'mutation',
status: 'ok',
origin: 'auto.graphql.otel.graphql',
data: expect.objectContaining({
'graphql.operation.type': 'mutation',
// The inline email literal must be redacted to `"*"`, so the raw value can never reach `graphql.source`.
'graphql.source': expect.stringContaining('login(email: "*")'),
'sentry.origin': 'auto.graphql.otel.graphql',
for (const { label, instrument, origin } of VARIANTS) {
const EXPECTED_TRANSACTION = {
transaction: 'Test Transaction (mutation)',
spans: expect.arrayContaining([
expect.objectContaining({
description: 'mutation',
status: 'ok',
origin,
data: expect.objectContaining({
'graphql.operation.type': 'mutation',
// The inline email literal must be redacted to `"*"`, so the raw value can never reach `graphql.source`.
'graphql.source': expect.stringContaining('login(email: "*")'),
'sentry.origin': origin,
}),
}),
}),
]),
};
]),
};

createEsmAndCjsTests(
__dirname,
'scenario-redaction.mjs',
'instrument.mjs',
(createTestRunner, test) => {
test('redacts inline literal values from graphql.source.', async () => {
await createTestRunner()
.expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
.expect({ transaction: EXPECTED_TRANSACTION })
.unordered()
.start()
.completed();
});
},
{ copyPaths: ['apollo-server.mjs'] },
);
createEsmAndCjsTests(
__dirname,
'scenario-redaction.mjs',
instrument,
(createTestRunner, test) => {
test(`redacts inline literal values from graphql.source (${label}).`, async () => {
await createTestRunner()
.expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
.expect({ transaction: EXPECTED_TRANSACTION })
.unordered()
.start()
.completed();
});
},
{ copyPaths: ['apollo-server.mjs'] },
);
}
});

describe('error', () => {
const EXPECTED_TRANSACTION = {
transaction: 'Test Transaction (mutation Mutation)',
spans: expect.arrayContaining([
expect.objectContaining({
data: {
'graphql.operation.name': 'Mutation',
'graphql.operation.type': 'mutation',
'graphql.source': 'mutation Mutation($email: String) {\n login(email: $email)\n}',
'sentry.origin': 'auto.graphql.otel.graphql',
},
description: 'mutation Mutation',
status: 'internal_error',
origin: 'auto.graphql.otel.graphql',
}),
]),
};
for (const { label, instrument, origin } of VARIANTS) {
const EXPECTED_TRANSACTION = {
transaction: 'Test Transaction (mutation Mutation)',
spans: expect.arrayContaining([
expect.objectContaining({
data: {
'graphql.operation.name': 'Mutation',
'graphql.operation.type': 'mutation',
'graphql.source': 'mutation Mutation($email: String) {\n login(email: $email)\n}',
'sentry.origin': origin,
},
description: 'mutation Mutation',
status: 'internal_error',
origin,
}),
]),
};

createEsmAndCjsTests(
__dirname,
'scenario-error.mjs',
'instrument.mjs',
(createTestRunner, test) => {
test('should handle GraphQL errors.', async () => {
await createTestRunner()
.expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
.expect({ transaction: EXPECTED_TRANSACTION })
.unordered()
.start()
.completed();
});
},
{ copyPaths: ['apollo-server.mjs'] },
);
createEsmAndCjsTests(
__dirname,
'scenario-error.mjs',
instrument,
(createTestRunner, test) => {
test(`should handle GraphQL errors (${label}).`, async () => {
await createTestRunner()
.expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
.expect({ transaction: EXPECTED_TRANSACTION })
.unordered()
.start()
.completed();
});
},
{ copyPaths: ['apollo-server.mjs'] },
);
}
});
});
Loading
Loading