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

Merged
chargome merged 10 commits into from
Jul 9, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
21acce6
feat(server-utils): Migrate `@opentelemetry/instrumentation-graphql` …
chargome Jul 6, 2026
e573fe3
Merge branch 'develop' into cg/orchestrion-graphql
chargome Jul 7, 2026
fdb5cdb
comments
chargome Jul 7, 2026
f55fe03
Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…
chargome Jul 8, 2026
5d25505
ref(server-utils): Align orchestrion graphql with the native subscrib…
chargome Jul 8, 2026
9d96ebd
Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…
chargome Jul 8, 2026
60f0f90
Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…
chargome Jul 8, 2026
77c5ce8
size
chargome Jul 8, 2026
b5a9b27
pr feedback
chargome Jul 8, 2026
e2776ec
Merge branch 'develop' into cg/orchestrion-graphql
chargome Jul 9, 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
2 changes: 1 addition & 1 deletion .size-limit.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -400,7 +400,7 @@ module.exports = [
import: createImport('init', 'experimentalUseDiagnosticsChannelInjection'),
ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
gzip: true,
limit: '136 KB',
limit: '140 KB',
disablePlugins: ['@size-limit/esbuild'],
},
{
Expand Down
16 changes: 16 additions & 0 deletions ...packages/node-integration-tests/suites/tracing/apollo-graphql/resolvers/instrument-dc.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

// Configure graphql on the diagnostics-channel injection path: opt in, then pass the matching
// `diagnosticsChannelInjectionIntegrations()` entry explicitly so its options (here
// `ignoreResolveSpans: false`) apply. This explicit instance wins over the default one the opt-in swaps in.
const { graphqlIntegration } = Sentry.diagnosticsChannelInjectionIntegrations();
Sentry.experimentalUseDiagnosticsChannelInjection();

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
tracesSampleRate: 1.0,
integrations: [graphqlIntegration({ ignoreResolveSpans: false })],
transport: loggingTransport,
});
39 changes: 39 additions & 0 deletions dev-packages/node-integration-tests/suites/tracing/apollo-graphql/resolvers/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,4 +49,43 @@ describe('GraphQL/Apollo Tests > resolve spans', () => {
.completed();
});
});

// Same behavior on the diagnostics-channel path: passing the channel integration explicitly (see
// instrument-dc.mjs) must carry `ignoreResolveSpans: false` through — the explicit instance wins over
// the swapped-in default — and emit resolve spans with the orchestrion origin.
const EXPECTED_ORCHESTRION_TRANSACTION = {
transaction: 'Test Transaction (query)',
spans: expect.arrayContaining([
expect.objectContaining({
description: 'query',
origin: 'auto.graphql.diagnostic_channel',
data: expect.objectContaining({
'graphql.operation.type': 'query',
'graphql.document': '{hello}',
'sentry.origin': 'auto.graphql.diagnostic_channel',
}),
}),
expect.objectContaining({ description: 'graphql.parse' }),
expect.objectContaining({ description: 'graphql.validate' }),
expect.objectContaining({
description: 'graphql.resolve hello',
data: expect.objectContaining({
'graphql.field.name': 'hello',
'graphql.field.path': 'hello',
'graphql.field.type': 'String',
'graphql.parent.name': 'Query',
}),
}),
]),
};

createEsmAndCjsTests(__dirname, 'scenario-query.mjs', 'instrument-dc.mjs', (createTestRunner, test) => {
test('emits resolve spans via diagnostics-channel injection when configured explicitly', async () => {
await createTestRunner()
.expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
.expect({ transaction: EXPECTED_ORCHESTRION_TRANSACTION })
.start()
.completed();
});
});
});
79 changes: 42 additions & 37 deletions dev-packages/node-integration-tests/suites/tracing/apollo-graphql/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,39 @@
import { afterAll, describe, expect } from 'vitest';
import { isOrchestrionEnabled } from '../../../utils';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

// Server start transaction (Apollo Server v5 no longer runs introspection query on start)
const EXPECTED_START_SERVER_TRANSACTION = {
transaction: 'Test Server Start',
};

// apollo uses graphql v16, so the default run instruments it via the vendored OTel patcher and the
// orchestrion run (auto-injected on CI) via the diagnostics-channel path. Both emit the same span
// name/status; the origin and the document attribute (`graphql.source` vs `graphql.document`) differ.
const orchestrion = isOrchestrionEnabled();
const ORIGIN = orchestrion ? 'auto.graphql.diagnostic_channel' : 'auto.graphql.otel.graphql';

function graphqlExecuteSpan(opts: {
description: string;
operationType: string;
operationName?: string;
document: unknown;
status?: string;
}): ReturnType<typeof expect.objectContaining> {
const { description, operationType, operationName, document, status = 'ok' } = opts;
return expect.objectContaining({
description,
status,
origin: ORIGIN,
data: expect.objectContaining({
'graphql.operation.type': operationType,
...(operationName ? { 'graphql.operation.name': operationName } : {}),
[orchestrion ? 'graphql.document' : 'graphql.source']: document,
'sentry.origin': ORIGIN,
}),
});
}

