Skip to content

Update GraphQL best practices doc#719

Merged
juansc merged 2 commits intomainfrom
graphql-caveats
Mar 6, 2026
Merged

Update GraphQL best practices doc#719
juansc merged 2 commits intomainfrom
graphql-caveats

Conversation

@sergiothinks2
Copy link
Contributor

  • Add "Configuring Network Grouping Rules" section to the GraphQL best practices doc
  • Explains that the Embrace backend may collapse high-cardinality GraphQL paths into wildcards, causing individual operations to appear missing from the Network section despite being captured correctly
  • Provides steps to create network grouping rules in the dashboard to prevent wildcard collapsing

Context

Two customers (ServiceTitan, Strava) independently reported that their GraphQL operations were not appearing in the Network section of the dashboard. In both cases, the SDK was capturing requests correctly
(visible in session timelines), but the backend was collapsing distinct /graphql/<operation> paths into a wildcard. The existing docs only covered the SDK-side setup without mentioning this dashboard behavior.

@github-actions
Copy link

github-actions bot commented Mar 4, 2026

Summary - Markdown Lint

Success: No issues found in 392 files (95ms)

@github-actions
Copy link

github-actions bot commented Mar 4, 2026

Summary - Link Checker

Status Count
🔍 Total 470
✅ Successful 375
⏳ Timeouts 0
🔀 Redirected 0
👻 Excluded 95
❓ Unknown 0
🚫 Errors 0
⛔ Unsupported 0
Full Github Actions output

This happens because the Embrace backend automatically groups network paths with high cardinality
into wildcard entries. For example, if your app tracks many distinct GraphQL operations
(`/graphql/getUser`, `/graphql/createOrder`, `/graphql/deleteItem`, etc.), the backend
may collapse them into a single wildcard entry like `/graphql/*`. When this occurs, individual
Copy link
Contributor

Choose a reason for hiding this comment

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

change * to the wildcard we use in the dashboard

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@juansc updated

@juansc juansc merged commit 658f207 into main Mar 6, 2026
4 checks passed
@juansc juansc deleted the graphql-caveats branch March 6, 2026 03:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants