feat(node): Add useOperationNameForRootSpan tographqlIntegration - #13248

Merged
mydea merged 9 commits into
developfrom
fn/graphql-root-spans
Aug 8, 2024
Merged

feat(node): Add useOperationNameForRootSpan tographqlIntegration#13248
mydea merged 9 commits into
developfrom
fn/graphql-root-spans

Conversation

@mydea

@mydeamydea commented Aug 6, 2024•
edited
Loading

Copy link
Copy Markdown
Member

This introduces a new option for the graphqlIntegration, useOperationNameForRootSpan, which is by default true but can be disabled in integration settings like this: Sentry.graphqlIntegration({ useOperationNameForRootSpan: true }).

With this setting enabled, the graphql instrumentation will update the http.server root span it is in (if there is one) will be appended to the span name. So instead of having all root spans be POST /graphql, the names will now be e.g. POST /graphql (query MyQuery).

If there are multiple operations in a single http request, they will be appended like POST /graphql (query Query1, query Query2), up to a limit of 5, at which point they will be appended as +2 or similar.

Closes#13238

@mydeamydea self-assigned this Aug 6, 2024
mydea
mydea commented Aug 6, 2024
View reviewed changes
Comment threadpackages/opentelemetry/src/utils/spanTypes.ts Outdated
export function spanHasKind<SpanType extends AbstractSpan>(span: SpanType): span is SpanType & { kind: SpanKind } {
const castSpan = span as ReadableSpan;
return !!castSpan.kind;
return 'kind' in castSpan;

@mydeamydeaAug 6, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noticed this was actually incorrect because this may be 0!

@github-actions

github-actionsBot commented Aug 6, 2024•
edited
Loading

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize
@sentry/browser22.47 KB (0%)
@sentry/browser (incl. Tracing)34.26 KB (0%)
@sentry/browser (incl. Tracing, Replay)70.31 KB (0%)
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags63.64 KB (0%)
@sentry/browser (incl. Tracing, Replay with Canvas)74.71 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback)87.32 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback, metrics)89.16 KB (0%)
@sentry/browser (incl. metrics)26.77 KB (0%)
@sentry/browser (incl. Feedback)39.42 KB (0%)
@sentry/browser (incl. sendFeedback)27.09 KB (0%)
@sentry/browser (incl. FeedbackAsync)31.75 KB (0%)
@sentry/react25.24 KB (0%)
@sentry/react (incl. Tracing)37.25 KB (0%)
@sentry/vue26.62 KB (0%)
@sentry/vue (incl. Tracing)36.1 KB (0%)
@sentry/svelte22.61 KB (0%)
CDN Bundle23.69 KB (0%)
CDN Bundle (incl. Tracing)35.93 KB (0%)
CDN Bundle (incl. Tracing, Replay)70.36 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback)75.61 KB (0%)
CDN Bundle - uncompressed69.52 KB (0%)
CDN Bundle (incl. Tracing) - uncompressed106.43 KB (0%)
CDN Bundle (incl. Tracing, Replay) - uncompressed218.27 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed231.16 KB (0%)
@sentry/nextjs (client)37.1 KB (0%)
@sentry/sveltekit (client)34.81 KB (0%)
@sentry/node115.07 KB (+0.19% 🔺)
@sentry/node - without tracing89.43 KB (+0.12% 🔺)
@sentry/aws-serverless98.85 KB (+0.36% 🔺)

@mydeamydea mentioned this pull request Aug 6, 2024
Merged
mydea
mydea commented Aug 6, 2024
View reviewed changes
Comment threadpackages/node/src/integrations/tracing/graphql.ts
@mydea
mydea requested a review from lforstAugust 6, 2024 14:00
@mjq

mjq commented Aug 6, 2024

Copy link
Copy Markdown
Member

Should we be concerned about transaction name cardinality here? This is a client-controlled field supporting arbitrary values. I'm not sure true is a safe default. At the very least we should advise that useOperationNameForRootSpan be false for public APIs, but it's only really cardinality-safe if your API only permits allowlisted queries.

@lforst

lforst commented Aug 6, 2024

Copy link
Copy Markdown
Contributor

@mjq I would consider gql queries like these to be low cardinality. Why would you say this is hight cardinality? I think this is comparable to normal api route paths (?).

@mydea

mydea commented Aug 6, 2024

Copy link
Copy Markdown
MemberAuthor

@mjq I would consider gql queries like these to be low cardinality. Why would you say this is hight cardinality? I think this is comparable to normal api route paths (?).

I agree - remember this is only using the operation name, not the query. So e.g. if your query is this:

queryMyQuery(id) {
user(id): User
}

it would only capture query MyQuery, which should not be too high cardinality.

@mjq

mjq commented Aug 6, 2024

Copy link
Copy Markdown
Member

@lforst@mydea If your only client is internal, it ought to be low cardinality and work well as a grouping mechanism. If it's a public API, every caller will use their own query names, meaning cardinality is effectively unbounded (and it seems less useful as a grouping mechanism since you don't control the grouping yourself). And every API is de facto a public API without further defence mechanisms 😅

The main differences from e.g. rest API URLs is that a well-configured SDK is immune to high cardinality no matter what a client sends, and a poorly-configured one can still have its cardinality reduced by our URL normalizer.

It's fine if the answer is "no we shouldn't be concerned", and treat this as an unlikely hypothetical. We aren't forwarding the cardinality cost to users so e.g. malicious use only affects Sentry, not our users' wallets, and we're giving anyone with concerns an off switch.

@mydea

mydea commented Aug 7, 2024

Copy link
Copy Markdown
MemberAuthor

Ah, I see what you mean.
My POV is that users can turn this off, and I'd say it is def. better with this setting than without for the vast majority of cases. Right now the cardinality is low to the point of it being useless - you just see POST /graphl as transaction name for every issue etc, and literally all your graphql queries will be grouped into a single transaction, which is also def. not helpful :D

@andreiborzaandreiborza mentioned this pull request Aug 7, 2024
Closed
3 tasks
lforst
lforst approved these changes Aug 8, 2024
View reviewed changes

@lforstlforst left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is one thing that needs addressing, otherwise lgtm!

Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts Outdated
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts
Comment threadpackages/opentelemetry/src/utils/spanTypes.ts
export function spanHasKind<SpanType extends AbstractSpan>(span: SpanType): span is SpanType & { kind: SpanKind } {
const castSpan = span as ReadableSpan;
return !!castSpan.kind;
return typeof castSpan.kind === 'number';

@lforstlforstAug 8, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

m: Quick explainer for this?

@mydeamydeaAug 8, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry, had a comment here earlier but changed it again - this check was actually wrong, because this can be 0 which is valid, but we interpreted this as no kind before.

@mydea
mydeaforce-pushed the fn/graphql-root-spans branch from 707babf to f71275cCompareAugust 8, 2024 09:09
@mydea
mydea merged commit 0ca8821 into developAug 8, 2024
@mydea
mydea deleted the fn/graphql-root-spans branch August 8, 2024 12:15
@mydeamydea mentioned this pull request Aug 16, 2024
Closed
@gokulk16gokulk16 mentioned this pull request Aug 30, 2024
Merged
@angelorealeangeloreale mentioned this pull request Aug 30, 2024
Open
@angelorealeangeloreale mentioned this pull request Aug 30, 2024
Open
This was referenced Aug 30, 2024
Closed
Closed
@q1blueq1blue mentioned this pull request Aug 30, 2024
Open
@angelorealeangeloreale mentioned this pull request Aug 31, 2024
Open
@FengShangWuQiFengShangWuQi mentioned this pull request Sep 1, 2024
Closed
@PierreGodePierreGode mentioned this pull request Sep 4, 2024
Closed
This was referenced Sep 4, 2024
Closed
Closed
@q1blueq1blue mentioned this pull request Sep 7, 2024
Open
@FengShangWuQiFengShangWuQi mentioned this pull request Sep 8, 2024
Closed
@bagulm123bagulm123 mentioned this pull request Sep 8, 2024
Open
@KeeghanMKeeghanM mentioned this pull request Sep 12, 2024
Merged
This was referenced Sep 13, 2024
Open
Open
@gokulk16gokulk16 mentioned this pull request Sep 23, 2024
Closed
@q1blueq1blue mentioned this pull request Sep 24, 2024
Open
This was referenced Sep 24, 2024
Closed
Closed
@FengShangWuQiFengShangWuQi mentioned this pull request Sep 27, 2024
Closed
This was referenced Sep 27, 2024
Open
Open
@bagulm123bagulm123 mentioned this pull request Oct 1, 2024
Open
@q1blueq1blue mentioned this pull request Oct 1, 2024
Open
This was referenced Dec 10, 2024
Closed
Closed
@s1gr1d

s1gr1d commented Dec 10, 2024

Copy link
Copy Markdown
Member

I added a docs issue for this as this is not documented yet: getsentry/sentry-docs#12080

@s1gr1ds1gr1d mentioned this pull request Dec 13, 2024
Merged
6 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AbhiPrasadAbhiPrasadAwaiting requested review from AbhiPrasad
@andreiborzaandreiborzaAwaiting requested review from andreiborza
1 more reviewer
@lforstlforstlforst approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@mydeamydea

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add graphql integration option to automatically rename root spans based on graphql.operation.name

4 participants

@mydea@mjq@lforst@s1gr1d
, '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(node): Add useOperationNameForRootSpan tographqlIntegration - #13248
Merged
mydea merged 9 commits into
developfrom 
fn/graphql-root-spans
Aug 8, 2024
Merged
feat(node): Add useOperationNameForRootSpan tographqlIntegration#13248
mydea merged 9 commits into
developfrom 
fn/graphql-root-spans
Conversation
@mydea
@mydeamydea
commented
Aug 6, 2024•

edited

Loading

Copy link


Copy Markdown

Member
This introduces a new option for the graphqlIntegration, useOperationNameForRootSpan, which is by default true but can be disabled in integration settings like this: Sentry.graphqlIntegration({ useOperationNameForRootSpan: true }).
With this setting enabled, the graphql instrumentation will update the http.server root span it is in (if there is one) will be appended to the span name. So instead of having all root spans be POST /graphql, the names will now be e.g. POST /graphql (query MyQuery).
If there are multiple operations in a single http request, they will be appended like POST /graphql (query Query1, query Query2), up to a limit of 5, at which point they will be appended as +2 or similar.
Closes#13238
@mydeamydea
self-assigned this
Aug 6, 2024
mydea
mydea
commented
Aug 6, 2024
View reviewed changes
Comment threadpackages/opentelemetry/src/utils/spanTypes.ts
Outdated

export function spanHasKind<SpanType extends AbstractSpan>(span: SpanType): span is SpanType & { kind: SpanKind } {
 const castSpan = span as ReadableSpan;
 return !!castSpan.kind;
 return 'kind' in castSpan;
@mydeamydeaAug 6, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noticed this was actually incorrect because this may be 0!
@github-actions
github-actionsBot
commented
Aug 6, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
PathSize
@sentry/browser22.47 KB (0%)
@sentry/browser (incl. Tracing)34.26 KB (0%)
@sentry/browser (incl. Tracing, Replay)70.31 KB (0%)
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags63.64 KB (0%)
@sentry/browser (incl. Tracing, Replay with Canvas)74.71 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback)87.32 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback, metrics)89.16 KB (0%)
@sentry/browser (incl. metrics)26.77 KB (0%)
@sentry/browser (incl. Feedback)39.42 KB (0%)
@sentry/browser (incl. sendFeedback)27.09 KB (0%)
@sentry/browser (incl. FeedbackAsync)31.75 KB (0%)
@sentry/react25.24 KB (0%)
@sentry/react (incl. Tracing)37.25 KB (0%)
@sentry/vue26.62 KB (0%)
@sentry/vue (incl. Tracing)36.1 KB (0%)
@sentry/svelte22.61 KB (0%)
CDN Bundle23.69 KB (0%)
CDN Bundle (incl. Tracing)35.93 KB (0%)
CDN Bundle (incl. Tracing, Replay)70.36 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback)75.61 KB (0%)
CDN Bundle - uncompressed69.52 KB (0%)
CDN Bundle (incl. Tracing) - uncompressed106.43 KB (0%)
CDN Bundle (incl. Tracing, Replay) - uncompressed218.27 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed231.16 KB (0%)
@sentry/nextjs (client)37.1 KB (0%)
@sentry/sveltekit (client)34.81 KB (0%)
@sentry/node115.07 KB (+0.19% 🔺)
@sentry/node - without tracing89.43 KB (+0.12% 🔺)
@sentry/aws-serverless98.85 KB (+0.36% 🔺)
@mydeamydea
mentioned this pull request
Aug 6, 2024
 Merged

mydea
mydea
commented
Aug 6, 2024
View reviewed changes
Comment threadpackages/node/src/integrations/tracing/graphql.ts
@mydea
mydea
requested a review
from lforstAugust 6, 2024 14:00
@mjq
mjq
commented
Aug 6, 2024

Copy link


Copy Markdown

Member
Should we be concerned about transaction name cardinality here? This is a client-controlled field supporting arbitrary values. I'm not sure true is a safe default. At the very least we should advise that useOperationNameForRootSpan be false for public APIs, but it's only really cardinality-safe if your API only permits allowlisted queries.
@lforst
lforst
commented
Aug 6, 2024

Copy link


Copy Markdown

Contributor
@mjq I would consider gql queries like these to be low cardinality. Why would you say this is hight cardinality? I think this is comparable to normal api route paths (?).
@mydea
mydea
commented
Aug 6, 2024

Copy link


Copy Markdown

MemberAuthor
@mjq I would consider gql queries like these to be low cardinality. Why would you say this is hight cardinality? I think this is comparable to normal api route paths (?).
I agree - remember this is only using the operation name, not the query. So e.g. if your query is this:
queryMyQuery(id) {
user(id): User
}
it would only capture query MyQuery, which should not be too high cardinality.
@mjq
mjq
commented
Aug 6, 2024

Copy link


Copy Markdown

Member
@lforst@mydea If your only client is internal, it ought to be low cardinality and work well as a grouping mechanism. If it's a public API, every caller will use their own query names, meaning cardinality is effectively unbounded (and it seems less useful as a grouping mechanism since you don't control the grouping yourself). And every API is de facto a public API without further defence mechanisms 😅
The main differences from e.g. rest API URLs is that a well-configured SDK is immune to high cardinality no matter what a client sends, and a poorly-configured one can still have its cardinality reduced by our URL normalizer.
It's fine if the answer is "no we shouldn't be concerned", and treat this as an unlikely hypothetical. We aren't forwarding the cardinality cost to users so e.g. malicious use only affects Sentry, not our users' wallets, and we're giving anyone with concerns an off switch.
@mydea
mydea
commented
Aug 7, 2024

Copy link


Copy Markdown

MemberAuthor
Ah, I see what you mean.

My POV is that users can turn this off, and I'd say it is def. better with this setting than without for the vast majority of cases. Right now the cardinality is low to the point of it being useless - you just see POST /graphl as transaction name for every issue etc, and literally all your graphql queries will be grouped into a single transaction, which is also def. not helpful :D
@andreiborzaandreiborza
mentioned this pull request
Aug 7, 2024

Closed

3 tasks
lforst
lforst
approved these changes
Aug 8, 2024
View reviewed changes
@lforstlforst
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is one thing that needs addressing, otherwise lgtm!
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts
Outdated

Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts
Outdated

Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts
Comment threadpackages/opentelemetry/src/utils/spanTypes.ts
export function spanHasKind<SpanType extends AbstractSpan>(span: SpanType): span is SpanType & { kind: SpanKind } {
 const castSpan = span as ReadableSpan;
 return !!castSpan.kind;
 return typeof castSpan.kind === 'number';
@lforstlforstAug 8, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

m: Quick explainer for this?
@mydeamydeaAug 8, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry, had a comment here earlier but changed it again - this check was actually wrong, because this can be 0 which is valid, but we interpreted this as no kind before.
@mydea
mydeaforce-pushed
the
fn/graphql-root-spans
branch
from
707babf to
f71275cCompareAugust 8, 2024 09:09
@mydea
mydea
merged commit 0ca8821
into
developAug 8, 2024
@mydea
mydea
deleted the

fn/graphql-root-spans

branch
August 8, 2024 12:15
@mydeamydea
mentioned this pull request
Aug 16, 2024

Closed

@gokulk16gokulk16
mentioned this pull request
Aug 30, 2024
 Merged

@angelorealeangeloreale
mentioned this pull request
Aug 30, 2024
 Open

@angelorealeangeloreale
mentioned this pull request
Aug 30, 2024
 Open


This was referenced Aug 30, 2024
 Closed

 Closed

@q1blueq1blue
mentioned this pull request
Aug 30, 2024
 Open

@angelorealeangeloreale
mentioned this pull request
Aug 31, 2024
 Open

@FengShangWuQiFengShangWuQi
mentioned this pull request
Sep 1, 2024
 Closed

@PierreGodePierreGode
mentioned this pull request
Sep 4, 2024
 Closed


This was referenced Sep 4, 2024
 Closed

 Closed

@q1blueq1blue
mentioned this pull request
Sep 7, 2024
 Open

@FengShangWuQiFengShangWuQi
mentioned this pull request
Sep 8, 2024
 Closed

@bagulm123bagulm123
mentioned this pull request
Sep 8, 2024
 Open

@KeeghanMKeeghanM
mentioned this pull request
Sep 12, 2024
 Merged


This was referenced Sep 13, 2024
 Open

 Open

@gokulk16gokulk16
mentioned this pull request
Sep 23, 2024
 Closed

@q1blueq1blue
mentioned this pull request
Sep 24, 2024
 Open


This was referenced Sep 24, 2024
 Closed

 Closed

@FengShangWuQiFengShangWuQi
mentioned this pull request
Sep 27, 2024
 Closed


This was referenced Sep 27, 2024
 Open

 Open

@bagulm123bagulm123
mentioned this pull request
Oct 1, 2024
 Open

@q1blueq1blue
mentioned this pull request
Oct 1, 2024
 Open


This was referenced Dec 10, 2024

Closed


Closed

@s1gr1d
s1gr1d
commented
Dec 10, 2024

Copy link


Copy Markdown

Member
I added a docs issue for this as this is not documented yet: getsentry/sentry-docs#12080
@s1gr1ds1gr1d
mentioned this pull request
Dec 13, 2024
 Merged

6 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@AbhiPrasadAbhiPrasadAwaiting requested review from AbhiPrasad
@andreiborzaandreiborzaAwaiting requested review from andreiborza

1 more reviewer

@lforstlforstlforst approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@mydeamydea

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Add graphql integration option to automatically rename root spans based on graphql.operation.name

4 participants

@mydea@mjq@lforst@s1gr1d

, '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(node): Add useOperationNameForRootSpan tographqlIntegration - #13248
Merged
mydea merged 9 commits into
developfrom 
fn/graphql-root-spans
Aug 8, 2024
Merged
feat(node): Add useOperationNameForRootSpan tographqlIntegration#13248
mydea merged 9 commits into
developfrom 
fn/graphql-root-spans
Conversation
@mydea
@mydeamydea
commented
Aug 6, 2024•

edited

Loading

Copy link


Copy Markdown

Member
This introduces a new option for the graphqlIntegration, useOperationNameForRootSpan, which is by default true but can be disabled in integration settings like this: Sentry.graphqlIntegration({ useOperationNameForRootSpan: true }).
With this setting enabled, the graphql instrumentation will update the http.server root span it is in (if there is one) will be appended to the span name. So instead of having all root spans be POST /graphql, the names will now be e.g. POST /graphql (query MyQuery).
If there are multiple operations in a single http request, they will be appended like POST /graphql (query Query1, query Query2), up to a limit of 5, at which point they will be appended as +2 or similar.
Closes#13238
@mydeamydea
self-assigned this
Aug 6, 2024
mydea
mydea
commented
Aug 6, 2024
View reviewed changes
Comment threadpackages/opentelemetry/src/utils/spanTypes.ts
Outdated

export function spanHasKind<SpanType extends AbstractSpan>(span: SpanType): span is SpanType & { kind: SpanKind } {
 const castSpan = span as ReadableSpan;
 return !!castSpan.kind;
 return 'kind' in castSpan;
@mydeamydeaAug 6, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noticed this was actually incorrect because this may be 0!
@github-actions
github-actionsBot
commented
Aug 6, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
PathSize
@sentry/browser22.47 KB (0%)
@sentry/browser (incl. Tracing)34.26 KB (0%)
@sentry/browser (incl. Tracing, Replay)70.31 KB (0%)
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags63.64 KB (0%)
@sentry/browser (incl. Tracing, Replay with Canvas)74.71 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback)87.32 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback, metrics)89.16 KB (0%)
@sentry/browser (incl. metrics)26.77 KB (0%)
@sentry/browser (incl. Feedback)39.42 KB (0%)
@sentry/browser (incl. sendFeedback)27.09 KB (0%)
@sentry/browser (incl. FeedbackAsync)31.75 KB (0%)
@sentry/react25.24 KB (0%)
@sentry/react (incl. Tracing)37.25 KB (0%)
@sentry/vue26.62 KB (0%)
@sentry/vue (incl. Tracing)36.1 KB (0%)
@sentry/svelte22.61 KB (0%)
CDN Bundle23.69 KB (0%)
CDN Bundle (incl. Tracing)35.93 KB (0%)
CDN Bundle (incl. Tracing, Replay)70.36 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback)75.61 KB (0%)
CDN Bundle - uncompressed69.52 KB (0%)
CDN Bundle (incl. Tracing) - uncompressed106.43 KB (0%)
CDN Bundle (incl. Tracing, Replay) - uncompressed218.27 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed231.16 KB (0%)
@sentry/nextjs (client)37.1 KB (0%)
@sentry/sveltekit (client)34.81 KB (0%)
@sentry/node115.07 KB (+0.19% 🔺)
@sentry/node - without tracing89.43 KB (+0.12% 🔺)
@sentry/aws-serverless98.85 KB (+0.36% 🔺)
@mydeamydea
mentioned this pull request
Aug 6, 2024
 Merged

mydea
mydea
commented
Aug 6, 2024
View reviewed changes
Comment threadpackages/node/src/integrations/tracing/graphql.ts
@mydea
mydea
requested a review
from lforstAugust 6, 2024 14:00
@mjq
mjq
commented
Aug 6, 2024

Copy link


Copy Markdown

Member
Should we be concerned about transaction name cardinality here? This is a client-controlled field supporting arbitrary values. I'm not sure true is a safe default. At the very least we should advise that useOperationNameForRootSpan be false for public APIs, but it's only really cardinality-safe if your API only permits allowlisted queries.
@lforst
lforst
commented
Aug 6, 2024

Copy link


Copy Markdown

Contributor
@mjq I would consider gql queries like these to be low cardinality. Why would you say this is hight cardinality? I think this is comparable to normal api route paths (?).
@mydea
mydea
commented
Aug 6, 2024

Copy link


Copy Markdown

MemberAuthor
@mjq I would consider gql queries like these to be low cardinality. Why would you say this is hight cardinality? I think this is comparable to normal api route paths (?).
I agree - remember this is only using the operation name, not the query. So e.g. if your query is this:
queryMyQuery(id) {
user(id): User
}
it would only capture query MyQuery, which should not be too high cardinality.
@mjq
mjq
commented
Aug 6, 2024

Copy link


Copy Markdown

Member
@lforst@mydea If your only client is internal, it ought to be low cardinality and work well as a grouping mechanism. If it's a public API, every caller will use their own query names, meaning cardinality is effectively unbounded (and it seems less useful as a grouping mechanism since you don't control the grouping yourself). And every API is de facto a public API without further defence mechanisms 😅
The main differences from e.g. rest API URLs is that a well-configured SDK is immune to high cardinality no matter what a client sends, and a poorly-configured one can still have its cardinality reduced by our URL normalizer.
It's fine if the answer is "no we shouldn't be concerned", and treat this as an unlikely hypothetical. We aren't forwarding the cardinality cost to users so e.g. malicious use only affects Sentry, not our users' wallets, and we're giving anyone with concerns an off switch.
@mydea
mydea
commented
Aug 7, 2024

Copy link


Copy Markdown

MemberAuthor
Ah, I see what you mean.

My POV is that users can turn this off, and I'd say it is def. better with this setting than without for the vast majority of cases. Right now the cardinality is low to the point of it being useless - you just see POST /graphl as transaction name for every issue etc, and literally all your graphql queries will be grouped into a single transaction, which is also def. not helpful :D
@andreiborzaandreiborza
mentioned this pull request
Aug 7, 2024

Closed

3 tasks
lforst
lforst
approved these changes
Aug 8, 2024
View reviewed changes
@lforstlforst
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is one thing that needs addressing, otherwise lgtm!
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts
Outdated

Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts
Outdated

Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts
Comment threadpackages/opentelemetry/src/utils/spanTypes.ts
export function spanHasKind<SpanType extends AbstractSpan>(span: SpanType): span is SpanType & { kind: SpanKind } {
 const castSpan = span as ReadableSpan;
 return !!castSpan.kind;
 return typeof castSpan.kind === 'number';
@lforstlforstAug 8, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

m: Quick explainer for this?
@mydeamydeaAug 8, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry, had a comment here earlier but changed it again - this check was actually wrong, because this can be 0 which is valid, but we interpreted this as no kind before.
@mydea
mydeaforce-pushed
the
fn/graphql-root-spans
branch
from
707babf to
f71275cCompareAugust 8, 2024 09:09
@mydea
mydea
merged commit 0ca8821
into
developAug 8, 2024
@mydea
mydea
deleted the

fn/graphql-root-spans

branch
August 8, 2024 12:15
@mydeamydea
mentioned this pull request
Aug 16, 2024

Closed

@gokulk16gokulk16
mentioned this pull request
Aug 30, 2024
 Merged

@angelorealeangeloreale
mentioned this pull request
Aug 30, 2024
 Open

@angelorealeangeloreale
mentioned this pull request
Aug 30, 2024
 Open


This was referenced Aug 30, 2024
 Closed

 Closed

@q1blueq1blue
mentioned this pull request
Aug 30, 2024
 Open

@angelorealeangeloreale
mentioned this pull request
Aug 31, 2024
 Open

@FengShangWuQiFengShangWuQi
mentioned this pull request
Sep 1, 2024
 Closed

@PierreGodePierreGode
mentioned this pull request
Sep 4, 2024
 Closed


This was referenced Sep 4, 2024
 Closed

 Closed

@q1blueq1blue
mentioned this pull request
Sep 7, 2024
 Open

@FengShangWuQiFengShangWuQi
mentioned this pull request
Sep 8, 2024
 Closed

@bagulm123bagulm123
mentioned this pull request
Sep 8, 2024
 Open

@KeeghanMKeeghanM
mentioned this pull request
Sep 12, 2024
 Merged


This was referenced Sep 13, 2024
 Open

 Open

@gokulk16gokulk16
mentioned this pull request
Sep 23, 2024
 Closed

@q1blueq1blue
mentioned this pull request
Sep 24, 2024
 Open


This was referenced Sep 24, 2024
 Closed

 Closed

@FengShangWuQiFengShangWuQi
mentioned this pull request
Sep 27, 2024
 Closed


This was referenced Sep 27, 2024
 Open

 Open

@bagulm123bagulm123
mentioned this pull request
Oct 1, 2024
 Open

@q1blueq1blue
mentioned this pull request
Oct 1, 2024
 Open


This was referenced Dec 10, 2024

Closed


Closed

@s1gr1d
s1gr1d
commented
Dec 10, 2024

Copy link


Copy Markdown

Member
I added a docs issue for this as this is not documented yet: getsentry/sentry-docs#12080
@s1gr1ds1gr1d
mentioned this pull request
Dec 13, 2024
 Merged

6 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@AbhiPrasadAbhiPrasadAwaiting requested review from AbhiPrasad
@andreiborzaandreiborzaAwaiting requested review from andreiborza

1 more reviewer

@lforstlforstlforst approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@mydeamydea

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Add graphql integration option to automatically rename root spans based on graphql.operation.name

4 participants

@mydea@mjq@lforst@s1gr1d

, '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(node): Add useOperationNameForRootSpan tographqlIntegration - #13248
Merged
mydea merged 9 commits into
developfrom 
fn/graphql-root-spans
Aug 8, 2024
Merged
feat(node): Add useOperationNameForRootSpan tographqlIntegration#13248
mydea merged 9 commits into
developfrom 
fn/graphql-root-spans
Conversation
@mydea
@mydeamydea
commented
Aug 6, 2024•

edited

Loading

Copy link


Copy Markdown

Member
This introduces a new option for the graphqlIntegration, useOperationNameForRootSpan, which is by default true but can be disabled in integration settings like this: Sentry.graphqlIntegration({ useOperationNameForRootSpan: true }).
With this setting enabled, the graphql instrumentation will update the http.server root span it is in (if there is one) will be appended to the span name. So instead of having all root spans be POST /graphql, the names will now be e.g. POST /graphql (query MyQuery).
If there are multiple operations in a single http request, they will be appended like POST /graphql (query Query1, query Query2), up to a limit of 5, at which point they will be appended as +2 or similar.
Closes#13238
@mydeamydea
self-assigned this
Aug 6, 2024
mydea
mydea
commented
Aug 6, 2024
View reviewed changes
Comment threadpackages/opentelemetry/src/utils/spanTypes.ts
Outdated

export function spanHasKind<SpanType extends AbstractSpan>(span: SpanType): span is SpanType & { kind: SpanKind } {
 const castSpan = span as ReadableSpan;
 return !!castSpan.kind;
 return 'kind' in castSpan;
@mydeamydeaAug 6, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noticed this was actually incorrect because this may be 0!
@github-actions
github-actionsBot
commented
Aug 6, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
PathSize
@sentry/browser22.47 KB (0%)
@sentry/browser (incl. Tracing)34.26 KB (0%)
@sentry/browser (incl. Tracing, Replay)70.31 KB (0%)
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags63.64 KB (0%)
@sentry/browser (incl. Tracing, Replay with Canvas)74.71 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback)87.32 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback, metrics)89.16 KB (0%)
@sentry/browser (incl. metrics)26.77 KB (0%)
@sentry/browser (incl. Feedback)39.42 KB (0%)
@sentry/browser (incl. sendFeedback)27.09 KB (0%)
@sentry/browser (incl. FeedbackAsync)31.75 KB (0%)
@sentry/react25.24 KB (0%)
@sentry/react (incl. Tracing)37.25 KB (0%)
@sentry/vue26.62 KB (0%)
@sentry/vue (incl. Tracing)36.1 KB (0%)
@sentry/svelte22.61 KB (0%)
CDN Bundle23.69 KB (0%)
CDN Bundle (incl. Tracing)35.93 KB (0%)
CDN Bundle (incl. Tracing, Replay)70.36 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback)75.61 KB (0%)
CDN Bundle - uncompressed69.52 KB (0%)
CDN Bundle (incl. Tracing) - uncompressed106.43 KB (0%)
CDN Bundle (incl. Tracing, Replay) - uncompressed218.27 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed231.16 KB (0%)
@sentry/nextjs (client)37.1 KB (0%)
@sentry/sveltekit (client)34.81 KB (0%)
@sentry/node115.07 KB (+0.19% 🔺)
@sentry/node - without tracing89.43 KB (+0.12% 🔺)
@sentry/aws-serverless98.85 KB (+0.36% 🔺)
@mydeamydea
mentioned this pull request
Aug 6, 2024
 Merged

mydea
mydea
commented
Aug 6, 2024
View reviewed changes
Comment threadpackages/node/src/integrations/tracing/graphql.ts
@mydea
mydea
requested a review
from lforstAugust 6, 2024 14:00
@mjq
mjq
commented
Aug 6, 2024

Copy link


Copy Markdown

Member
Should we be concerned about transaction name cardinality here? This is a client-controlled field supporting arbitrary values. I'm not sure true is a safe default. At the very least we should advise that useOperationNameForRootSpan be false for public APIs, but it's only really cardinality-safe if your API only permits allowlisted queries.
@lforst
lforst
commented
Aug 6, 2024

Copy link


Copy Markdown

Contributor
@mjq I would consider gql queries like these to be low cardinality. Why would you say this is hight cardinality? I think this is comparable to normal api route paths (?).
@mydea
mydea
commented
Aug 6, 2024

Copy link


Copy Markdown

MemberAuthor
@mjq I would consider gql queries like these to be low cardinality. Why would you say this is hight cardinality? I think this is comparable to normal api route paths (?).
I agree - remember this is only using the operation name, not the query. So e.g. if your query is this:
queryMyQuery(id) {
user(id): User
}
it would only capture query MyQuery, which should not be too high cardinality.
@mjq
mjq
commented
Aug 6, 2024

Copy link


Copy Markdown

Member
@lforst@mydea If your only client is internal, it ought to be low cardinality and work well as a grouping mechanism. If it's a public API, every caller will use their own query names, meaning cardinality is effectively unbounded (and it seems less useful as a grouping mechanism since you don't control the grouping yourself). And every API is de facto a public API without further defence mechanisms 😅
The main differences from e.g. rest API URLs is that a well-configured SDK is immune to high cardinality no matter what a client sends, and a poorly-configured one can still have its cardinality reduced by our URL normalizer.
It's fine if the answer is "no we shouldn't be concerned", and treat this as an unlikely hypothetical. We aren't forwarding the cardinality cost to users so e.g. malicious use only affects Sentry, not our users' wallets, and we're giving anyone with concerns an off switch.
@mydea
mydea
commented
Aug 7, 2024

Copy link


Copy Markdown

MemberAuthor
Ah, I see what you mean.

My POV is that users can turn this off, and I'd say it is def. better with this setting than without for the vast majority of cases. Right now the cardinality is low to the point of it being useless - you just see POST /graphl as transaction name for every issue etc, and literally all your graphql queries will be grouped into a single transaction, which is also def. not helpful :D
@andreiborzaandreiborza
mentioned this pull request
Aug 7, 2024

Closed

3 tasks
lforst
lforst
approved these changes
Aug 8, 2024
View reviewed changes
@lforstlforst
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is one thing that needs addressing, otherwise lgtm!
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts
Outdated

Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts
Outdated

Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts
Comment threadpackages/opentelemetry/src/utils/spanTypes.ts
export function spanHasKind<SpanType extends AbstractSpan>(span: SpanType): span is SpanType & { kind: SpanKind } {
 const castSpan = span as ReadableSpan;
 return !!castSpan.kind;
 return typeof castSpan.kind === 'number';
@lforstlforstAug 8, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

m: Quick explainer for this?
@mydeamydeaAug 8, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry, had a comment here earlier but changed it again - this check was actually wrong, because this can be 0 which is valid, but we interpreted this as no kind before.
@mydea
mydeaforce-pushed
the
fn/graphql-root-spans
branch
from
707babf to
f71275cCompareAugust 8, 2024 09:09
@mydea
mydea
merged commit 0ca8821
into
developAug 8, 2024
@mydea
mydea
deleted the

fn/graphql-root-spans

branch
August 8, 2024 12:15
@mydeamydea
mentioned this pull request
Aug 16, 2024

Closed

@gokulk16gokulk16
mentioned this pull request
Aug 30, 2024
 Merged

@angelorealeangeloreale
mentioned this pull request
Aug 30, 2024
 Open

@angelorealeangeloreale
mentioned this pull request
Aug 30, 2024
 Open


This was referenced Aug 30, 2024
 Closed

 Closed

@q1blueq1blue
mentioned this pull request
Aug 30, 2024
 Open

@angelorealeangeloreale
mentioned this pull request
Aug 31, 2024
 Open

@FengShangWuQiFengShangWuQi
mentioned this pull request
Sep 1, 2024
 Closed

@PierreGodePierreGode
mentioned this pull request
Sep 4, 2024
 Closed


This was referenced Sep 4, 2024
 Closed

 Closed

@q1blueq1blue
mentioned this pull request
Sep 7, 2024
 Open

@FengShangWuQiFengShangWuQi
mentioned this pull request
Sep 8, 2024
 Closed

@bagulm123bagulm123
mentioned this pull request
Sep 8, 2024
 Open

@KeeghanMKeeghanM
mentioned this pull request
Sep 12, 2024
 Merged


This was referenced Sep 13, 2024
 Open

 Open

@gokulk16gokulk16
mentioned this pull request
Sep 23, 2024
 Closed

@q1blueq1blue
mentioned this pull request
Sep 24, 2024
 Open


This was referenced Sep 24, 2024
 Closed

 Closed

@FengShangWuQiFengShangWuQi
mentioned this pull request
Sep 27, 2024
 Closed


This was referenced Sep 27, 2024
 Open

 Open

@bagulm123bagulm123
mentioned this pull request
Oct 1, 2024
 Open

@q1blueq1blue
mentioned this pull request
Oct 1, 2024
 Open


This was referenced Dec 10, 2024

Closed


Closed

@s1gr1d
s1gr1d
commented
Dec 10, 2024

Copy link


Copy Markdown

Member
I added a docs issue for this as this is not documented yet: getsentry/sentry-docs#12080
@s1gr1ds1gr1d
mentioned this pull request
Dec 13, 2024
 Merged

6 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@AbhiPrasadAbhiPrasadAwaiting requested review from AbhiPrasad
@andreiborzaandreiborzaAwaiting requested review from andreiborza

1 more reviewer

@lforstlforstlforst approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@mydeamydea

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Add graphql integration option to automatically rename root spans based on graphql.operation.name

4 participants

@mydea@mjq@lforst@s1gr1d

, '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(node): Add useOperationNameForRootSpan tographqlIntegration - #13248
Merged
mydea merged 9 commits into
developfrom 
fn/graphql-root-spans
Aug 8, 2024
Merged
feat(node): Add useOperationNameForRootSpan tographqlIntegration#13248
mydea merged 9 commits into
developfrom 
fn/graphql-root-spans
Conversation
@mydea
@mydeamydea
commented
Aug 6, 2024•

edited

Loading

Copy link


Copy Markdown

Member
This introduces a new option for the graphqlIntegration, useOperationNameForRootSpan, which is by default true but can be disabled in integration settings like this: Sentry.graphqlIntegration({ useOperationNameForRootSpan: true }).
With this setting enabled, the graphql instrumentation will update the http.server root span it is in (if there is one) will be appended to the span name. So instead of having all root spans be POST /graphql, the names will now be e.g. POST /graphql (query MyQuery).
If there are multiple operations in a single http request, they will be appended like POST /graphql (query Query1, query Query2), up to a limit of 5, at which point they will be appended as +2 or similar.
Closes#13238
@mydeamydea
self-assigned this
Aug 6, 2024
mydea
mydea
commented
Aug 6, 2024
View reviewed changes
Comment threadpackages/opentelemetry/src/utils/spanTypes.ts
Outdated

export function spanHasKind<SpanType extends AbstractSpan>(span: SpanType): span is SpanType & { kind: SpanKind } {
 const castSpan = span as ReadableSpan;
 return !!castSpan.kind;
 return 'kind' in castSpan;
@mydeamydeaAug 6, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noticed this was actually incorrect because this may be 0!
@github-actions
github-actionsBot
commented
Aug 6, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
PathSize
@sentry/browser22.47 KB (0%)
@sentry/browser (incl. Tracing)34.26 KB (0%)
@sentry/browser (incl. Tracing, Replay)70.31 KB (0%)
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags63.64 KB (0%)
@sentry/browser (incl. Tracing, Replay with Canvas)74.71 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback)87.32 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback, metrics)89.16 KB (0%)
@sentry/browser (incl. metrics)26.77 KB (0%)
@sentry/browser (incl. Feedback)39.42 KB (0%)
@sentry/browser (incl. sendFeedback)27.09 KB (0%)
@sentry/browser (incl. FeedbackAsync)31.75 KB (0%)
@sentry/react25.24 KB (0%)
@sentry/react (incl. Tracing)37.25 KB (0%)
@sentry/vue26.62 KB (0%)
@sentry/vue (incl. Tracing)36.1 KB (0%)
@sentry/svelte22.61 KB (0%)
CDN Bundle23.69 KB (0%)
CDN Bundle (incl. Tracing)35.93 KB (0%)
CDN Bundle (incl. Tracing, Replay)70.36 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback)75.61 KB (0%)
CDN Bundle - uncompressed69.52 KB (0%)
CDN Bundle (incl. Tracing) - uncompressed106.43 KB (0%)
CDN Bundle (incl. Tracing, Replay) - uncompressed218.27 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed231.16 KB (0%)
@sentry/nextjs (client)37.1 KB (0%)
@sentry/sveltekit (client)34.81 KB (0%)
@sentry/node115.07 KB (+0.19% 🔺)
@sentry/node - without tracing89.43 KB (+0.12% 🔺)
@sentry/aws-serverless98.85 KB (+0.36% 🔺)
@mydeamydea
mentioned this pull request
Aug 6, 2024
 Merged

mydea
mydea
commented
Aug 6, 2024
View reviewed changes
Comment threadpackages/node/src/integrations/tracing/graphql.ts
@mydea
mydea
requested a review
from lforstAugust 6, 2024 14:00
@mjq
mjq
commented
Aug 6, 2024

Copy link


Copy Markdown

Member
Should we be concerned about transaction name cardinality here? This is a client-controlled field supporting arbitrary values. I'm not sure true is a safe default. At the very least we should advise that useOperationNameForRootSpan be false for public APIs, but it's only really cardinality-safe if your API only permits allowlisted queries.
@lforst
lforst
commented
Aug 6, 2024

Copy link


Copy Markdown

Contributor
@mjq I would consider gql queries like these to be low cardinality. Why would you say this is hight cardinality? I think this is comparable to normal api route paths (?).
@mydea
mydea
commented
Aug 6, 2024

Copy link


Copy Markdown

MemberAuthor
@mjq I would consider gql queries like these to be low cardinality. Why would you say this is hight cardinality? I think this is comparable to normal api route paths (?).
I agree - remember this is only using the operation name, not the query. So e.g. if your query is this:
queryMyQuery(id) {
user(id): User
}
it would only capture query MyQuery, which should not be too high cardinality.
@mjq
mjq
commented
Aug 6, 2024

Copy link


Copy Markdown

Member
@lforst@mydea If your only client is internal, it ought to be low cardinality and work well as a grouping mechanism. If it's a public API, every caller will use their own query names, meaning cardinality is effectively unbounded (and it seems less useful as a grouping mechanism since you don't control the grouping yourself). And every API is de facto a public API without further defence mechanisms 😅
The main differences from e.g. rest API URLs is that a well-configured SDK is immune to high cardinality no matter what a client sends, and a poorly-configured one can still have its cardinality reduced by our URL normalizer.
It's fine if the answer is "no we shouldn't be concerned", and treat this as an unlikely hypothetical. We aren't forwarding the cardinality cost to users so e.g. malicious use only affects Sentry, not our users' wallets, and we're giving anyone with concerns an off switch.
@mydea
mydea
commented
Aug 7, 2024

Copy link


Copy Markdown

MemberAuthor
Ah, I see what you mean.

My POV is that users can turn this off, and I'd say it is def. better with this setting than without for the vast majority of cases. Right now the cardinality is low to the point of it being useless - you just see POST /graphl as transaction name for every issue etc, and literally all your graphql queries will be grouped into a single transaction, which is also def. not helpful :D
@andreiborzaandreiborza
mentioned this pull request
Aug 7, 2024

Closed

3 tasks
lforst
lforst
approved these changes
Aug 8, 2024
View reviewed changes
@lforstlforst
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is one thing that needs addressing, otherwise lgtm!
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts
Outdated

Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts
Outdated

Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts
Comment threadpackages/opentelemetry/src/utils/spanTypes.ts
export function spanHasKind<SpanType extends AbstractSpan>(span: SpanType): span is SpanType & { kind: SpanKind } {
 const castSpan = span as ReadableSpan;
 return !!castSpan.kind;
 return typeof castSpan.kind === 'number';
@lforstlforstAug 8, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

m: Quick explainer for this?
@mydeamydeaAug 8, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry, had a comment here earlier but changed it again - this check was actually wrong, because this can be 0 which is valid, but we interpreted this as no kind before.
@mydea
mydeaforce-pushed
the
fn/graphql-root-spans
branch
from
707babf to
f71275cCompareAugust 8, 2024 09:09
@mydea
mydea
merged commit 0ca8821
into
developAug 8, 2024
@mydea
mydea
deleted the

fn/graphql-root-spans

branch
August 8, 2024 12:15
@mydeamydea
mentioned this pull request
Aug 16, 2024

Closed

@gokulk16gokulk16
mentioned this pull request
Aug 30, 2024
 Merged

@angelorealeangeloreale
mentioned this pull request
Aug 30, 2024
 Open

@angelorealeangeloreale
mentioned this pull request
Aug 30, 2024
 Open


This was referenced Aug 30, 2024
 Closed

 Closed

@q1blueq1blue
mentioned this pull request
Aug 30, 2024
 Open

@angelorealeangeloreale
mentioned this pull request
Aug 31, 2024
 Open

@FengShangWuQiFengShangWuQi
mentioned this pull request
Sep 1, 2024
 Closed

@PierreGodePierreGode
mentioned this pull request
Sep 4, 2024
 Closed


This was referenced Sep 4, 2024
 Closed

 Closed

@q1blueq1blue
mentioned this pull request
Sep 7, 2024
 Open

@FengShangWuQiFengShangWuQi
mentioned this pull request
Sep 8, 2024
 Closed

@bagulm123bagulm123
mentioned this pull request
Sep 8, 2024
 Open

@KeeghanMKeeghanM
mentioned this pull request
Sep 12, 2024
 Merged


This was referenced Sep 13, 2024
 Open

 Open

@gokulk16gokulk16
mentioned this pull request
Sep 23, 2024
 Closed

@q1blueq1blue
mentioned this pull request
Sep 24, 2024
 Open


This was referenced Sep 24, 2024
 Closed

 Closed

@FengShangWuQiFengShangWuQi
mentioned this pull request
Sep 27, 2024
 Closed


This was referenced Sep 27, 2024
 Open

 Open

@bagulm123bagulm123
mentioned this pull request
Oct 1, 2024
 Open

@q1blueq1blue
mentioned this pull request
Oct 1, 2024
 Open


This was referenced Dec 10, 2024

Closed


Closed

@s1gr1d
s1gr1d
commented
Dec 10, 2024

Copy link


Copy Markdown

Member
I added a docs issue for this as this is not documented yet: getsentry/sentry-docs#12080
@s1gr1ds1gr1d
mentioned this pull request
Dec 13, 2024
 Merged

6 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@AbhiPrasadAbhiPrasadAwaiting requested review from AbhiPrasad
@andreiborzaandreiborzaAwaiting requested review from andreiborza

1 more reviewer

@lforstlforstlforst approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@mydeamydea

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Add graphql integration option to automatically rename root spans based on graphql.operation.name

4 participants

@mydea@mjq@lforst@s1gr1d

, '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(node): Add useOperationNameForRootSpan tographqlIntegration - #13248
Merged
mydea merged 9 commits into
developfrom 
fn/graphql-root-spans
Aug 8, 2024
Merged
feat(node): Add useOperationNameForRootSpan tographqlIntegration#13248
mydea merged 9 commits into
developfrom 
fn/graphql-root-spans
Conversation
@mydea
@mydeamydea
commented
Aug 6, 2024•

edited

Loading

Copy link


Copy Markdown

Member
This introduces a new option for the graphqlIntegration, useOperationNameForRootSpan, which is by default true but can be disabled in integration settings like this: Sentry.graphqlIntegration({ useOperationNameForRootSpan: true }).
With this setting enabled, the graphql instrumentation will update the http.server root span it is in (if there is one) will be appended to the span name. So instead of having all root spans be POST /graphql, the names will now be e.g. POST /graphql (query MyQuery).
If there are multiple operations in a single http request, they will be appended like POST /graphql (query Query1, query Query2), up to a limit of 5, at which point they will be appended as +2 or similar.
Closes#13238
@mydeamydea
self-assigned this
Aug 6, 2024
mydea
mydea
commented
Aug 6, 2024
View reviewed changes
Comment threadpackages/opentelemetry/src/utils/spanTypes.ts
Outdated

export function spanHasKind<SpanType extends AbstractSpan>(span: SpanType): span is SpanType & { kind: SpanKind } {
 const castSpan = span as ReadableSpan;
 return !!castSpan.kind;
 return 'kind' in castSpan;
@mydeamydeaAug 6, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noticed this was actually incorrect because this may be 0!
@github-actions
github-actionsBot
commented
Aug 6, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
PathSize
@sentry/browser22.47 KB (0%)
@sentry/browser (incl. Tracing)34.26 KB (0%)
@sentry/browser (incl. Tracing, Replay)70.31 KB (0%)
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags63.64 KB (0%)
@sentry/browser (incl. Tracing, Replay with Canvas)74.71 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback)87.32 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback, metrics)89.16 KB (0%)
@sentry/browser (incl. metrics)26.77 KB (0%)
@sentry/browser (incl. Feedback)39.42 KB (0%)
@sentry/browser (incl. sendFeedback)27.09 KB (0%)
@sentry/browser (incl. FeedbackAsync)31.75 KB (0%)
@sentry/react25.24 KB (0%)
@sentry/react (incl. Tracing)37.25 KB (0%)
@sentry/vue26.62 KB (0%)
@sentry/vue (incl. Tracing)36.1 KB (0%)
@sentry/svelte22.61 KB (0%)
CDN Bundle23.69 KB (0%)
CDN Bundle (incl. Tracing)35.93 KB (0%)
CDN Bundle (incl. Tracing, Replay)70.36 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback)75.61 KB (0%)
CDN Bundle - uncompressed69.52 KB (0%)
CDN Bundle (incl. Tracing) - uncompressed106.43 KB (0%)
CDN Bundle (incl. Tracing, Replay) - uncompressed218.27 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed231.16 KB (0%)
@sentry/nextjs (client)37.1 KB (0%)
@sentry/sveltekit (client)34.81 KB (0%)
@sentry/node115.07 KB (+0.19% 🔺)
@sentry/node - without tracing89.43 KB (+0.12% 🔺)
@sentry/aws-serverless98.85 KB (+0.36% 🔺)
@mydeamydea
mentioned this pull request
Aug 6, 2024
 Merged