describe('GraphQL/Apollo Tests', () => {
afterAll(() => {
cleanupChildProcesses();
Expand All@@ -15,16 +43,7 @@ describe('GraphQL/Apollo Tests', () => {
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',
}),
graphqlExecuteSpan({ description: 'query', operationType: 'query', document: '{hello}' }),
]),
};

Expand All@@ -50,16 +69,11 @@ describe('GraphQL/Apollo Tests', () => {
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',
},
graphqlExecuteSpan({
description: 'mutation Mutation',
status: 'ok',
origin: 'auto.graphql.otel.graphql',
operationType: 'mutation',
operationName: 'Mutation',
document: 'mutation Mutation($email: String) {\n login(email: $email)\n}',
}),
]),
};
Expand All@@ -86,16 +100,11 @@ describe('GraphQL/Apollo Tests', () => {
const EXPECTED_TRANSACTION = {
transaction: 'Test Transaction (mutation)',
spans: expect.arrayContaining([
expect.objectContaining({
// The inline email literal must be redacted to `"*"`, so the raw value never reaches the span.
graphqlExecuteSpan({
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',
}),
operationType: 'mutation',
document: expect.stringContaining('login(email: "*")'),
}),
]),
};
Expand All@@ -105,7 +114,7 @@ describe('GraphQL/Apollo Tests', () => {
'scenario-redaction.mjs',
'instrument.mjs',
(createTestRunner, test) => {
test('redacts inline literal values from graphql.source.', async () => {
test('redacts inline literal values from the graphql document.', async () => {
await createTestRunner()
.expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
.expect({ transaction: EXPECTED_TRANSACTION })
Expand All@@ -122,16 +131,12 @@ describe('GraphQL/Apollo Tests', () => {
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',
},
graphqlExecuteSpan({
description: 'mutation Mutation',
operationType: 'mutation',
operationName: 'Mutation',
document: 'mutation Mutation($email: String) {\n login(email: $email)\n}',
status: 'internal_error',
origin: 'auto.graphql.otel.graphql',
}),
]),
};
Expand Down
178 changes: 26 additions & 152 deletions packages/node/src/integrations/tracing/graphql/vendored/graphql-types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,152 +1,26 @@
/*
* Simplified types inlined from the `graphql` package.
* Only includes members accessed by this instrumentation.
*/

export type PromiseOrValue<T> = T | Promise<T>;

export type Maybe<T> = null | undefined | T;

export interface Location {
start: number;
end: number;
startToken: Token;
source: Source;
[key: string]: any;
}

export interface Token {
kind: string;
start: number;
end: number;
line: number;
column: number;
value: string;
prev: Token | null;
next: Token | null;
[key: string]: any;
}

export interface Source {
body: string;
name: string;
locationOffset: Location;
[key: string]: any;
}

export interface DocumentNode {
kind: string;
definitions: ReadonlyArray<DefinitionNode>;
loc?: Location;
[key: string]: any;
}

export interface DefinitionNode {
kind: string;
loc?: Location;
[key: string]: any;
}

export interface OperationDefinitionNode extends DefinitionNode {
operation: string;
name?: { kind: string; value: string; loc?: Location };
[key: string]: any;
}

export interface ParseOptions {
noLocation?: boolean;
[key: string]: any;
}

export interface ExecutionArgs {
schema: GraphQLSchema;
document: DocumentNode;
rootValue?: any;
contextValue?: any;
variableValues?: Maybe<{ [key: string]: any }>;
operationName?: Maybe<string>;
fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
typeResolver?: Maybe<GraphQLTypeResolver<any, any>>;
[key: string]: any;
}

export interface ExecutionResult {
errors?: ReadonlyArray<GraphQLError>;
data?: Record<string, any> | null;
[key: string]: any;
}

export interface GraphQLError {
message: string;
locations?: ReadonlyArray<{ line: number; column: number }>;
path?: ReadonlyArray<string | number>;
[key: string]: any;
}

export interface GraphQLSchema {
getQueryType(): GraphQLObjectType | undefined | null;
getMutationType(): GraphQLObjectType | undefined | null;
[key: string]: any;
}

export interface GraphQLObjectType {
name: string;
getFields(): { [key: string]: GraphQLField };
[key: string]: any;
}

export interface GraphQLField {
name: string;
type: GraphQLOutputType;
resolve?: GraphQLFieldResolver<any, any>;
[key: string]: any;
}

export type GraphQLOutputType = GraphQLNamedOutputType | GraphQLWrappingType;

interface GraphQLNamedOutputType {
name: string;
[key: string]: any;
}

interface GraphQLWrappingType {
ofType: GraphQLOutputType;
[key: string]: any;
}

export interface GraphQLUnionType {
name: string;
getTypes(): ReadonlyArray<GraphQLObjectType>;
[key: string]: any;
}

export type GraphQLType = GraphQLOutputType | GraphQLUnionType;

export type GraphQLFieldResolver<TSource, TContext, TArgs = any> = (
source: TSource,
args: TArgs,
context: TContext,
info: GraphQLResolveInfo,
) => any;

export type GraphQLTypeResolver<TSource, TContext> = (
value: TSource,
context: TContext,
info: GraphQLResolveInfo,
abstractType: any,
) => any;

export interface GraphQLResolveInfo {
fieldName: string;
fieldNodes: ReadonlyArray<{ kind: string; loc?: Location; [key: string]: any }>;
returnType: { toString(): string; [key: string]: any };
parentType: { name: string; [key: string]: any };
path: any;
[key: string]: any;
}

export type ValidationRule = any;

export interface TypeInfo {
[key: string]: any;
}
// Single source of truth for the structural graphql types, shared with the orchestrion graphql
// integration in `@sentry/server-utils` so the two can't drift.
export type {
DefinitionNode,
DocumentNode,
ExecutionArgs,
ExecutionResult,
GraphQLError,
GraphQLFieldResolver,
GraphQLObjectType,
GraphQLOutputType,
GraphQLResolveInfo,
GraphQLSchema,
GraphQLType,
GraphQLTypeResolver,
GraphQLUnionType,
Location,
Maybe,
OperationDefinitionNode,
ParseOptions,
PromiseOrValue,
Source,
Token,
TypeInfo,
ValidationRule,
} from '@sentry/server-utils/orchestrion';
2 changes: 1 addition & 1 deletion packages/node/src/integrations/tracing/graphql/vendored/instrumentation.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -367,7 +367,7 @@ export class GraphQLInstrumentation extends InstrumentationBase<GraphQLInstrumen
});
}

private _createExecuteSpan(operation: DefinitionNode | undefined, processedArgs: ExecutionArgs): Span {
private _createExecuteSpan(operation: DefinitionNode | undefined, processedArgs: OtelExecutionArgs): Span {
const span = startInactiveSpan({
name: SpanNames.EXECUTE,
attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN },
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

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

 Merged

chargome
merged 10 commits into

from

Jul 9, 2026
 Merged


feat(server-utils): Migrate @opentelemetry/instrumentation-graphql to orchestrion
#21885
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
21acce6

feat(server-utils): Migrate `@opentelemetry/instrumentation-graphql` …


chargome Jul 6, 2026
e573fe3

Merge branch 'develop' into cg/orchestrion-graphql


chargome Jul 7, 2026
fdb5cdb

comments


chargome Jul 7, 2026
f55fe03

Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…


chargome Jul 8, 2026
5d25505

ref(server-utils): Align orchestrion graphql with the native subscrib…


chargome Jul 8, 2026
9d96ebd

Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…


chargome Jul 8, 2026
60f0f90

Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…


chargome Jul 8, 2026
77c5ce8

size


chargome Jul 8, 2026
b5a9b27

pr feedback


chargome Jul 8, 2026
e2776ec

Merge branch 'develop' into cg/orchestrion-graphql


chargome Jul 9, 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


2 changes: 1 addition & 1 deletion
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -400,7 +400,7 @@ module.exports = [
 import: createImport('init', 'experimentalUseDiagnosticsChannelInjection'),
 ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
 gzip: true,
 limit: '136 KB',
 limit: '140 KB',
 disablePlugins: ['@size-limit/esbuild'],
 },
 {
Expand Down

16 changes: 16 additions & 0 deletions
...packages/node-integration-tests/suites/tracing/apollo-graphql/resolvers/instrument-dc.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

// Configure graphql on the diagnostics-channel injection path: opt in, then pass the matching
// `diagnosticsChannelInjectionIntegrations()` entry explicitly so its options (here
// `ignoreResolveSpans: false`) apply. This explicit instance wins over the default one the opt-in swaps in.
const { graphqlIntegration } = Sentry.diagnosticsChannelInjectionIntegrations();
Sentry.experimentalUseDiagnosticsChannelInjection();

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 tracesSampleRate: 1.0,
 integrations: [graphqlIntegration({ ignoreResolveSpans: false })],
 transport: loggingTransport,
});

39 changes: 39 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/apollo-graphql/resolvers/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,4 +49,43 @@ describe('GraphQL/Apollo Tests > resolve spans', () => {
 .completed();
 });
 });

 // Same behavior on the diagnostics-channel path: passing the channel integration explicitly (see
 // instrument-dc.mjs) must carry `ignoreResolveSpans: false` through — the explicit instance wins over
 // the swapped-in default — and emit resolve spans with the orchestrion origin.
 const EXPECTED_ORCHESTRION_TRANSACTION = {
 transaction: 'Test Transaction (query)',
 spans: expect.arrayContaining([
 expect.objectContaining({
 description: 'query',
 origin: 'auto.graphql.diagnostic_channel',
 data: expect.objectContaining({
 'graphql.operation.type': 'query',
 'graphql.document': '{hello}',
 'sentry.origin': 'auto.graphql.diagnostic_channel',
 }),
 }),
 expect.objectContaining({ description: 'graphql.parse' }),
 expect.objectContaining({ description: 'graphql.validate' }),
 expect.objectContaining({
 description: 'graphql.resolve hello',
 data: expect.objectContaining({
 'graphql.field.name': 'hello',
 'graphql.field.path': 'hello',
 'graphql.field.type': 'String',
 'graphql.parent.name': 'Query',
 }),
 }),
 ]),
 };

 createEsmAndCjsTests(__dirname, 'scenario-query.mjs', 'instrument-dc.mjs', (createTestRunner, test) => {
 test('emits resolve spans via diagnostics-channel injection when configured explicitly', async () => {
 await createTestRunner()
 .expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
 .expect({ transaction: EXPECTED_ORCHESTRION_TRANSACTION })
 .start()
 .completed();
 });
 });
});

79 changes: 42 additions & 37 deletions
dev-packages/node-integration-tests/suites/tracing/apollo-graphql/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,39 @@
import { afterAll, describe, expect } from 'vitest';
import { isOrchestrionEnabled } from '../../../utils';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

// Server start transaction (Apollo Server v5 no longer runs introspection query on start)
const EXPECTED_START_SERVER_TRANSACTION = {
 transaction: 'Test Server Start',
};

// apollo uses graphql v16, so the default run instruments it via the vendored OTel patcher and the
// orchestrion run (auto-injected on CI) via the diagnostics-channel path. Both emit the same span
// name/status; the origin and the document attribute (`graphql.source` vs `graphql.document`) differ.
const orchestrion = isOrchestrionEnabled();
const ORIGIN = orchestrion ? 'auto.graphql.diagnostic_channel' : 'auto.graphql.otel.graphql';

function graphqlExecuteSpan(opts: {
 description: string;
 operationType: string;
 operationName?: string;
 document: unknown;
 status?: string;
}): ReturnType<typeof expect.objectContaining> {
 const { description, operationType, operationName, document, status = 'ok' } = opts;
 return expect.objectContaining({
 description,
 status,
 origin: ORIGIN,
 data: expect.objectContaining({
 'graphql.operation.type': operationType,
 ...(operationName ? { 'graphql.operation.name': operationName } : {}),
 [orchestrion ? 'graphql.document' : 'graphql.source']: document,
 'sentry.origin': ORIGIN,
 }),
 });
}

describe('GraphQL/Apollo Tests', () => {
 afterAll(() => {
 cleanupChildProcesses();
Expand All@@ -15,16 +43,7 @@ describe('GraphQL/Apollo Tests', () => {
 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',
 }),
 graphqlExecuteSpan({ description: 'query', operationType: 'query', document: '{hello}' }),
 ]),
 };

Expand All@@ -50,16 +69,11 @@ describe('GraphQL/Apollo Tests', () => {
 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',
 },
 graphqlExecuteSpan({
 description: 'mutation Mutation',
 status: 'ok',
 origin: 'auto.graphql.otel.graphql',
 operationType: 'mutation',
 operationName: 'Mutation',
 document: 'mutation Mutation($email: String) {\n login(email: $email)\n}',
 }),
 ]),
 };
Expand All@@ -86,16 +100,11 @@ describe('GraphQL/Apollo Tests', () => {
 const EXPECTED_TRANSACTION = {
 transaction: 'Test Transaction (mutation)',
 spans: expect.arrayContaining([
 expect.objectContaining({
 // The inline email literal must be redacted to `"*"`, so the raw value never reaches the span.
 graphqlExecuteSpan({
 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',
 }),
 operationType: 'mutation',
 document: expect.stringContaining('login(email: "*")'),
 }),
 ]),
 };
Expand All@@ -105,7 +114,7 @@ describe('GraphQL/Apollo Tests', () => {
 'scenario-redaction.mjs',
 'instrument.mjs',
 (createTestRunner, test) => {
 test('redacts inline literal values from graphql.source.', async () => {
 test('redacts inline literal values from the graphql document.', async () => {
 await createTestRunner()
 .expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
 .expect({ transaction: EXPECTED_TRANSACTION })
Expand All@@ -122,16 +131,12 @@ describe('GraphQL/Apollo Tests', () => {
 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',
 },
 graphqlExecuteSpan({
 description: 'mutation Mutation',
 operationType: 'mutation',
 operationName: 'Mutation',
 document: 'mutation Mutation($email: String) {\n login(email: $email)\n}',
 status: 'internal_error',
 origin: 'auto.graphql.otel.graphql',
 }),
 ]),
 };
Expand Down

178 changes: 26 additions & 152 deletions
packages/node/src/integrations/tracing/graphql/vendored/graphql-types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,152 +1,26 @@
/*
 * Simplified types inlined from the `graphql` package.
 * Only includes members accessed by this instrumentation.
 */

export type PromiseOrValue<T> = T | Promise<T>;

export type Maybe<T> = null | undefined | T;

export interface Location {
 start: number;
 end: number;
 startToken: Token;
 source: Source;
 [key: string]: any;
}

export interface Token {
 kind: string;
 start: number;
 end: number;
 line: number;
 column: number;
 value: string;
 prev: Token | null;
 next: Token | null;
 [key: string]: any;
}

export interface Source {
 body: string;
 name: string;
 locationOffset: Location;
 [key: string]: any;
}

export interface DocumentNode {
 kind: string;
 definitions: ReadonlyArray<DefinitionNode>;
 loc?: Location;
 [key: string]: any;
}

export interface DefinitionNode {
 kind: string;
 loc?: Location;
 [key: string]: any;
}

export interface OperationDefinitionNode extends DefinitionNode {
 operation: string;
 name?: { kind: string; value: string; loc?: Location };
 [key: string]: any;
}

export interface ParseOptions {
 noLocation?: boolean;
 [key: string]: any;
}

export interface ExecutionArgs {
 schema: GraphQLSchema;
 document: DocumentNode;
 rootValue?: any;
 contextValue?: any;
 variableValues?: Maybe<{ [key: string]: any }>;
 operationName?: Maybe<string>;
 fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
 typeResolver?: Maybe<GraphQLTypeResolver<any, any>>;
 [key: string]: any;
}

export interface ExecutionResult {
 errors?: ReadonlyArray<GraphQLError>;
 data?: Record<string, any> | null;
 [key: string]: any;
}

export interface GraphQLError {
 message: string;
 locations?: ReadonlyArray<{ line: number; column: number }>;
 path?: ReadonlyArray<string | number>;
 [key: string]: any;
}

export interface GraphQLSchema {
 getQueryType(): GraphQLObjectType | undefined | null;
 getMutationType(): GraphQLObjectType | undefined | null;
 [key: string]: any;
}

export interface GraphQLObjectType {
 name: string;
 getFields(): { [key: string]: GraphQLField };
 [key: string]: any;
}

export interface GraphQLField {
 name: string;
 type: GraphQLOutputType;
 resolve?: GraphQLFieldResolver<any, any>;
 [key: string]: any;
}

export type GraphQLOutputType = GraphQLNamedOutputType | GraphQLWrappingType;

interface GraphQLNamedOutputType {
 name: string;
 [key: string]: any;
}

interface GraphQLWrappingType {
 ofType: GraphQLOutputType;
 [key: string]: any;
}

export interface GraphQLUnionType {
 name: string;
 getTypes(): ReadonlyArray<GraphQLObjectType>;
 [key: string]: any;
}

export type GraphQLType = GraphQLOutputType | GraphQLUnionType;

export type GraphQLFieldResolver<TSource, TContext, TArgs = any> = (
 source: TSource,
 args: TArgs,
 context: TContext,
 info: GraphQLResolveInfo,
) => any;

export type GraphQLTypeResolver<TSource, TContext> = (
 value: TSource,
 context: TContext,
 info: GraphQLResolveInfo,
 abstractType: any,
) => any;

export interface GraphQLResolveInfo {
 fieldName: string;
 fieldNodes: ReadonlyArray<{ kind: string; loc?: Location; [key: string]: any }>;
 returnType: { toString(): string; [key: string]: any };
 parentType: { name: string; [key: string]: any };
 path: any;
 [key: string]: any;
}

export type ValidationRule = any;

export interface TypeInfo {
 [key: string]: any;
}
// Single source of truth for the structural graphql types, shared with the orchestrion graphql
// integration in `@sentry/server-utils` so the two can't drift.
export type {
 DefinitionNode,
 DocumentNode,
 ExecutionArgs,
 ExecutionResult,
 GraphQLError,
 GraphQLFieldResolver,
 GraphQLObjectType,
 GraphQLOutputType,
 GraphQLResolveInfo,
 GraphQLSchema,
 GraphQLType,
 GraphQLTypeResolver,
 GraphQLUnionType,
 Location,
 Maybe,
 OperationDefinitionNode,
 ParseOptions,
 PromiseOrValue,
 Source,
 Token,
 TypeInfo,
 ValidationRule,
} from '@sentry/server-utils/orchestrion';

2 changes: 1 addition & 1 deletion
packages/node/src/integrations/tracing/graphql/vendored/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -367,7 +367,7 @@ export class GraphQLInstrumentation extends InstrumentationBase<GraphQLInstrumen
 });
 }

 private _createExecuteSpan(operation: DefinitionNode | undefined, processedArgs: ExecutionArgs): Span {
 private _createExecuteSpan(operation: DefinitionNode | undefined, processedArgs: OtelExecutionArgs): Span {
 const span = startInactiveSpan({
 name: SpanNames.EXECUTE,
 attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN },
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

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

 Merged

chargome
merged 10 commits into

from

Jul 9, 2026
 Merged


feat(server-utils): Migrate @opentelemetry/instrumentation-graphql to orchestrion
#21885
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
21acce6

feat(server-utils): Migrate `@opentelemetry/instrumentation-graphql` …


chargome Jul 6, 2026
e573fe3

Merge branch 'develop' into cg/orchestrion-graphql


chargome Jul 7, 2026
fdb5cdb

comments


chargome Jul 7, 2026
f55fe03

Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…


chargome Jul 8, 2026
5d25505

ref(server-utils): Align orchestrion graphql with the native subscrib…


chargome Jul 8, 2026
9d96ebd

Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…


chargome Jul 8, 2026
60f0f90

Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…


chargome Jul 8, 2026
77c5ce8

size


chargome Jul 8, 2026
b5a9b27

pr feedback


chargome Jul 8, 2026
e2776ec

Merge branch 'develop' into cg/orchestrion-graphql


chargome Jul 9, 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


2 changes: 1 addition & 1 deletion
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -400,7 +400,7 @@ module.exports = [
 import: createImport('init', 'experimentalUseDiagnosticsChannelInjection'),
 ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
 gzip: true,
 limit: '136 KB',
 limit: '140 KB',
 disablePlugins: ['@size-limit/esbuild'],
 },
 {
Expand Down

16 changes: 16 additions & 0 deletions
...packages/node-integration-tests/suites/tracing/apollo-graphql/resolvers/instrument-dc.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

// Configure graphql on the diagnostics-channel injection path: opt in, then pass the matching
// `diagnosticsChannelInjectionIntegrations()` entry explicitly so its options (here
// `ignoreResolveSpans: false`) apply. This explicit instance wins over the default one the opt-in swaps in.
const { graphqlIntegration } = Sentry.diagnosticsChannelInjectionIntegrations();
Sentry.experimentalUseDiagnosticsChannelInjection();

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 tracesSampleRate: 1.0,
 integrations: [graphqlIntegration({ ignoreResolveSpans: false })],
 transport: loggingTransport,
});

39 changes: 39 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/apollo-graphql/resolvers/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,4 +49,43 @@ describe('GraphQL/Apollo Tests > resolve spans', () => {
 .completed();
 });
 });

 // Same behavior on the diagnostics-channel path: passing the channel integration explicitly (see
 // instrument-dc.mjs) must carry `ignoreResolveSpans: false` through — the explicit instance wins over
 // the swapped-in default — and emit resolve spans with the orchestrion origin.
 const EXPECTED_ORCHESTRION_TRANSACTION = {
 transaction: 'Test Transaction (query)',
 spans: expect.arrayContaining([
 expect.objectContaining({
 description: 'query',
 origin: 'auto.graphql.diagnostic_channel',
 data: expect.objectContaining({
 'graphql.operation.type': 'query',
 'graphql.document': '{hello}',
 'sentry.origin': 'auto.graphql.diagnostic_channel',
 }),
 }),
 expect.objectContaining({ description: 'graphql.parse' }),
 expect.objectContaining({ description: 'graphql.validate' }),
 expect.objectContaining({
 description: 'graphql.resolve hello',
 data: expect.objectContaining({
 'graphql.field.name': 'hello',
 'graphql.field.path': 'hello',
 'graphql.field.type': 'String',
 'graphql.parent.name': 'Query',
 }),
 }),
 ]),
 };

 createEsmAndCjsTests(__dirname, 'scenario-query.mjs', 'instrument-dc.mjs', (createTestRunner, test) => {
 test('emits resolve spans via diagnostics-channel injection when configured explicitly', async () => {
 await createTestRunner()
 .expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
 .expect({ transaction: EXPECTED_ORCHESTRION_TRANSACTION })
 .start()
 .completed();
 });
 });
});

79 changes: 42 additions & 37 deletions
dev-packages/node-integration-tests/suites/tracing/apollo-graphql/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,39 @@
import { afterAll, describe, expect } from 'vitest';
import { isOrchestrionEnabled } from '../../../utils';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

// Server start transaction (Apollo Server v5 no longer runs introspection query on start)
const EXPECTED_START_SERVER_TRANSACTION = {
 transaction: 'Test Server Start',
};

// apollo uses graphql v16, so the default run instruments it via the vendored OTel patcher and the
// orchestrion run (auto-injected on CI) via the diagnostics-channel path. Both emit the same span
// name/status; the origin and the document attribute (`graphql.source` vs `graphql.document`) differ.
const orchestrion = isOrchestrionEnabled();
const ORIGIN = orchestrion ? 'auto.graphql.diagnostic_channel' : 'auto.graphql.otel.graphql';

function graphqlExecuteSpan(opts: {
 description: string;
 operationType: string;
 operationName?: string;
 document: unknown;
 status?: string;
}): ReturnType<typeof expect.objectContaining> {
 const { description, operationType, operationName, document, status = 'ok' } = opts;
 return expect.objectContaining({
 description,
 status,
 origin: ORIGIN,
 data: expect.objectContaining({
 'graphql.operation.type': operationType,
 ...(operationName ? { 'graphql.operation.name': operationName } : {}),
 [orchestrion ? 'graphql.document' : 'graphql.source']: document,
 'sentry.origin': ORIGIN,
 }),
 });
}

describe('GraphQL/Apollo Tests', () => {
 afterAll(() => {
 cleanupChildProcesses();
Expand All@@ -15,16 +43,7 @@ describe('GraphQL/Apollo Tests', () => {
 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',
 }),
 graphqlExecuteSpan({ description: 'query', operationType: 'query', document: '{hello}' }),
 ]),
 };

Expand All@@ -50,16 +69,11 @@ describe('GraphQL/Apollo Tests', () => {
 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',
 },
 graphqlExecuteSpan({
 description: 'mutation Mutation',
 status: 'ok',
 origin: 'auto.graphql.otel.graphql',
 operationType: 'mutation',
 operationName: 'Mutation',
 document: 'mutation Mutation($email: String) {\n login(email: $email)\n}',
 }),
 ]),
 };
Expand All@@ -86,16 +100,11 @@ describe('GraphQL/Apollo Tests', () => {
 const EXPECTED_TRANSACTION = {
 transaction: 'Test Transaction (mutation)',
 spans: expect.arrayContaining([
 expect.objectContaining({
 // The inline email literal must be redacted to `"*"`, so the raw value never reaches the span.
 graphqlExecuteSpan({
 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',
 }),
 operationType: 'mutation',
 document: expect.stringContaining('login(email: "*")'),
 }),
 ]),
 };
Expand All@@ -105,7 +114,7 @@ describe('GraphQL/Apollo Tests', () => {
 'scenario-redaction.mjs',
 'instrument.mjs',
 (createTestRunner, test) => {
 test('redacts inline literal values from graphql.source.', async () => {
 test('redacts inline literal values from the graphql document.', async () => {
 await createTestRunner()
 .expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
 .expect({ transaction: EXPECTED_TRANSACTION })
Expand All@@ -122,16 +131,12 @@ describe('GraphQL/Apollo Tests', () => {
 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',
 },
 graphqlExecuteSpan({
 description: 'mutation Mutation',
 operationType: 'mutation',
 operationName: 'Mutation',
 document: 'mutation Mutation($email: String) {\n login(email: $email)\n}',
 status: 'internal_error',
 origin: 'auto.graphql.otel.graphql',
 }),
 ]),
 };
Expand Down

178 changes: 26 additions & 152 deletions
packages/node/src/integrations/tracing/graphql/vendored/graphql-types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,152 +1,26 @@
/*
 * Simplified types inlined from the `graphql` package.
 * Only includes members accessed by this instrumentation.
 */

export type PromiseOrValue<T> = T | Promise<T>;

export type Maybe<T> = null | undefined | T;

export interface Location {
 start: number;
 end: number;
 startToken: Token;
 source: Source;
 [key: string]: any;
}

export interface Token {
 kind: string;
 start: number;
 end: number;
 line: number;
 column: number;
 value: string;
 prev: Token | null;
 next: Token | null;
 [key: string]: any;
}

export interface Source {
 body: string;
 name: string;
 locationOffset: Location;
 [key: string]: any;
}

export interface DocumentNode {
 kind: string;
 definitions: ReadonlyArray<DefinitionNode>;
 loc?: Location;
 [key: string]: any;
}

export interface DefinitionNode {
 kind: string;
 loc?: Location;
 [key: string]: any;
}

export interface OperationDefinitionNode extends DefinitionNode {
 operation: string;
 name?: { kind: string; value: string; loc?: Location };
 [key: string]: any;
}

export interface ParseOptions {
 noLocation?: boolean;
 [key: string]: any;
}

export interface ExecutionArgs {
 schema: GraphQLSchema;
 document: DocumentNode;
 rootValue?: any;
 contextValue?: any;
 variableValues?: Maybe<{ [key: string]: any }>;
 operationName?: Maybe<string>;
 fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
 typeResolver?: Maybe<GraphQLTypeResolver<any, any>>;
 [key: string]: any;
}

export interface ExecutionResult {
 errors?: ReadonlyArray<GraphQLError>;
 data?: Record<string, any> | null;
 [key: string]: any;
}

export interface GraphQLError {
 message: string;
 locations?: ReadonlyArray<{ line: number; column: number }>;
 path?: ReadonlyArray<string | number>;
 [key: string]: any;
}

export interface GraphQLSchema {
 getQueryType(): GraphQLObjectType | undefined | null;
 getMutationType(): GraphQLObjectType | undefined | null;
 [key: string]: any;
}

export interface GraphQLObjectType {
 name: string;
 getFields(): { [key: string]: GraphQLField };
 [key: string]: any;
}

export interface GraphQLField {
 name: string;
 type: GraphQLOutputType;
 resolve?: GraphQLFieldResolver<any, any>;
 [key: string]: any;
}

export type GraphQLOutputType = GraphQLNamedOutputType | GraphQLWrappingType;

interface GraphQLNamedOutputType {
 name: string;
 [key: string]: any;
}

interface GraphQLWrappingType {
 ofType: GraphQLOutputType;
 [key: string]: any;
}

export interface GraphQLUnionType {
 name: string;
 getTypes(): ReadonlyArray<GraphQLObjectType>;
 [key: string]: any;
}

export type GraphQLType = GraphQLOutputType | GraphQLUnionType;

export type GraphQLFieldResolver<TSource, TContext, TArgs = any> = (
 source: TSource,
 args: TArgs,
 context: TContext,
 info: GraphQLResolveInfo,
) => any;

export type GraphQLTypeResolver<TSource, TContext> = (
 value: TSource,
 context: TContext,
 info: GraphQLResolveInfo,
 abstractType: any,
) => any;

export interface GraphQLResolveInfo {
 fieldName: string;
 fieldNodes: ReadonlyArray<{ kind: string; loc?: Location; [key: string]: any }>;
 returnType: { toString(): string; [key: string]: any };
 parentType: { name: string; [key: string]: any };
 path: any;
 [key: string]: any;
}

export type ValidationRule = any;

export interface TypeInfo {
 [key: string]: any;
}
// Single source of truth for the structural graphql types, shared with the orchestrion graphql
// integration in `@sentry/server-utils` so the two can't drift.
export type {
 DefinitionNode,
 DocumentNode,
 ExecutionArgs,
 ExecutionResult,
 GraphQLError,
 GraphQLFieldResolver,
 GraphQLObjectType,
 GraphQLOutputType,
 GraphQLResolveInfo,
 GraphQLSchema,
 GraphQLType,
 GraphQLTypeResolver,
 GraphQLUnionType,
 Location,
 Maybe,
 OperationDefinitionNode,
 ParseOptions,
 PromiseOrValue,
 Source,
 Token,
 TypeInfo,
 ValidationRule,
} from '@sentry/server-utils/orchestrion';

2 changes: 1 addition & 1 deletion
packages/node/src/integrations/tracing/graphql/vendored/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -367,7 +367,7 @@ export class GraphQLInstrumentation extends InstrumentationBase<GraphQLInstrumen
 });
 }

 private _createExecuteSpan(operation: DefinitionNode | undefined, processedArgs: ExecutionArgs): Span {
 private _createExecuteSpan(operation: DefinitionNode | undefined, processedArgs: OtelExecutionArgs): Span {
 const span = startInactiveSpan({
 name: SpanNames.EXECUTE,
 attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN },
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

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

 Merged

chargome
merged 10 commits into

from

Jul 9, 2026
 Merged


feat(server-utils): Migrate @opentelemetry/instrumentation-graphql to orchestrion
#21885
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
21acce6

feat(server-utils): Migrate `@opentelemetry/instrumentation-graphql` …


chargome Jul 6, 2026
e573fe3

Merge branch 'develop' into cg/orchestrion-graphql


chargome Jul 7, 2026
fdb5cdb

comments


chargome Jul 7, 2026
f55fe03

Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…


chargome Jul 8, 2026
5d25505

ref(server-utils): Align orchestrion graphql with the native subscrib…


chargome Jul 8, 2026
9d96ebd

Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…


chargome Jul 8, 2026
60f0f90

Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…


chargome Jul 8, 2026
77c5ce8

size


chargome Jul 8, 2026
b5a9b27

pr feedback


chargome Jul 8, 2026
e2776ec

Merge branch 'develop' into cg/orchestrion-graphql


chargome Jul 9, 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


2 changes: 1 addition & 1 deletion
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -400,7 +400,7 @@ module.exports = [
 import: createImport('init', 'experimentalUseDiagnosticsChannelInjection'),
 ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
 gzip: true,
 limit: '136 KB',
 limit: '140 KB',
 disablePlugins: ['@size-limit/esbuild'],
 },
 {
Expand Down

16 changes: 16 additions & 0 deletions
...packages/node-integration-tests/suites/tracing/apollo-graphql/resolvers/instrument-dc.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

// Configure graphql on the diagnostics-channel injection path: opt in, then pass the matching
// `diagnosticsChannelInjectionIntegrations()` entry explicitly so its options (here
// `ignoreResolveSpans: false`) apply. This explicit instance wins over the default one the opt-in swaps in.
const { graphqlIntegration } = Sentry.diagnosticsChannelInjectionIntegrations();
Sentry.experimentalUseDiagnosticsChannelInjection();

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 tracesSampleRate: 1.0,
 integrations: [graphqlIntegration({ ignoreResolveSpans: false })],
 transport: loggingTransport,
});

39 changes: 39 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/apollo-graphql/resolvers/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,4 +49,43 @@ describe('GraphQL/Apollo Tests > resolve spans', () => {
 .completed();
 });
 });

 // Same behavior on the diagnostics-channel path: passing the channel integration explicitly (see
 // instrument-dc.mjs) must carry `ignoreResolveSpans: false` through — the explicit instance wins over
 // the swapped-in default — and emit resolve spans with the orchestrion origin.
 const EXPECTED_ORCHESTRION_TRANSACTION = {
 transaction: 'Test Transaction (query)',
 spans: expect.arrayContaining([
 expect.objectContaining({
 description: 'query',
 origin: 'auto.graphql.diagnostic_channel',
 data: expect.objectContaining({
 'graphql.operation.type': 'query',
 'graphql.document': '{hello}',
 'sentry.origin': 'auto.graphql.diagnostic_channel',
 }),
 }),
 expect.objectContaining({ description: 'graphql.parse' }),
 expect.objectContaining({ description: 'graphql.validate' }),
 expect.objectContaining({
 description: 'graphql.resolve hello',
 data: expect.objectContaining({
 'graphql.field.name': 'hello',
 'graphql.field.path': 'hello',
 'graphql.field.type': 'String',
 'graphql.parent.name': 'Query',
 }),
 }),
 ]),
 };

 createEsmAndCjsTests(__dirname, 'scenario-query.mjs', 'instrument-dc.mjs', (createTestRunner, test) => {
 test('emits resolve spans via diagnostics-channel injection when configured explicitly', async () => {
 await createTestRunner()
 .expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
 .expect({ transaction: EXPECTED_ORCHESTRION_TRANSACTION })
 .start()
 .completed();
 });
 });
});

79 changes: 42 additions & 37 deletions
dev-packages/node-integration-tests/suites/tracing/apollo-graphql/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,39 @@
import { afterAll, describe, expect } from 'vitest';
import { isOrchestrionEnabled } from '../../../utils';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

// Server start transaction (Apollo Server v5 no longer runs introspection query on start)
const EXPECTED_START_SERVER_TRANSACTION = {
 transaction: 'Test Server Start',
};

// apollo uses graphql v16, so the default run instruments it via the vendored OTel patcher and the
// orchestrion run (auto-injected on CI) via the diagnostics-channel path. Both emit the same span
// name/status; the origin and the document attribute (`graphql.source` vs `graphql.document`) differ.
const orchestrion = isOrchestrionEnabled();
const ORIGIN = orchestrion ? 'auto.graphql.diagnostic_channel' : 'auto.graphql.otel.graphql';

function graphqlExecuteSpan(opts: {
 description: string;
 operationType: string;
 operationName?: string;
 document: unknown;
 status?: string;
}): ReturnType<typeof expect.objectContaining> {
 const { description, operationType, operationName, document, status = 'ok' } = opts;
 return expect.objectContaining({
 description,
 status,
 origin: ORIGIN,
 data: expect.objectContaining({
 'graphql.operation.type': operationType,
 ...(operationName ? { 'graphql.operation.name': operationName } : {}),
 [orchestrion ? 'graphql.document' : 'graphql.source']: document,
 'sentry.origin': ORIGIN,
 }),
 });
}

describe('GraphQL/Apollo Tests', () => {
 afterAll(() => {
 cleanupChildProcesses();
Expand All@@ -15,16 +43,7 @@ describe('GraphQL/Apollo Tests', () => {
 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',
 }),
 graphqlExecuteSpan({ description: 'query', operationType: 'query', document: '{hello}' }),
 ]),
 };

Expand All@@ -50,16 +69,11 @@ describe('GraphQL/Apollo Tests', () => {
 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',
 },
 graphqlExecuteSpan({
 description: 'mutation Mutation',
 status: 'ok',
 origin: 'auto.graphql.otel.graphql',
 operationType: 'mutation',
 operationName: 'Mutation',
 document: 'mutation Mutation($email: String) {\n login(email: $email)\n}',
 }),
 ]),
 };
Expand All@@ -86,16 +100,11 @@ describe('GraphQL/Apollo Tests', () => {
 const EXPECTED_TRANSACTION = {
 transaction: 'Test Transaction (mutation)',
 spans: expect.arrayContaining([
 expect.objectContaining({
 // The inline email literal must be redacted to `"*"`, so the raw value never reaches the span.
 graphqlExecuteSpan({
 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',
 }),
 operationType: 'mutation',
 document: expect.stringContaining('login(email: "*")'),
 }),
 ]),
 };
Expand All@@ -105,7 +114,7 @@ describe('GraphQL/Apollo Tests', () => {
 'scenario-redaction.mjs',
 'instrument.mjs',
 (createTestRunner, test) => {
 test('redacts inline literal values from graphql.source.', async () => {
 test('redacts inline literal values from the graphql document.', async () => {
 await createTestRunner()
 .expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
 .expect({ transaction: EXPECTED_TRANSACTION })
Expand All@@ -122,16 +131,12 @@ describe('GraphQL/Apollo Tests', () => {
 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',
 },
 graphqlExecuteSpan({
 description: 'mutation Mutation',
 operationType: 'mutation',
 operationName: 'Mutation',
 document: 'mutation Mutation($email: String) {\n login(email: $email)\n}',
 status: 'internal_error',
 origin: 'auto.graphql.otel.graphql',
 }),
 ]),
 };
Expand Down

178 changes: 26 additions & 152 deletions
packages/node/src/integrations/tracing/graphql/vendored/graphql-types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,152 +1,26 @@
/*
 * Simplified types inlined from the `graphql` package.
 * Only includes members accessed by this instrumentation.
 */

export type PromiseOrValue<T> = T | Promise<T>;

export type Maybe<T> = null | undefined | T;

export interface Location {
 start: number;
 end: number;
 startToken: Token;
 source: Source;
 [key: string]: any;
}

export interface Token {
 kind: string;
 start: number;
 end: number;
 line: number;
 column: number;
 value: string;
 prev: Token | null;
 next: Token | null;
 [key: string]: any;
}

export interface Source {
 body: string;
 name: string;
 locationOffset: Location;
 [key: string]: any;
}

export interface DocumentNode {
 kind: string;
 definitions: ReadonlyArray<DefinitionNode>;
 loc?: Location;
 [key: string]: any;
}

export interface DefinitionNode {
 kind: string;
 loc?: Location;
 [key: string]: any;
}

export interface OperationDefinitionNode extends DefinitionNode {
 operation: string;
 name?: { kind: string; value: string; loc?: Location };
 [key: string]: any;
}

export interface ParseOptions {
 noLocation?: boolean;
 [key: string]: any;
}

export interface ExecutionArgs {
 schema: GraphQLSchema;
 document: DocumentNode;
 rootValue?: any;
 contextValue?: any;
 variableValues?: Maybe<{ [key: string]: any }>;
 operationName?: Maybe<string>;
 fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
 typeResolver?: Maybe<GraphQLTypeResolver<any, any>>;
 [key: string]: any;
}

export interface ExecutionResult {
 errors?: ReadonlyArray<GraphQLError>;
 data?: Record<string, any> | null;
 [key: string]: any;
}

export interface GraphQLError {
 message: string;
 locations?: ReadonlyArray<{ line: number; column: number }>;
 path?: ReadonlyArray<string | number>;
 [key: string]: any;
}

export interface GraphQLSchema {
 getQueryType(): GraphQLObjectType | undefined | null;
 getMutationType(): GraphQLObjectType | undefined | null;
 [key: string]: any;
}

export interface GraphQLObjectType {
 name: string;
 getFields(): { [key: string]: GraphQLField };
 [key: string]: any;
}

export interface GraphQLField {
 name: string;
 type: GraphQLOutputType;
 resolve?: GraphQLFieldResolver<any, any>;
 [key: string]: any;
}

export type GraphQLOutputType = GraphQLNamedOutputType | GraphQLWrappingType;

interface GraphQLNamedOutputType {
 name: string;
 [key: string]: any;
}

interface GraphQLWrappingType {
 ofType: GraphQLOutputType;
 [key: string]: any;
}

export interface GraphQLUnionType {
 name: string;
 getTypes(): ReadonlyArray<GraphQLObjectType>;
 [key: string]: any;
}

export type GraphQLType = GraphQLOutputType | GraphQLUnionType;

export type GraphQLFieldResolver<TSource, TContext, TArgs = any> = (
 source: TSource,
 args: TArgs,
 context: TContext,
 info: GraphQLResolveInfo,
) => any;

export type GraphQLTypeResolver<TSource, TContext> = (
 value: TSource,
 context: TContext,
 info: GraphQLResolveInfo,
 abstractType: any,
) => any;

export interface GraphQLResolveInfo {
 fieldName: string;
 fieldNodes: ReadonlyArray<{ kind: string; loc?: Location; [key: string]: any }>;
 returnType: { toString(): string; [key: string]: any };
 parentType: { name: string; [key: string]: any };
 path: any;
 [key: string]: any;
}

export type ValidationRule = any;

export interface TypeInfo {
 [key: string]: any;
}
// Single source of truth for the structural graphql types, shared with the orchestrion graphql
// integration in `@sentry/server-utils` so the two can't drift.
export type {
 DefinitionNode,
 DocumentNode,
 ExecutionArgs,
 ExecutionResult,
 GraphQLError,
 GraphQLFieldResolver,
 GraphQLObjectType,
 GraphQLOutputType,
 GraphQLResolveInfo,
 GraphQLSchema,
 GraphQLType,
 GraphQLTypeResolver,
 GraphQLUnionType,
 Location,
 Maybe,
 OperationDefinitionNode,
 ParseOptions,
 PromiseOrValue,
 Source,
 Token,
 TypeInfo,
 ValidationRule,
} from '@sentry/server-utils/orchestrion';

2 changes: 1 addition & 1 deletion
packages/node/src/integrations/tracing/graphql/vendored/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -367,7 +367,7 @@ export class GraphQLInstrumentation extends InstrumentationBase<GraphQLInstrumen
 });
 }

 private _createExecuteSpan(operation: DefinitionNode | undefined, processedArgs: ExecutionArgs): Span {
 private _createExecuteSpan(operation: DefinitionNode | undefined, processedArgs: OtelExecutionArgs): Span {
 const span = startInactiveSpan({
 name: SpanNames.EXECUTE,
 attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN },
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

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

 Merged

chargome
merged 10 commits into

from

Jul 9, 2026
 Merged


feat(server-utils): Migrate @opentelemetry/instrumentation-graphql to orchestrion
#21885
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
21acce6

feat(server-utils): Migrate `@opentelemetry/instrumentation-graphql` …


chargome Jul 6, 2026
e573fe3

Merge branch 'develop' into cg/orchestrion-graphql


chargome Jul 7, 2026
fdb5cdb

comments


chargome Jul 7, 2026
f55fe03

Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…


chargome Jul 8, 2026
5d25505

ref(server-utils): Align orchestrion graphql with the native subscrib…


chargome Jul 8, 2026
9d96ebd

Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…


chargome Jul 8, 2026
60f0f90

Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…


chargome Jul 8, 2026
77c5ce8

size


chargome Jul 8, 2026
b5a9b27

pr feedback


chargome Jul 8, 2026
e2776ec

Merge branch 'develop' into cg/orchestrion-graphql


chargome Jul 9, 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


2 changes: 1 addition & 1 deletion
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -400,7 +400,7 @@ module.exports = [
 import: createImport('init', 'experimentalUseDiagnosticsChannelInjection'),
 ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
 gzip: true,
 limit: '136 KB',
 limit: '140 KB',
 disablePlugins: ['@size-limit/esbuild'],
 },
 {
Expand Down

16 changes: 16 additions & 0 deletions
...packages/node-integration-tests/suites/tracing/apollo-graphql/resolvers/instrument-dc.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

// Configure graphql on the diagnostics-channel injection path: opt in, then pass the matching
// `diagnosticsChannelInjectionIntegrations()` entry explicitly so its options (here
// `ignoreResolveSpans: false`) apply. This explicit instance wins over the default one the opt-in swaps in.
const { graphqlIntegration } = Sentry.diagnosticsChannelInjectionIntegrations();
Sentry.experimentalUseDiagnosticsChannelInjection();

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 tracesSampleRate: 1.0,
 integrations: [graphqlIntegration({ ignoreResolveSpans: false })],
 transport: loggingTransport,
});

39 changes: 39 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/apollo-graphql/resolvers/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,4 +49,43 @@ describe('GraphQL/Apollo Tests > resolve spans', () => {
 .completed();
 });
 });

 // Same behavior on the diagnostics-channel path: passing the channel integration explicitly (see
 // instrument-dc.mjs) must carry `ignoreResolveSpans: false` through — the explicit instance wins over
 // the swapped-in default — and emit resolve spans with the orchestrion origin.
 const EXPECTED_ORCHESTRION_TRANSACTION = {
 transaction: 'Test Transaction (query)',
 spans: expect.arrayContaining([
 expect.objectContaining({
 description: 'query',
 origin: 'auto.graphql.diagnostic_channel',
 data: expect.objectContaining({
 'graphql.operation.type': 'query',
 'graphql.document': '{hello}',
 'sentry.origin': 'auto.graphql.diagnostic_channel',
 }),
 }),
 expect.objectContaining({ description: 'graphql.parse' }),
 expect.objectContaining({ description: 'graphql.validate' }),
 expect.objectContaining({
 description: 'graphql.resolve hello',
 data: expect.objectContaining({
 'graphql.field.name': 'hello',
 'graphql.field.path': 'hello',
 'graphql.field.type': 'String',
 'graphql.parent.name': 'Query',
 }),
 }),
 ]),
 };

 createEsmAndCjsTests(__dirname, 'scenario-query.mjs', 'instrument-dc.mjs', (createTestRunner, test) => {
 test('emits resolve spans via diagnostics-channel injection when configured explicitly', async () => {
 await createTestRunner()
 .expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
 .expect({ transaction: EXPECTED_ORCHESTRION_TRANSACTION })
 .start()
 .completed();
 });
 });
});

79 changes: 42 additions & 37 deletions
dev-packages/node-integration-tests/suites/tracing/apollo-graphql/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,39 @@
import { afterAll, describe, expect } from 'vitest';
import { isOrchestrionEnabled } from '../../../utils';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

// Server start transaction (Apollo Server v5 no longer runs introspection query on start)
const EXPECTED_START_SERVER_TRANSACTION = {
 transaction: 'Test Server Start',
};

// apollo uses graphql v16, so the default run instruments it via the vendored OTel patcher and the
// orchestrion run (auto-injected on CI) via the diagnostics-channel path. Both emit the same span
// name/status; the origin and the document attribute (`graphql.source` vs `graphql.document`) differ.
const orchestrion = isOrchestrionEnabled();
const ORIGIN = orchestrion ? 'auto.graphql.diagnostic_channel' : 'auto.graphql.otel.graphql';

function graphqlExecuteSpan(opts: {
 description: string;
 operationType: string;
 operationName?: string;
 document: unknown;
 status?: string;
}): ReturnType<typeof expect.objectContaining> {
 const { description, operationType, operationName, document, status = 'ok' } = opts;
 return expect.objectContaining({
 description,
 status,
 origin: ORIGIN,
 data: expect.objectContaining({
 'graphql.operation.type': operationType,
 ...(operationName ? { 'graphql.operation.name': operationName } : {}),
 [orchestrion ? 'graphql.document' : 'graphql.source']: document,
 'sentry.origin': ORIGIN,
 }),
 });
}

describe('GraphQL/Apollo Tests', () => {
 afterAll(() => {
 cleanupChildProcesses();
Expand All@@ -15,16 +43,7 @@ describe('GraphQL/Apollo Tests', () => {
 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',
 }),
 graphqlExecuteSpan({ description: 'query', operationType: 'query', document: '{hello}' }),
 ]),
 };

Expand All@@ -50,16 +69,11 @@ describe('GraphQL/Apollo Tests', () => {
 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',
 },
 graphqlExecuteSpan({
 description: 'mutation Mutation',
 status: 'ok',
 origin: 'auto.graphql.otel.graphql',
 operationType: 'mutation',
 operationName: 'Mutation',
 document: 'mutation Mutation($email: String) {\n login(email: $email)\n}',
 }),
 ]),
 };
Expand All@@ -86,16 +100,11 @@ describe('GraphQL/Apollo Tests', () => {
 const EXPECTED_TRANSACTION = {
 transaction: 'Test Transaction (mutation)',
 spans: expect.arrayContaining([
 expect.objectContaining({
 // The inline email literal must be redacted to `"*"`, so the raw value never reaches the span.
 graphqlExecuteSpan({
 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',
 }),
 operationType: 'mutation',
 document: expect.stringContaining('login(email: "*")'),
 }),
 ]),
 };
Expand All@@ -105,7 +114,7 @@ describe('GraphQL/Apollo Tests', () => {
 'scenario-redaction.mjs',
 'instrument.mjs',
 (createTestRunner, test) => {
 test('redacts inline literal values from graphql.source.', async () => {
 test('redacts inline literal values from the graphql document.', async () => {
 await createTestRunner()
 .expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
 .expect({ transaction: EXPECTED_TRANSACTION })
Expand All@@ -122,16 +131,12 @@ describe('GraphQL/Apollo Tests', () => {
 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',
 },
 graphqlExecuteSpan({
 description: 'mutation Mutation',
 operationType: 'mutation',
 operationName: 'Mutation',
 document: 'mutation Mutation($email: String) {\n login(email: $email)\n}',
 status: 'internal_error',
 origin: 'auto.graphql.otel.graphql',
 }),
 ]),
 };
Expand Down

178 changes: 26 additions & 152 deletions
packages/node/src/integrations/tracing/graphql/vendored/graphql-types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,152 +1,26 @@
/*
 * Simplified types inlined from the `graphql` package.
 * Only includes members accessed by this instrumentation.
 */

export type PromiseOrValue<T> = T | Promise<T>;

export type Maybe<T> = null | undefined | T;

export interface Location {
 start: number;
 end: number;
 startToken: Token;
 source: Source;
 [key: string]: any;
}

export interface Token {
 kind: string;
 start: number;
 end: number;
 line: number;
 column: number;
 value: string;
 prev: Token | null;
 next: Token | null;
 [key: string]: any;
}

export interface Source {
 body: string;
 name: string;
 locationOffset: Location;
 [key: string]: any;
}

export interface DocumentNode {
 kind: string;
 definitions: ReadonlyArray<DefinitionNode>;
 loc?: Location;
 [key: string]: any;
}

export interface DefinitionNode {
 kind: string;
 loc?: Location;
 [key: string]: any;
}

export interface OperationDefinitionNode extends DefinitionNode {
 operation: string;
 name?: { kind: string; value: string; loc?: Location };
 [key: string]: any;
}

export interface ParseOptions {
 noLocation?: boolean;
 [key: string]: any;
}

export interface ExecutionArgs {
 schema: GraphQLSchema;
 document: DocumentNode;
 rootValue?: any;
 contextValue?: any;
 variableValues?: Maybe<{ [key: string]: any }>;
 operationName?: Maybe<string>;
 fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
 typeResolver?: Maybe<GraphQLTypeResolver<any, any>>;
 [key: string]: any;
}

export interface ExecutionResult {
 errors?: ReadonlyArray<GraphQLError>;
 data?: Record<string, any> | null;
 [key: string]: any;
}

export interface GraphQLError {
 message: string;
 locations?: ReadonlyArray<{ line: number; column: number }>;
 path?: ReadonlyArray<string | number>;
 [key: string]: any;
}

export interface GraphQLSchema {
 getQueryType(): GraphQLObjectType | undefined | null;
 getMutationType(): GraphQLObjectType | undefined | null;
 [key: string]: any;
}

export interface GraphQLObjectType {
 name: string;
 getFields(): { [key: string]: GraphQLField };
 [key: string]: any;
}

export interface GraphQLField {
 name: string;
 type: GraphQLOutputType;
 resolve?: GraphQLFieldResolver<any, any>;
 [key: string]: any;
}

export type GraphQLOutputType = GraphQLNamedOutputType | GraphQLWrappingType;

interface GraphQLNamedOutputType {
 name: string;
 [key: string]: any;
}

interface GraphQLWrappingType {
 ofType: GraphQLOutputType;
 [key: string]: any;
}

export interface GraphQLUnionType {
 name: string;
 getTypes(): ReadonlyArray<GraphQLObjectType>;
 [key: string]: any;
}

export type GraphQLType = GraphQLOutputType | GraphQLUnionType;

export type GraphQLFieldResolver<TSource, TContext, TArgs = any> = (
 source: TSource,
 args: TArgs,
 context: TContext,
 info: GraphQLResolveInfo,
) => any;

export type GraphQLTypeResolver<TSource, TContext> = (
 value: TSource,
 context: TContext,
 info: GraphQLResolveInfo,
 abstractType: any,
) => any;

export interface GraphQLResolveInfo {
 fieldName: string;
 fieldNodes: ReadonlyArray<{ kind: string; loc?: Location; [key: string]: any }>;
 returnType: { toString(): string; [key: string]: any };
 parentType: { name: string; [key: string]: any };
 path: any;
 [key: string]: any;
}

export type ValidationRule = any;

export interface TypeInfo {
 [key: string]: any;
}
// Single source of truth for the structural graphql types, shared with the orchestrion graphql
// integration in `@sentry/server-utils` so the two can't drift.
export type {
 DefinitionNode,
 DocumentNode,
 ExecutionArgs,
 ExecutionResult,
 GraphQLError,
 GraphQLFieldResolver,
 GraphQLObjectType,
 GraphQLOutputType,
 GraphQLResolveInfo,
 GraphQLSchema,
 GraphQLType,
 GraphQLTypeResolver,
 GraphQLUnionType,
 Location,
 Maybe,
 OperationDefinitionNode,
 ParseOptions,
 PromiseOrValue,
 Source,
 Token,
 TypeInfo,
 ValidationRule,
} from '@sentry/server-utils/orchestrion';

2 changes: 1 addition & 1 deletion
packages/node/src/integrations/tracing/graphql/vendored/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -367,7 +367,7 @@ export class GraphQLInstrumentation extends InstrumentationBase<GraphQLInstrumen
 });
 }

 private _createExecuteSpan(operation: DefinitionNode | undefined, processedArgs: ExecutionArgs): Span {
 private _createExecuteSpan(operation: DefinitionNode | undefined, processedArgs: OtelExecutionArgs): Span {
 const span = startInactiveSpan({
 name: SpanNames.EXECUTE,
 attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN },
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

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

 Merged

chargome
merged 10 commits into

from

Jul 9, 2026
 Merged


feat(server-utils): Migrate @opentelemetry/instrumentation-graphql to orchestrion
#21885
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
21acce6

feat(server-utils): Migrate `@opentelemetry/instrumentation-graphql` …


chargome Jul 6, 2026
e573fe3

Merge branch 'develop' into cg/orchestrion-graphql


chargome Jul 7, 2026
fdb5cdb

comments


chargome Jul 7, 2026
f55fe03

Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…


chargome Jul 8, 2026
5d25505

ref(server-utils): Align orchestrion graphql with the native subscrib…


chargome Jul 8, 2026
9d96ebd

Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…


chargome Jul 8, 2026
60f0f90

Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…


chargome Jul 8, 2026
77c5ce8

size


chargome Jul 8, 2026
b5a9b27

pr feedback


chargome Jul 8, 2026
e2776ec

Merge branch 'develop' into cg/orchestrion-graphql


chargome Jul 9, 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


2 changes: 1 addition & 1 deletion
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -400,7 +400,7 @@ module.exports = [
 import: createImport('init', 'experimentalUseDiagnosticsChannelInjection'),
 ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
 gzip: true,
 limit: '136 KB',
 limit: '140 KB',
 disablePlugins: ['@size-limit/esbuild'],
 },
 {
Expand Down

16 changes: 16 additions & 0 deletions
...packages/node-integration-tests/suites/tracing/apollo-graphql/resolvers/instrument-dc.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

// Configure graphql on the diagnostics-channel injection path: opt in, then pass the matching
// `diagnosticsChannelInjectionIntegrations()` entry explicitly so its options (here
// `ignoreResolveSpans: false`) apply. This explicit instance wins over the default one the opt-in swaps in.
const { graphqlIntegration } = Sentry.diagnosticsChannelInjectionIntegrations();
Sentry.experimentalUseDiagnosticsChannelInjection();

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 tracesSampleRate: 1.0,
 integrations: [graphqlIntegration({ ignoreResolveSpans: false })],
 transport: loggingTransport,
});

39 changes: 39 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/apollo-graphql/resolvers/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,4 +49,43 @@ describe('GraphQL/Apollo Tests > resolve spans', () => {
 .completed();
 });
 });

 // Same behavior on the diagnostics-channel path: passing the channel integration explicitly (see
 // instrument-dc.mjs) must carry `ignoreResolveSpans: false` through — the explicit instance wins over
 // the swapped-in default — and emit resolve spans with the orchestrion origin.
 const EXPECTED_ORCHESTRION_TRANSACTION = {
 transaction: 'Test Transaction (query)',
 spans: expect.arrayContaining([
 expect.objectContaining({
 description: 'query',
 origin: 'auto.graphql.diagnostic_channel',
 data: expect.objectContaining({
 'graphql.operation.type': 'query',
 'graphql.document': '{hello}',
 'sentry.origin': 'auto.graphql.diagnostic_channel',
 }),
 }),
 expect.objectContaining({ description: 'graphql.parse' }),
 expect.objectContaining({ description: 'graphql.validate' }),
 expect.objectContaining({
 description: 'graphql.resolve hello',
 data: expect.objectContaining({
 'graphql.field.name': 'hello',
 'graphql.field.path': 'hello',
 'graphql.field.type': 'String',
 'graphql.parent.name': 'Query',
 }),
 }),
 ]),
 };

 createEsmAndCjsTests(__dirname, 'scenario-query.mjs', 'instrument-dc.mjs', (createTestRunner, test) => {
 test('emits resolve spans via diagnostics-channel injection when configured explicitly', async () => {
 await createTestRunner()
 .expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
 .expect({ transaction: EXPECTED_ORCHESTRION_TRANSACTION })
 .start()
 .completed();
 });
 });
});

79 changes: 42 additions & 37 deletions
dev-packages/node-integration-tests/suites/tracing/apollo-graphql/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,39 @@
import { afterAll, describe, expect } from 'vitest';
import { isOrchestrionEnabled } from '../../../utils';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

// Server start transaction (Apollo Server v5 no longer runs introspection query on start)
const EXPECTED_START_SERVER_TRANSACTION = {
 transaction: 'Test Server Start',
};

// apollo uses graphql v16, so the default run instruments it via the vendored OTel patcher and the
// orchestrion run (auto-injected on CI) via the diagnostics-channel path. Both emit the same span
// name/status; the origin and the document attribute (`graphql.source` vs `graphql.document`) differ.
const orchestrion = isOrchestrionEnabled();
const ORIGIN = orchestrion ? 'auto.graphql.diagnostic_channel' : 'auto.graphql.otel.graphql';

function graphqlExecuteSpan(opts: {
 description: string;
 operationType: string;
 operationName?: string;
 document: unknown;
 status?: string;
}): ReturnType<typeof expect.objectContaining> {
 const { description, operationType, operationName, document, status = 'ok' } = opts;
 return expect.objectContaining({
 description,
 status,
 origin: ORIGIN,
 data: expect.objectContaining({
 'graphql.operation.type': operationType,
 ...(operationName ? { 'graphql.operation.name': operationName } : {}),
 [orchestrion ? 'graphql.document' : 'graphql.source']: document,
 'sentry.origin': ORIGIN,
 }),
 });
}

describe('GraphQL/Apollo Tests', () => {
 afterAll(() => {
 cleanupChildProcesses();
Expand All@@ -15,16 +43,7 @@ describe('GraphQL/Apollo Tests', () => {
 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',
 }),
 graphqlExecuteSpan({ description: 'query', operationType: 'query', document: '{hello}' }),
 ]),
 };

Expand All@@ -50,16 +69,11 @@ describe('GraphQL/Apollo Tests', () => {
 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',
 },
 graphqlExecuteSpan({
 description: 'mutation Mutation',
 status: 'ok',
 origin: 'auto.graphql.otel.graphql',
 operationType: 'mutation',
 operationName: 'Mutation',
 document: 'mutation Mutation($email: String) {\n login(email: $email)\n}',
 }),
 ]),
 };
Expand All@@ -86,16 +100,11 @@ describe('GraphQL/Apollo Tests', () => {
 const EXPECTED_TRANSACTION = {
 transaction: 'Test Transaction (mutation)',
 spans: expect.arrayContaining([
 expect.objectContaining({
 // The inline email literal must be redacted to `"*"`, so the raw value never reaches the span.
 graphqlExecuteSpan({
 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',
 }),
 operationType: 'mutation',
 document: expect.stringContaining('login(email: "*")'),
 }),
 ]),
 };
Expand All@@ -105,7 +114,7 @@ describe('GraphQL/Apollo Tests', () => {
 'scenario-redaction.mjs',
 'instrument.mjs',
 (createTestRunner, test) => {
 test('redacts inline literal values from graphql.source.', async () => {
 test('redacts inline literal values from the graphql document.', async () => {
 await createTestRunner()
 .expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
 .expect({ transaction: EXPECTED_TRANSACTION })
Expand All@@ -122,16 +131,12 @@ describe('GraphQL/Apollo Tests', () => {
 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',
 },
 graphqlExecuteSpan({
 description: 'mutation Mutation',
 operationType: 'mutation',
 operationName: 'Mutation',
 document: 'mutation Mutation($email: String) {\n login(email: $email)\n}',
 status: 'internal_error',
 origin: 'auto.graphql.otel.graphql',
 }),
 ]),
 };
Expand Down

178 changes: 26 additions & 152 deletions
packages/node/src/integrations/tracing/graphql/vendored/graphql-types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,152 +1,26 @@
/*
 * Simplified types inlined from the `graphql` package.
 * Only includes members accessed by this instrumentation.
 */

export type PromiseOrValue<T> = T | Promise<T>;

export type Maybe<T> = null | undefined | T;

export interface Location {
 start: number;
 end: number;
 startToken: Token;
 source: Source;
 [key: string]: any;
}

export interface Token {
 kind: string;
 start: number;
 end: number;
 line: number;
 column: number;
 value: string;
 prev: Token | null;
 next: Token | null;
 [key: string]: any;
}

export interface Source {
 body: string;
 name: string;
 locationOffset: Location;
 [key: string]: any;
}

export interface DocumentNode {
 kind: string;
 definitions: ReadonlyArray<DefinitionNode>;
 loc?: Location;
 [key: string]: any;
}

export interface DefinitionNode {
 kind: string;
 loc?: Location;
 [key: string]: any;
}

export interface OperationDefinitionNode extends DefinitionNode {
 operation: string;
 name?: { kind: string; value: string; loc?: Location };
 [key: string]: any;
}

export interface ParseOptions {
 noLocation?: boolean;
 [key: string]: any;
}

export interface ExecutionArgs {
 schema: GraphQLSchema;
 document: DocumentNode;
 rootValue?: any;
 contextValue?: any;
 variableValues?: Maybe<{ [key: string]: any }>;
 operationName?: Maybe<string>;
 fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
 typeResolver?: Maybe<GraphQLTypeResolver<any, any>>;
 [key: string]: any;
}

export interface ExecutionResult {
 errors?: ReadonlyArray<GraphQLError>;
 data?: Record<string, any> | null;
 [key: string]: any;
}

export interface GraphQLError {
 message: string;
 locations?: ReadonlyArray<{ line: number; column: number }>;
 path?: ReadonlyArray<string | number>;
 [key: string]: any;
}

export interface GraphQLSchema {
 getQueryType(): GraphQLObjectType | undefined | null;
 getMutationType(): GraphQLObjectType | undefined | null;
 [key: string]: any;
}

export interface GraphQLObjectType {
 name: string;
 getFields(): { [key: string]: GraphQLField };
 [key: string]: any;
}

export interface GraphQLField {
 name: string;
 type: GraphQLOutputType;
 resolve?: GraphQLFieldResolver<any, any>;
 [key: string]: any;
}

export type GraphQLOutputType = GraphQLNamedOutputType | GraphQLWrappingType;

interface GraphQLNamedOutputType {
 name: string;
 [key: string]: any;
}

interface GraphQLWrappingType {
 ofType: GraphQLOutputType;
 [key: string]: any;
}

export interface GraphQLUnionType {
 name: string;
 getTypes(): ReadonlyArray<GraphQLObjectType>;
 [key: string]: any;
}

export type GraphQLType = GraphQLOutputType | GraphQLUnionType;

export type GraphQLFieldResolver<TSource, TContext, TArgs = any> = (
 source: TSource,
 args: TArgs,
 context: TContext,
 info: GraphQLResolveInfo,
) => any;

export type GraphQLTypeResolver<TSource, TContext> = (
 value: TSource,
 context: TContext,
 info: GraphQLResolveInfo,
 abstractType: any,
) => any;

export interface GraphQLResolveInfo {
 fieldName: string;
 fieldNodes: ReadonlyArray<{ kind: string; loc?: Location; [key: string]: any }>;
 returnType: { toString(): string; [key: string]: any };
 parentType: { name: string; [key: string]: any };
 path: any;
 [key: string]: any;
}

export type ValidationRule = any;

export interface TypeInfo {
 [key: string]: any;
}
// Single source of truth for the structural graphql types, shared with the orchestrion graphql
// integration in `@sentry/server-utils` so the two can't drift.
export type {
 DefinitionNode,
 DocumentNode,
 ExecutionArgs,
 ExecutionResult,
 GraphQLError,
 GraphQLFieldResolver,
 GraphQLObjectType,
 GraphQLOutputType,
 GraphQLResolveInfo,
 GraphQLSchema,
 GraphQLType,
 GraphQLTypeResolver,
 GraphQLUnionType,
 Location,
 Maybe,
 OperationDefinitionNode,
 ParseOptions,
 PromiseOrValue,
 Source,
 Token,
 TypeInfo,
 ValidationRule,
} from '@sentry/server-utils/orchestrion';

2 changes: 1 addition & 1 deletion
packages/node/src/integrations/tracing/graphql/vendored/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -367,7 +367,7 @@ export class GraphQLInstrumentation extends InstrumentationBase<GraphQLInstrumen
 });
 }

 private _createExecuteSpan(operation: DefinitionNode | undefined, processedArgs: ExecutionArgs): Span {
 private _createExecuteSpan(operation: DefinitionNode | undefined, processedArgs: OtelExecutionArgs): Span {
 const span = startInactiveSpan({
 name: SpanNames.EXECUTE,
 attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN },
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

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

 Merged

chargome
merged 10 commits into

from

Jul 9, 2026
 Merged


feat(server-utils): Migrate @opentelemetry/instrumentation-graphql to orchestrion
#21885
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
21acce6

feat(server-utils): Migrate `@opentelemetry/instrumentation-graphql` …


chargome Jul 6, 2026
e573fe3

Merge branch 'develop' into cg/orchestrion-graphql


chargome Jul 7, 2026
fdb5cdb

comments


chargome Jul 7, 2026
f55fe03

Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…


chargome Jul 8, 2026
5d25505

ref(server-utils): Align orchestrion graphql with the native subscrib…


chargome Jul 8, 2026
9d96ebd

Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…


chargome Jul 8, 2026
60f0f90

Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…


chargome Jul 8, 2026
77c5ce8

size


chargome Jul 8, 2026
b5a9b27

pr feedback


chargome Jul 8, 2026
e2776ec

Merge branch 'develop' into cg/orchestrion-graphql


chargome Jul 9, 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


2 changes: 1 addition & 1 deletion
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -400,7 +400,7 @@ module.exports = [
 import: createImport('init', 'experimentalUseDiagnosticsChannelInjection'),
 ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
 gzip: true,
 limit: '136 KB',
 limit: '140 KB',
 disablePlugins: ['@size-limit/esbuild'],
 },
 {
Expand Down

16 changes: 16 additions & 0 deletions
...packages/node-integration-tests/suites/tracing/apollo-graphql/resolvers/instrument-dc.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

// Configure graphql on the diagnostics-channel injection path: opt in, then pass the matching
// `diagnosticsChannelInjectionIntegrations()` entry explicitly so its options (here
// `ignoreResolveSpans: false`) apply. This explicit instance wins over the default one the opt-in swaps in.
const { graphqlIntegration } = Sentry.diagnosticsChannelInjectionIntegrations();
Sentry.experimentalUseDiagnosticsChannelInjection();

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 tracesSampleRate: 1.0,
 integrations: [graphqlIntegration({ ignoreResolveSpans: false })],
 transport: loggingTransport,
});

39 changes: 39 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/apollo-graphql/resolvers/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,4 +49,43 @@ describe('GraphQL/Apollo Tests > resolve spans', () => {
 .completed();
 });
 });

 // Same behavior on the diagnostics-channel path: passing the channel integration explicitly (see
 // instrument-dc.mjs) must carry `ignoreResolveSpans: false` through — the explicit instance wins over
 // the swapped-in default — and emit resolve spans with the orchestrion origin.
 const EXPECTED_ORCHESTRION_TRANSACTION = {
 transaction: 'Test Transaction (query)',
 spans: expect.arrayContaining([
 expect.objectContaining({
 description: 'query',
 origin: 'auto.graphql.diagnostic_channel',
 data: expect.objectContaining({
 'graphql.operation.type': 'query',
 'graphql.document': '{hello}',
 'sentry.origin': 'auto.graphql.diagnostic_channel',
 }),
 }),
 expect.objectContaining({ description: 'graphql.parse' }),
 expect.objectContaining({ description: 'graphql.validate' }),
 expect.objectContaining({
 description: 'graphql.resolve hello',
 data: expect.objectContaining({
 'graphql.field.name': 'hello',
 'graphql.field.path': 'hello',
 'graphql.field.type': 'String',
 'graphql.parent.name': 'Query',
 }),
 }),
 ]),
 };

 createEsmAndCjsTests(__dirname, 'scenario-query.mjs', 'instrument-dc.mjs', (createTestRunner, test) => {
 test('emits resolve spans via diagnostics-channel injection when configured explicitly', async () => {
 await createTestRunner()
 .expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
 .expect({ transaction: EXPECTED_ORCHESTRION_TRANSACTION })
 .start()
 .completed();
 });
 });
});

79 changes: 42 additions & 37 deletions
dev-packages/node-integration-tests/suites/tracing/apollo-graphql/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,39 @@
import { afterAll, describe, expect } from 'vitest';
import { isOrchestrionEnabled } from '../../../utils';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

// Server start transaction (Apollo Server v5 no longer runs introspection query on start)
const EXPECTED_START_SERVER_TRANSACTION = {
 transaction: 'Test Server Start',
};

// apollo uses graphql v16, so the default run instruments it via the vendored OTel patcher and the
// orchestrion run (auto-injected on CI) via the diagnostics-channel path. Both emit the same span
// name/status; the origin and the document attribute (`graphql.source` vs `graphql.document`) differ.
const orchestrion = isOrchestrionEnabled();
const ORIGIN = orchestrion ? 'auto.graphql.diagnostic_channel' : 'auto.graphql.otel.graphql';

function graphqlExecuteSpan(opts: {
 description: string;
 operationType: string;
 operationName?: string;
 document: unknown;
 status?: string;
}): ReturnType<typeof expect.objectContaining> {
 const { description, operationType, operationName, document, status = 'ok' } = opts;
 return expect.objectContaining({
 description,
 status,
 origin: ORIGIN,
 data: expect.objectContaining({
 'graphql.operation.type': operationType,
 ...(operationName ? { 'graphql.operation.name': operationName } : {}),
 [orchestrion ? 'graphql.document' : 'graphql.source']: document,
 'sentry.origin': ORIGIN,
 }),
 });
}

describe('GraphQL/Apollo Tests', () => {
 afterAll(() => {
 cleanupChildProcesses();
Expand All@@ -15,16 +43,7 @@ describe('GraphQL/Apollo Tests', () => {
 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',
 }),
 graphqlExecuteSpan({ description: 'query', operationType: 'query', document: '{hello}' }),
 ]),
 };

Expand All@@ -50,16 +69,11 @@ describe('GraphQL/Apollo Tests', () => {
 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',
 },
 graphqlExecuteSpan({
 description: 'mutation Mutation',
 status: 'ok',
 origin: 'auto.graphql.otel.graphql',
 operationType: 'mutation',
 operationName: 'Mutation',
 document: 'mutation Mutation($email: String) {\n login(email: $email)\n}',
 }),
 ]),
 };
Expand All@@ -86,16 +100,11 @@ describe('GraphQL/Apollo Tests', () => {
 const EXPECTED_TRANSACTION = {
 transaction: 'Test Transaction (mutation)',
 spans: expect.arrayContaining([
 expect.objectContaining({
 // The inline email literal must be redacted to `"*"`, so the raw value never reaches the span.
 graphqlExecuteSpan({
 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',
 }),
 operationType: 'mutation',
 document: expect.stringContaining('login(email: "*")'),
 }),
 ]),
 };
Expand All@@ -105,7 +114,7 @@ describe('GraphQL/Apollo Tests', () => {
 'scenario-redaction.mjs',
 'instrument.mjs',
 (createTestRunner, test) => {
 test('redacts inline literal values from graphql.source.', async () => {
 test('redacts inline literal values from the graphql document.', async () => {
 await createTestRunner()
 .expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
 .expect({ transaction: EXPECTED_TRANSACTION })
Expand All@@ -122,16 +131,12 @@ describe('GraphQL/Apollo Tests', () => {
 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',
 },
 graphqlExecuteSpan({
 description: 'mutation Mutation',
 operationType: 'mutation',
 operationName: 'Mutation',
 document: 'mutation Mutation($email: String) {\n login(email: $email)\n}',
 status: 'internal_error',
 origin: 'auto.graphql.otel.graphql',
 }),
 ]),
 };
Expand Down

178 changes: 26 additions & 152 deletions
packages/node/src/integrations/tracing/graphql/vendored/graphql-types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,152 +1,26 @@
/*
 * Simplified types inlined from the `graphql` package.
 * Only includes members accessed by this instrumentation.
 */

export type PromiseOrValue<T> = T | Promise<T>;

export type Maybe<T> = null | undefined | T;

export interface Location {
 start: number;
 end: number;
 startToken: Token;
 source: Source;
 [key: string]: any;
}

export interface Token {
 kind: string;
 start: number;
 end: number;
 line: number;
 column: number;
 value: string;
 prev: Token | null;
 next: Token | null;
 [key: string]: any;
}

export interface Source {
 body: string;
 name: string;
 locationOffset: Location;
 [key: string]: any;
}

export interface DocumentNode {
 kind: string;
 definitions: ReadonlyArray<DefinitionNode>;
 loc?: Location;
 [key: string]: any;
}

export interface DefinitionNode {
 kind: string;
 loc?: Location;
 [key: string]: any;
}

export interface OperationDefinitionNode extends DefinitionNode {
 operation: string;
 name?: { kind: string; value: string; loc?: Location };
 [key: string]: any;
}

export interface ParseOptions {
 noLocation?: boolean;
 [key: string]: any;
}

export interface ExecutionArgs {
 schema: GraphQLSchema;
 document: DocumentNode;
 rootValue?: any;
 contextValue?: any;
 variableValues?: Maybe<{ [key: string]: any }>;
 operationName?: Maybe<string>;
 fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
 typeResolver?: Maybe<GraphQLTypeResolver<any, any>>;
 [key: string]: any;
}

export interface ExecutionResult {
 errors?: ReadonlyArray<GraphQLError>;
 data?: Record<string, any> | null;
 [key: string]: any;
}

export interface GraphQLError {
 message: string;
 locations?: ReadonlyArray<{ line: number; column: number }>;
 path?: ReadonlyArray<string | number>;
 [key: string]: any;
}

export interface GraphQLSchema {
 getQueryType(): GraphQLObjectType | undefined | null;
 getMutationType(): GraphQLObjectType | undefined | null;
 [key: string]: any;
}

export interface GraphQLObjectType {
 name: string;
 getFields(): { [key: string]: GraphQLField };
 [key: string]: any;
}

export interface GraphQLField {
 name: string;
 type: GraphQLOutputType;
 resolve?: GraphQLFieldResolver<any, any>;
 [key: string]: any;
}

export type GraphQLOutputType = GraphQLNamedOutputType | GraphQLWrappingType;

interface GraphQLNamedOutputType {
 name: string;
 [key: string]: any;
}

interface GraphQLWrappingType {
 ofType: GraphQLOutputType;
 [key: string]: any;
}

export interface GraphQLUnionType {
 name: string;
 getTypes(): ReadonlyArray<GraphQLObjectType>;
 [key: string]: any;
}

export type GraphQLType = GraphQLOutputType | GraphQLUnionType;

export type GraphQLFieldResolver<TSource, TContext, TArgs = any> = (
 source: TSource,
 args: TArgs,
 context: TContext,
 info: GraphQLResolveInfo,
) => any;

export type GraphQLTypeResolver<TSource, TContext> = (
 value: TSource,
 context: TContext,
 info: GraphQLResolveInfo,
 abstractType: any,
) => any;

export interface GraphQLResolveInfo {
 fieldName: string;
 fieldNodes: ReadonlyArray<{ kind: string; loc?: Location; [key: string]: any }>;
 returnType: { toString(): string; [key: string]: any };
 parentType: { name: string; [key: string]: any };
 path: any;
 [key: string]: any;
}

export type ValidationRule = any;

export interface TypeInfo {
 [key: string]: any;
}
// Single source of truth for the structural graphql types, shared with the orchestrion graphql
// integration in `@sentry/server-utils` so the two can't drift.
export type {
 DefinitionNode,
 DocumentNode,
 ExecutionArgs,
 ExecutionResult,
 GraphQLError,
 GraphQLFieldResolver,
 GraphQLObjectType,
 GraphQLOutputType,
 GraphQLResolveInfo,
 GraphQLSchema,
 GraphQLType,
 GraphQLTypeResolver,
 GraphQLUnionType,
 Location,
 Maybe,
 OperationDefinitionNode,
 ParseOptions,
 PromiseOrValue,
 Source,
 Token,
 TypeInfo,
 ValidationRule,
} from '@sentry/server-utils/orchestrion';

2 changes: 1 addition & 1 deletion
packages/node/src/integrations/tracing/graphql/vendored/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -367,7 +367,7 @@ export class GraphQLInstrumentation extends InstrumentationBase<GraphQLInstrumen
 });
 }

 private _createExecuteSpan(operation: DefinitionNode | undefined, processedArgs: ExecutionArgs): Span {
 private _createExecuteSpan(operation: DefinitionNode | undefined, processedArgs: OtelExecutionArgs): Span {
 const span = startInactiveSpan({
 name: SpanNames.EXECUTE,
 attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN },
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

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

 Merged

chargome
merged 10 commits into

from

Jul 9, 2026
 Merged


feat(server-utils): Migrate @opentelemetry/instrumentation-graphql to orchestrion
#21885
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
21acce6

feat(server-utils): Migrate `@opentelemetry/instrumentation-graphql` …


chargome Jul 6, 2026
e573fe3

Merge branch 'develop' into cg/orchestrion-graphql


chargome Jul 7, 2026
fdb5cdb

comments


chargome Jul 7, 2026
f55fe03

Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…


chargome Jul 8, 2026
5d25505

ref(server-utils): Align orchestrion graphql with the native subscrib…


chargome Jul 8, 2026
9d96ebd

Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…


chargome Jul 8, 2026
60f0f90

Merge remote-tracking branch 'origin/develop' into cg/orchestrion-gra…


chargome Jul 8, 2026
77c5ce8

size


chargome Jul 8, 2026
b5a9b27

pr feedback


chargome Jul 8, 2026
e2776ec

Merge branch 'develop' into cg/orchestrion-graphql


chargome Jul 9, 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


2 changes: 1 addition & 1 deletion
.size-limit.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -400,7 +400,7 @@ module.exports = [
 import: createImport('init', 'experimentalUseDiagnosticsChannelInjection'),
 ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
 gzip: true,
 limit: '136 KB',
 limit: '140 KB',
 disablePlugins: ['@size-limit/esbuild'],
 },
 {
Expand Down

16 changes: 16 additions & 0 deletions
...packages/node-integration-tests/suites/tracing/apollo-graphql/resolvers/instrument-dc.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

// Configure graphql on the diagnostics-channel injection path: opt in, then pass the matching
// `diagnosticsChannelInjectionIntegrations()` entry explicitly so its options (here
// `ignoreResolveSpans: false`) apply. This explicit instance wins over the default one the opt-in swaps in.
const { graphqlIntegration } = Sentry.diagnosticsChannelInjectionIntegrations();
Sentry.experimentalUseDiagnosticsChannelInjection();

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 tracesSampleRate: 1.0,
 integrations: [graphqlIntegration({ ignoreResolveSpans: false })],
 transport: loggingTransport,
});

39 changes: 39 additions & 0 deletions
dev-packages/node-integration-tests/suites/tracing/apollo-graphql/resolvers/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,4 +49,43 @@ describe('GraphQL/Apollo Tests > resolve spans', () => {
 .completed();
 });
 });

 // Same behavior on the diagnostics-channel path: passing the channel integration explicitly (see
 // instrument-dc.mjs) must carry `ignoreResolveSpans: false` through — the explicit instance wins over
 // the swapped-in default — and emit resolve spans with the orchestrion origin.
 const EXPECTED_ORCHESTRION_TRANSACTION = {
 transaction: 'Test Transaction (query)',
 spans: expect.arrayContaining([
 expect.objectContaining({
 description: 'query',
 origin: 'auto.graphql.diagnostic_channel',
 data: expect.objectContaining({
 'graphql.operation.type': 'query',
 'graphql.document': '{hello}',
 'sentry.origin': 'auto.graphql.diagnostic_channel',
 }),
 }),
 expect.objectContaining({ description: 'graphql.parse' }),
 expect.objectContaining({ description: 'graphql.validate' }),
 expect.objectContaining({
 description: 'graphql.resolve hello',
 data: expect.objectContaining({
 'graphql.field.name': 'hello',
 'graphql.field.path': 'hello',
 'graphql.field.type': 'String',
 'graphql.parent.name': 'Query',
 }),
 }),
 ]),
 };

 createEsmAndCjsTests(__dirname, 'scenario-query.mjs', 'instrument-dc.mjs', (createTestRunner, test) => {
 test('emits resolve spans via diagnostics-channel injection when configured explicitly', async () => {
 await createTestRunner()
 .expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
 .expect({ transaction: EXPECTED_ORCHESTRION_TRANSACTION })
 .start()
 .completed();
 });
 });
});

79 changes: 42 additions & 37 deletions
dev-packages/node-integration-tests/suites/tracing/apollo-graphql/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,39 @@
import { afterAll, describe, expect } from 'vitest';
import { isOrchestrionEnabled } from '../../../utils';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';

// Server start transaction (Apollo Server v5 no longer runs introspection query on start)
const EXPECTED_START_SERVER_TRANSACTION = {
 transaction: 'Test Server Start',
};

// apollo uses graphql v16, so the default run instruments it via the vendored OTel patcher and the
// orchestrion run (auto-injected on CI) via the diagnostics-channel path. Both emit the same span
// name/status; the origin and the document attribute (`graphql.source` vs `graphql.document`) differ.
const orchestrion = isOrchestrionEnabled();
const ORIGIN = orchestrion ? 'auto.graphql.diagnostic_channel' : 'auto.graphql.otel.graphql';

function graphqlExecuteSpan(opts: {
 description: string;
 operationType: string;
 operationName?: string;
 document: unknown;
 status?: string;
}): ReturnType<typeof expect.objectContaining> {
 const { description, operationType, operationName, document, status = 'ok' } = opts;
 return expect.objectContaining({
 description,
 status,
 origin: ORIGIN,
 data: expect.objectContaining({
 'graphql.operation.type': operationType,
 ...(operationName ? { 'graphql.operation.name': operationName } : {}),
 [orchestrion ? 'graphql.document' : 'graphql.source']: document,
 'sentry.origin': ORIGIN,
 }),
 });
}

describe('GraphQL/Apollo Tests', () => {
 afterAll(() => {
 cleanupChildProcesses();
Expand All@@ -15,16 +43,7 @@ describe('GraphQL/Apollo Tests', () => {
 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',
 }),
 graphqlExecuteSpan({ description: 'query', operationType: 'query', document: '{hello}' }),
 ]),
 };

Expand All@@ -50,16 +69,11 @@ describe('GraphQL/Apollo Tests', () => {
 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',
 },
 graphqlExecuteSpan({
 description: 'mutation Mutation',
 status: 'ok',
 origin: 'auto.graphql.otel.graphql',
 operationType: 'mutation',
 operationName: 'Mutation',
 document: 'mutation Mutation($email: String) {\n login(email: $email)\n}',
 }),
 ]),
 };
Expand All@@ -86,16 +100,11 @@ describe('GraphQL/Apollo Tests', () => {
 const EXPECTED_TRANSACTION = {
 transaction: 'Test Transaction (mutation)',
 spans: expect.arrayContaining([
 expect.objectContaining({
 // The inline email literal must be redacted to `"*"`, so the raw value never reaches the span.
 graphqlExecuteSpan({
 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',
 }),
 operationType: 'mutation',
 document: expect.stringContaining('login(email: "*")'),
 }),
 ]),
 };
Expand All@@ -105,7 +114,7 @@ describe('GraphQL/Apollo Tests', () => {
 'scenario-redaction.mjs',
 'instrument.mjs',
 (createTestRunner, test) => {
 test('redacts inline literal values from graphql.source.', async () => {
 test('redacts inline literal values from the graphql document.', async () => {
 await createTestRunner()
 .expect({ transaction: EXPECTED_START_SERVER_TRANSACTION })
 .expect({ transaction: EXPECTED_TRANSACTION })
Expand All@@ -122,16 +131,12 @@ describe('GraphQL/Apollo Tests', () => {
 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',
 },
 graphqlExecuteSpan({
 description: 'mutation Mutation',
 operationType: 'mutation',
 operationName: 'Mutation',
 document: 'mutation Mutation($email: String) {\n login(email: $email)\n}',
 status: 'internal_error',
 origin: 'auto.graphql.otel.graphql',
 }),
 ]),
 };
Expand Down

178 changes: 26 additions & 152 deletions
packages/node/src/integrations/tracing/graphql/vendored/graphql-types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,152 +1,26 @@
/*
 * Simplified types inlined from the `graphql` package.
 * Only includes members accessed by this instrumentation.
 */

export type PromiseOrValue<T> = T | Promise<T>;

export type Maybe<T> = null | undefined | T;

export interface Location {
 start: number;
 end: number;
 startToken: Token;
 source: Source;
 [key: string]: any;
}

export interface Token {
 kind: string;
 start: number;
 end: number;
 line: number;
 column: number;
 value: string;
 prev: Token | null;
 next: Token | null;
 [key: string]: any;
}

export interface Source {
 body: string;
 name: string;
 locationOffset: Location;
 [key: string]: any;
}

export interface DocumentNode {
 kind: string;
 definitions: ReadonlyArray<DefinitionNode>;
 loc?: Location;
 [key: string]: any;
}

export interface DefinitionNode {
 kind: string;
 loc?: Location;
 [key: string]: any;
}

export interface OperationDefinitionNode extends DefinitionNode {
 operation: string;
 name?: { kind: string; value: string; loc?: Location };
 [key: string]: any;
}

export interface ParseOptions {
 noLocation?: boolean;
 [key: string]: any;
}

export interface ExecutionArgs {
 schema: GraphQLSchema;
 document: DocumentNode;
 rootValue?: any;
 contextValue?: any;
 variableValues?: Maybe<{ [key: string]: any }>;
 operationName?: Maybe<string>;
 fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
 typeResolver?: Maybe<GraphQLTypeResolver<any, any>>;
 [key: string]: any;
}

export interface ExecutionResult {
 errors?: ReadonlyArray<GraphQLError>;
 data?: Record<string, any> | null;
 [key: string]: any;
}

export interface GraphQLError {
 message: string;
 locations?: ReadonlyArray<{ line: number; column: number }>;
 path?: ReadonlyArray<string | number>;
 [key: string]: any;
}

export interface GraphQLSchema {
 getQueryType(): GraphQLObjectType | undefined | null;
 getMutationType(): GraphQLObjectType | undefined | null;
 [key: string]: any;
}

export interface GraphQLObjectType {
 name: string;
 getFields(): { [key: string]: GraphQLField };
 [key: string]: any;
}

export interface GraphQLField {
 name: string;
 type: GraphQLOutputType;
 resolve?: GraphQLFieldResolver<any, any>;
 [key: string]: any;
}

export type GraphQLOutputType = GraphQLNamedOutputType | GraphQLWrappingType;

interface GraphQLNamedOutputType {
 name: string;
 [key: string]: any;
}

interface GraphQLWrappingType {
 ofType: GraphQLOutputType;
 [key: string]: any;
}

export interface GraphQLUnionType {
 name: string;
 getTypes(): ReadonlyArray<GraphQLObjectType>;
 [key: string]: any;
}

export type GraphQLType = GraphQLOutputType | GraphQLUnionType;

export type GraphQLFieldResolver<TSource, TContext, TArgs = any> = (
 source: TSource,
 args: TArgs,
 context: TContext,
 info: GraphQLResolveInfo,
) => any;

export type GraphQLTypeResolver<TSource, TContext> = (
 value: TSource,
 context: TContext,
 info: GraphQLResolveInfo,
 abstractType: any,
) => any;

export interface GraphQLResolveInfo {
 fieldName: string;
 fieldNodes: ReadonlyArray<{ kind: string; loc?: Location; [key: string]: any }>;
 returnType: { toString(): string; [key: string]: any };
 parentType: { name: string; [key: string]: any };
 path: any;
 [key: string]: any;
}

export type ValidationRule = any;

export interface TypeInfo {
 [key: string]: any;
}
// Single source of truth for the structural graphql types, shared with the orchestrion graphql
// integration in `@sentry/server-utils` so the two can't drift.
export type {
 DefinitionNode,
 DocumentNode,
 ExecutionArgs,
 ExecutionResult,
 GraphQLError,
 GraphQLFieldResolver,
 GraphQLObjectType,
 GraphQLOutputType,
 GraphQLResolveInfo,
 GraphQLSchema,
 GraphQLType,
 GraphQLTypeResolver,
 GraphQLUnionType,
 Location,
 Maybe,
 OperationDefinitionNode,
 ParseOptions,
 PromiseOrValue,
 Source,
 Token,
 TypeInfo,
 ValidationRule,
} from '@sentry/server-utils/orchestrion';

2 changes: 1 addition & 1 deletion
packages/node/src/integrations/tracing/graphql/vendored/instrumentation.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -367,7 +367,7 @@ export class GraphQLInstrumentation extends InstrumentationBase<GraphQLInstrumen
 });
 }

 private _createExecuteSpan(operation: DefinitionNode | undefined, processedArgs: ExecutionArgs): Span {
 private _createExecuteSpan(operation: DefinitionNode | undefined, processedArgs: OtelExecutionArgs): Span {
 const span = startInactiveSpan({
 name: SpanNames.EXECUTE,
 attributes: { [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: ORIGIN },
Expand Down
Loading
Loading