mydea
mydea
commented
Aug 6, 2024
View reviewed changes
Comment threadpackages/node/src/integrations/tracing/graphql.ts
@mydea
mydea
requested a review
from lforstAugust 6, 2024 14:00
@mjq
mjq
commented
Aug 6, 2024

Copy link


Copy Markdown

Member
Should we be concerned about transaction name cardinality here? This is a client-controlled field supporting arbitrary values. I'm not sure true is a safe default. At the very least we should advise that useOperationNameForRootSpan be false for public APIs, but it's only really cardinality-safe if your API only permits allowlisted queries.
@lforst
lforst
commented
Aug 6, 2024

Copy link


Copy Markdown

Contributor
@mjq I would consider gql queries like these to be low cardinality. Why would you say this is hight cardinality? I think this is comparable to normal api route paths (?).
@mydea
mydea
commented
Aug 6, 2024

Copy link


Copy Markdown

MemberAuthor
@mjq I would consider gql queries like these to be low cardinality. Why would you say this is hight cardinality? I think this is comparable to normal api route paths (?).
I agree - remember this is only using the operation name, not the query. So e.g. if your query is this:
queryMyQuery(id) {
user(id): User
}
it would only capture query MyQuery, which should not be too high cardinality.
@mjq
mjq
commented
Aug 6, 2024

Copy link


Copy Markdown

Member
@lforst@mydea If your only client is internal, it ought to be low cardinality and work well as a grouping mechanism. If it's a public API, every caller will use their own query names, meaning cardinality is effectively unbounded (and it seems less useful as a grouping mechanism since you don't control the grouping yourself). And every API is de facto a public API without further defence mechanisms 😅
The main differences from e.g. rest API URLs is that a well-configured SDK is immune to high cardinality no matter what a client sends, and a poorly-configured one can still have its cardinality reduced by our URL normalizer.
It's fine if the answer is "no we shouldn't be concerned", and treat this as an unlikely hypothetical. We aren't forwarding the cardinality cost to users so e.g. malicious use only affects Sentry, not our users' wallets, and we're giving anyone with concerns an off switch.
@mydea
mydea
commented
Aug 7, 2024

Copy link


Copy Markdown

MemberAuthor
Ah, I see what you mean.

My POV is that users can turn this off, and I'd say it is def. better with this setting than without for the vast majority of cases. Right now the cardinality is low to the point of it being useless - you just see POST /graphl as transaction name for every issue etc, and literally all your graphql queries will be grouped into a single transaction, which is also def. not helpful :D
@andreiborzaandreiborza
mentioned this pull request
Aug 7, 2024

Closed

3 tasks
lforst
lforst
approved these changes
Aug 8, 2024
View reviewed changes
@lforstlforst
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is one thing that needs addressing, otherwise lgtm!
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts
Outdated

Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts
Outdated

Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts
Comment threadpackages/opentelemetry/src/utils/spanTypes.ts
export function spanHasKind<SpanType extends AbstractSpan>(span: SpanType): span is SpanType & { kind: SpanKind } {
 const castSpan = span as ReadableSpan;
 return !!castSpan.kind;
 return typeof castSpan.kind === 'number';
@lforstlforstAug 8, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

m: Quick explainer for this?
@mydeamydeaAug 8, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry, had a comment here earlier but changed it again - this check was actually wrong, because this can be 0 which is valid, but we interpreted this as no kind before.
@mydea
mydeaforce-pushed
the
fn/graphql-root-spans
branch
from
707babf to
f71275cCompareAugust 8, 2024 09:09
@mydea
mydea
merged commit 0ca8821
into
developAug 8, 2024
@mydea
mydea
deleted the

fn/graphql-root-spans

branch
August 8, 2024 12:15
@mydeamydea
mentioned this pull request
Aug 16, 2024

Closed

@gokulk16gokulk16
mentioned this pull request
Aug 30, 2024
 Merged

@angelorealeangeloreale
mentioned this pull request
Aug 30, 2024
 Open

@angelorealeangeloreale
mentioned this pull request
Aug 30, 2024
 Open


This was referenced Aug 30, 2024
 Closed

 Closed

@q1blueq1blue
mentioned this pull request
Aug 30, 2024
 Open

@angelorealeangeloreale
mentioned this pull request
Aug 31, 2024
 Open

@FengShangWuQiFengShangWuQi
mentioned this pull request
Sep 1, 2024
 Closed

@PierreGodePierreGode
mentioned this pull request
Sep 4, 2024
 Closed


This was referenced Sep 4, 2024
 Closed

 Closed

@q1blueq1blue
mentioned this pull request
Sep 7, 2024
 Open

@FengShangWuQiFengShangWuQi
mentioned this pull request
Sep 8, 2024
 Closed

@bagulm123bagulm123
mentioned this pull request
Sep 8, 2024
 Open

@KeeghanMKeeghanM
mentioned this pull request
Sep 12, 2024
 Merged


This was referenced Sep 13, 2024
 Open

 Open

@gokulk16gokulk16
mentioned this pull request
Sep 23, 2024
 Closed

@q1blueq1blue
mentioned this pull request
Sep 24, 2024
 Open


This was referenced Sep 24, 2024
 Closed

 Closed

@FengShangWuQiFengShangWuQi
mentioned this pull request
Sep 27, 2024
 Closed


This was referenced Sep 27, 2024
 Open

 Open

@bagulm123bagulm123
mentioned this pull request
Oct 1, 2024
 Open

@q1blueq1blue
mentioned this pull request
Oct 1, 2024
 Open


This was referenced Dec 10, 2024

Closed


Closed

@s1gr1d
s1gr1d
commented
Dec 10, 2024

Copy link


Copy Markdown

Member
I added a docs issue for this as this is not documented yet: getsentry/sentry-docs#12080
@s1gr1ds1gr1d
mentioned this pull request
Dec 13, 2024
 Merged

6 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@AbhiPrasadAbhiPrasadAwaiting requested review from AbhiPrasad
@andreiborzaandreiborzaAwaiting requested review from andreiborza

1 more reviewer

@lforstlforstlforst approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@mydeamydea

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Add graphql integration option to automatically rename root spans based on graphql.operation.name

4 participants

@mydea@mjq@lforst@s1gr1d

, '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(node): Add useOperationNameForRootSpan tographqlIntegration - #13248
Merged
mydea merged 9 commits into
developfrom 
fn/graphql-root-spans
Aug 8, 2024
Merged
feat(node): Add useOperationNameForRootSpan tographqlIntegration#13248
mydea merged 9 commits into
developfrom 
fn/graphql-root-spans
Conversation
@mydea
@mydeamydea
commented
Aug 6, 2024•

edited

Loading

Copy link


Copy Markdown

Member
This introduces a new option for the graphqlIntegration, useOperationNameForRootSpan, which is by default true but can be disabled in integration settings like this: Sentry.graphqlIntegration({ useOperationNameForRootSpan: true }).
With this setting enabled, the graphql instrumentation will update the http.server root span it is in (if there is one) will be appended to the span name. So instead of having all root spans be POST /graphql, the names will now be e.g. POST /graphql (query MyQuery).
If there are multiple operations in a single http request, they will be appended like POST /graphql (query Query1, query Query2), up to a limit of 5, at which point they will be appended as +2 or similar.
Closes#13238
@mydeamydea
self-assigned this
Aug 6, 2024
mydea
mydea
commented
Aug 6, 2024
View reviewed changes
Comment threadpackages/opentelemetry/src/utils/spanTypes.ts
Outdated

export function spanHasKind<SpanType extends AbstractSpan>(span: SpanType): span is SpanType & { kind: SpanKind } {
 const castSpan = span as ReadableSpan;
 return !!castSpan.kind;
 return 'kind' in castSpan;
@mydeamydeaAug 6, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noticed this was actually incorrect because this may be 0!
@github-actions
github-actionsBot
commented
Aug 6, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
PathSize
@sentry/browser22.47 KB (0%)
@sentry/browser (incl. Tracing)34.26 KB (0%)
@sentry/browser (incl. Tracing, Replay)70.31 KB (0%)
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags63.64 KB (0%)
@sentry/browser (incl. Tracing, Replay with Canvas)74.71 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback)87.32 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback, metrics)89.16 KB (0%)
@sentry/browser (incl. metrics)26.77 KB (0%)
@sentry/browser (incl. Feedback)39.42 KB (0%)
@sentry/browser (incl. sendFeedback)27.09 KB (0%)
@sentry/browser (incl. FeedbackAsync)31.75 KB (0%)
@sentry/react25.24 KB (0%)
@sentry/react (incl. Tracing)37.25 KB (0%)
@sentry/vue26.62 KB (0%)
@sentry/vue (incl. Tracing)36.1 KB (0%)
@sentry/svelte22.61 KB (0%)
CDN Bundle23.69 KB (0%)
CDN Bundle (incl. Tracing)35.93 KB (0%)
CDN Bundle (incl. Tracing, Replay)70.36 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback)75.61 KB (0%)
CDN Bundle - uncompressed69.52 KB (0%)
CDN Bundle (incl. Tracing) - uncompressed106.43 KB (0%)
CDN Bundle (incl. Tracing, Replay) - uncompressed218.27 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed231.16 KB (0%)
@sentry/nextjs (client)37.1 KB (0%)
@sentry/sveltekit (client)34.81 KB (0%)
@sentry/node115.07 KB (+0.19% 🔺)
@sentry/node - without tracing89.43 KB (+0.12% 🔺)
@sentry/aws-serverless98.85 KB (+0.36% 🔺)
@mydeamydea
mentioned this pull request
Aug 6, 2024
 Merged

mydea
mydea
commented
Aug 6, 2024
View reviewed changes
Comment threadpackages/node/src/integrations/tracing/graphql.ts
@mydea
mydea
requested a review
from lforstAugust 6, 2024 14:00
@mjq
mjq
commented
Aug 6, 2024

Copy link


Copy Markdown

Member
Should we be concerned about transaction name cardinality here? This is a client-controlled field supporting arbitrary values. I'm not sure true is a safe default. At the very least we should advise that useOperationNameForRootSpan be false for public APIs, but it's only really cardinality-safe if your API only permits allowlisted queries.
@lforst
lforst
commented
Aug 6, 2024

Copy link


Copy Markdown

Contributor
@mjq I would consider gql queries like these to be low cardinality. Why would you say this is hight cardinality? I think this is comparable to normal api route paths (?).
@mydea
mydea
commented
Aug 6, 2024

Copy link


Copy Markdown

MemberAuthor
@mjq I would consider gql queries like these to be low cardinality. Why would you say this is hight cardinality? I think this is comparable to normal api route paths (?).
I agree - remember this is only using the operation name, not the query. So e.g. if your query is this:
queryMyQuery(id) {
user(id): User
}
it would only capture query MyQuery, which should not be too high cardinality.
@mjq
mjq
commented
Aug 6, 2024

Copy link


Copy Markdown

Member
@lforst@mydea If your only client is internal, it ought to be low cardinality and work well as a grouping mechanism. If it's a public API, every caller will use their own query names, meaning cardinality is effectively unbounded (and it seems less useful as a grouping mechanism since you don't control the grouping yourself). And every API is de facto a public API without further defence mechanisms 😅
The main differences from e.g. rest API URLs is that a well-configured SDK is immune to high cardinality no matter what a client sends, and a poorly-configured one can still have its cardinality reduced by our URL normalizer.
It's fine if the answer is "no we shouldn't be concerned", and treat this as an unlikely hypothetical. We aren't forwarding the cardinality cost to users so e.g. malicious use only affects Sentry, not our users' wallets, and we're giving anyone with concerns an off switch.
@mydea
mydea
commented
Aug 7, 2024

Copy link


Copy Markdown

MemberAuthor
Ah, I see what you mean.

My POV is that users can turn this off, and I'd say it is def. better with this setting than without for the vast majority of cases. Right now the cardinality is low to the point of it being useless - you just see POST /graphl as transaction name for every issue etc, and literally all your graphql queries will be grouped into a single transaction, which is also def. not helpful :D
@andreiborzaandreiborza
mentioned this pull request
Aug 7, 2024

Closed

3 tasks
lforst
lforst
approved these changes
Aug 8, 2024
View reviewed changes
@lforstlforst
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is one thing that needs addressing, otherwise lgtm!
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts
Outdated

Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts
Outdated

Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts
Comment threadpackages/opentelemetry/src/utils/spanTypes.ts
export function spanHasKind<SpanType extends AbstractSpan>(span: SpanType): span is SpanType & { kind: SpanKind } {
 const castSpan = span as ReadableSpan;
 return !!castSpan.kind;
 return typeof castSpan.kind === 'number';
@lforstlforstAug 8, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

m: Quick explainer for this?
@mydeamydeaAug 8, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry, had a comment here earlier but changed it again - this check was actually wrong, because this can be 0 which is valid, but we interpreted this as no kind before.
@mydea
mydeaforce-pushed
the
fn/graphql-root-spans
branch
from
707babf to
f71275cCompareAugust 8, 2024 09:09
@mydea
mydea
merged commit 0ca8821
into
developAug 8, 2024
@mydea
mydea
deleted the

fn/graphql-root-spans

branch
August 8, 2024 12:15
@mydeamydea
mentioned this pull request
Aug 16, 2024

Closed

@gokulk16gokulk16
mentioned this pull request
Aug 30, 2024
 Merged

@angelorealeangeloreale
mentioned this pull request
Aug 30, 2024
 Open

@angelorealeangeloreale
mentioned this pull request
Aug 30, 2024
 Open


This was referenced Aug 30, 2024
 Closed

 Closed

@q1blueq1blue
mentioned this pull request
Aug 30, 2024
 Open

@angelorealeangeloreale
mentioned this pull request
Aug 31, 2024
 Open

@FengShangWuQiFengShangWuQi
mentioned this pull request
Sep 1, 2024
 Closed

@PierreGodePierreGode
mentioned this pull request
Sep 4, 2024
 Closed


This was referenced Sep 4, 2024
 Closed

 Closed

@q1blueq1blue
mentioned this pull request
Sep 7, 2024
 Open

@FengShangWuQiFengShangWuQi
mentioned this pull request
Sep 8, 2024
 Closed

@bagulm123bagulm123
mentioned this pull request
Sep 8, 2024
 Open

@KeeghanMKeeghanM
mentioned this pull request
Sep 12, 2024
 Merged


This was referenced Sep 13, 2024
 Open

 Open

@gokulk16gokulk16
mentioned this pull request
Sep 23, 2024
 Closed

@q1blueq1blue
mentioned this pull request
Sep 24, 2024
 Open


This was referenced Sep 24, 2024
 Closed

 Closed

@FengShangWuQiFengShangWuQi
mentioned this pull request
Sep 27, 2024
 Closed


This was referenced Sep 27, 2024
 Open

 Open

@bagulm123bagulm123
mentioned this pull request
Oct 1, 2024
 Open

@q1blueq1blue
mentioned this pull request
Oct 1, 2024
 Open


This was referenced Dec 10, 2024

Closed


Closed

@s1gr1d
s1gr1d
commented
Dec 10, 2024

Copy link


Copy Markdown

Member
I added a docs issue for this as this is not documented yet: getsentry/sentry-docs#12080
@s1gr1ds1gr1d
mentioned this pull request
Dec 13, 2024
 Merged

6 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@AbhiPrasadAbhiPrasadAwaiting requested review from AbhiPrasad
@andreiborzaandreiborzaAwaiting requested review from andreiborza

1 more reviewer

@lforstlforstlforst approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@mydeamydea

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Add graphql integration option to automatically rename root spans based on graphql.operation.name

4 participants

@mydea@mjq@lforst@s1gr1d

, '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(node): Add useOperationNameForRootSpan tographqlIntegration - #13248
Merged
mydea merged 9 commits into
developfrom 
fn/graphql-root-spans
Aug 8, 2024
Merged
feat(node): Add useOperationNameForRootSpan tographqlIntegration#13248
mydea merged 9 commits into
developfrom 
fn/graphql-root-spans
Conversation
@mydea
@mydeamydea
commented
Aug 6, 2024•

edited

Loading

Copy link


Copy Markdown

Member
This introduces a new option for the graphqlIntegration, useOperationNameForRootSpan, which is by default true but can be disabled in integration settings like this: Sentry.graphqlIntegration({ useOperationNameForRootSpan: true }).
With this setting enabled, the graphql instrumentation will update the http.server root span it is in (if there is one) will be appended to the span name. So instead of having all root spans be POST /graphql, the names will now be e.g. POST /graphql (query MyQuery).
If there are multiple operations in a single http request, they will be appended like POST /graphql (query Query1, query Query2), up to a limit of 5, at which point they will be appended as +2 or similar.
Closes#13238
@mydeamydea
self-assigned this
Aug 6, 2024
mydea
mydea
commented
Aug 6, 2024
View reviewed changes
Comment threadpackages/opentelemetry/src/utils/spanTypes.ts
Outdated

export function spanHasKind<SpanType extends AbstractSpan>(span: SpanType): span is SpanType & { kind: SpanKind } {
 const castSpan = span as ReadableSpan;
 return !!castSpan.kind;
 return 'kind' in castSpan;
@mydeamydeaAug 6, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noticed this was actually incorrect because this may be 0!
@github-actions
github-actionsBot
commented
Aug 6, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
PathSize
@sentry/browser22.47 KB (0%)
@sentry/browser (incl. Tracing)34.26 KB (0%)
@sentry/browser (incl. Tracing, Replay)70.31 KB (0%)
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags63.64 KB (0%)
@sentry/browser (incl. Tracing, Replay with Canvas)74.71 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback)87.32 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback, metrics)89.16 KB (0%)
@sentry/browser (incl. metrics)26.77 KB (0%)
@sentry/browser (incl. Feedback)39.42 KB (0%)
@sentry/browser (incl. sendFeedback)27.09 KB (0%)
@sentry/browser (incl. FeedbackAsync)31.75 KB (0%)
@sentry/react25.24 KB (0%)
@sentry/react (incl. Tracing)37.25 KB (0%)
@sentry/vue26.62 KB (0%)
@sentry/vue (incl. Tracing)36.1 KB (0%)
@sentry/svelte22.61 KB (0%)
CDN Bundle23.69 KB (0%)
CDN Bundle (incl. Tracing)35.93 KB (0%)
CDN Bundle (incl. Tracing, Replay)70.36 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback)75.61 KB (0%)
CDN Bundle - uncompressed69.52 KB (0%)
CDN Bundle (incl. Tracing) - uncompressed106.43 KB (0%)
CDN Bundle (incl. Tracing, Replay) - uncompressed218.27 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed231.16 KB (0%)
@sentry/nextjs (client)37.1 KB (0%)
@sentry/sveltekit (client)34.81 KB (0%)
@sentry/node115.07 KB (+0.19% 🔺)
@sentry/node - without tracing89.43 KB (+0.12% 🔺)
@sentry/aws-serverless98.85 KB (+0.36% 🔺)
@mydeamydea
mentioned this pull request
Aug 6, 2024
 Merged

mydea
mydea
commented
Aug 6, 2024
View reviewed changes
Comment threadpackages/node/src/integrations/tracing/graphql.ts
@mydea
mydea
requested a review
from lforstAugust 6, 2024 14:00
@mjq
mjq
commented
Aug 6, 2024

Copy link


Copy Markdown

Member
Should we be concerned about transaction name cardinality here? This is a client-controlled field supporting arbitrary values. I'm not sure true is a safe default. At the very least we should advise that useOperationNameForRootSpan be false for public APIs, but it's only really cardinality-safe if your API only permits allowlisted queries.
@lforst
lforst
commented
Aug 6, 2024

Copy link


Copy Markdown

Contributor
@mjq I would consider gql queries like these to be low cardinality. Why would you say this is hight cardinality? I think this is comparable to normal api route paths (?).
@mydea
mydea
commented
Aug 6, 2024

Copy link


Copy Markdown

MemberAuthor
@mjq I would consider gql queries like these to be low cardinality. Why would you say this is hight cardinality? I think this is comparable to normal api route paths (?).
I agree - remember this is only using the operation name, not the query. So e.g. if your query is this:
queryMyQuery(id) {
user(id): User
}
it would only capture query MyQuery, which should not be too high cardinality.
@mjq
mjq
commented
Aug 6, 2024

Copy link


Copy Markdown

Member
@lforst@mydea If your only client is internal, it ought to be low cardinality and work well as a grouping mechanism. If it's a public API, every caller will use their own query names, meaning cardinality is effectively unbounded (and it seems less useful as a grouping mechanism since you don't control the grouping yourself). And every API is de facto a public API without further defence mechanisms 😅
The main differences from e.g. rest API URLs is that a well-configured SDK is immune to high cardinality no matter what a client sends, and a poorly-configured one can still have its cardinality reduced by our URL normalizer.
It's fine if the answer is "no we shouldn't be concerned", and treat this as an unlikely hypothetical. We aren't forwarding the cardinality cost to users so e.g. malicious use only affects Sentry, not our users' wallets, and we're giving anyone with concerns an off switch.
@mydea
mydea
commented
Aug 7, 2024

Copy link


Copy Markdown

MemberAuthor
Ah, I see what you mean.

My POV is that users can turn this off, and I'd say it is def. better with this setting than without for the vast majority of cases. Right now the cardinality is low to the point of it being useless - you just see POST /graphl as transaction name for every issue etc, and literally all your graphql queries will be grouped into a single transaction, which is also def. not helpful :D
@andreiborzaandreiborza
mentioned this pull request
Aug 7, 2024

Closed

3 tasks
lforst
lforst
approved these changes
Aug 8, 2024
View reviewed changes
@lforstlforst
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is one thing that needs addressing, otherwise lgtm!
Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts
Outdated

Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts
Outdated

Comment threadpackages/opentelemetry/src/utils/parseSpanDescription.ts
Comment threadpackages/opentelemetry/src/utils/spanTypes.ts
export function spanHasKind<SpanType extends AbstractSpan>(span: SpanType): span is SpanType & { kind: SpanKind } {
 const castSpan = span as ReadableSpan;
 return !!castSpan.kind;
 return typeof castSpan.kind === 'number';
@lforstlforstAug 8, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

m: Quick explainer for this?
@mydeamydeaAug 8, 2024

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry, had a comment here earlier but changed it again - this check was actually wrong, because this can be 0 which is valid, but we interpreted this as no kind before.
@mydea
mydeaforce-pushed
the
fn/graphql-root-spans
branch
from
707babf to
f71275cCompareAugust 8, 2024 09:09
@mydea
mydea
merged commit 0ca8821
into
developAug 8, 2024
@mydea
mydea
deleted the

fn/graphql-root-spans

branch
August 8, 2024 12:15
@mydeamydea
mentioned this pull request
Aug 16, 2024

Closed

@gokulk16gokulk16
mentioned this pull request
Aug 30, 2024
 Merged

@angelorealeangeloreale
mentioned this pull request
Aug 30, 2024
 Open

@angelorealeangeloreale
mentioned this pull request
Aug 30, 2024
 Open


This was referenced Aug 30, 2024
 Closed

 Closed

@q1blueq1blue
mentioned this pull request
Aug 30, 2024
 Open

@angelorealeangeloreale
mentioned this pull request
Aug 31, 2024
 Open

@FengShangWuQiFengShangWuQi
mentioned this pull request
Sep 1, 2024
 Closed

@PierreGodePierreGode
mentioned this pull request
Sep 4, 2024
 Closed


This was referenced Sep 4, 2024
 Closed

 Closed

@q1blueq1blue
mentioned this pull request
Sep 7, 2024
 Open

@FengShangWuQiFengShangWuQi
mentioned this pull request
Sep 8, 2024
 Closed

@bagulm123bagulm123
mentioned this pull request
Sep 8, 2024
 Open

@KeeghanMKeeghanM
mentioned this pull request
Sep 12, 2024
 Merged


This was referenced Sep 13, 2024
 Open

 Open

@gokulk16gokulk16
mentioned this pull request
Sep 23, 2024
 Closed

@q1blueq1blue
mentioned this pull request
Sep 24, 2024
 Open


This was referenced Sep 24, 2024
 Closed

 Closed

@FengShangWuQiFengShangWuQi
mentioned this pull request
Sep 27, 2024
 Closed


This was referenced Sep 27, 2024
 Open

 Open

@bagulm123bagulm123
mentioned this pull request
Oct 1, 2024
 Open

@q1blueq1blue
mentioned this pull request
Oct 1, 2024
 Open


This was referenced Dec 10, 2024

Closed


Closed

@s1gr1d
s1gr1d
commented
Dec 10, 2024

Copy link


Copy Markdown

Member
I added a docs issue for this as this is not documented yet: getsentry/sentry-docs#12080
@s1gr1ds1gr1d
mentioned this pull request
Dec 13, 2024
 Merged

6 tasks
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@AbhiPrasadAbhiPrasadAwaiting requested review from AbhiPrasad
@andreiborzaandreiborzaAwaiting requested review from andreiborza

1 more reviewer

@lforstlforstlforst approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@mydeamydea

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

Add graphql integration option to automatically rename root spans based on graphql.operation.name

4 participants

@mydea@mjq@lforst@s1gr1d