Skip to content

docs: Streamline the span name changes migration section - #23607

Merged
Lms24 merged 4 commits into
developfrom
lms/docs-low-card-db-span-names8
Sep 3, 2026
Merged

docs: Streamline the span name changes migration section#23607
Lms24 merged 4 commits into
developfrom
lms/docs-low-card-db-span-names8

Conversation

@Lms24

@Lms24 Lms24 commented Aug 25, 2026

Copy link
Copy Markdown
Member

With most span name adjustments being taken care of, we accumulated quite a bit of migration guide around the changes. This PR

  • moves and deslops the filtering and sampling section below the table
  • streamlines all changes into a table with examples for each span category.
  • heavily cuts down the detailed explanations under the spans to the most relevant changes.

Refs #22350

@Lms24
Lms24 force-pushed the lms/docs-low-card-db-span-names8 branch 2 times, most recently from 5d25737 to f4a6d96 Compare September 2, 2026 16:41
@Lms24 Lms24 changed the title docs: Document low cardinality db span names docs: Streamline the span name changes migration section Sep 2, 2026
@Lms24
Lms24 force-pushed the lms/docs-low-card-db-span-names8 branch 2 times, most recently from 36c71ed to 5363731 Compare September 2, 2026 17:03
@Lms24
Lms24 marked this pull request as ready for review September 2, 2026 18:02
@Lms24 Lms24 self-assigned this Sep 2, 2026
Comment thread MIGRATION.md
#### Cache spans

Match on attributes instead:
Cache keys are no longer part of a cache span name. They remain available on the `cache.key` attribute, and every cache span now also carries a `cache.operation` attribute (`get`, `put`, `remove`), which is the value the name is built from. This affects the redis/ioredis cache spans (with `cachePrefixes` set on the redis integration), the Nuxt and Nitro storage spans, and the dataloader spans.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

You could also mention that maxCacheKeyLength is a no-op now. Similar to useOperationNameForRootSpan.

https://github.com/getsentry/sentry-javascript/blob/develop/packages/server-utils/src/integrations/redis/redis-cache.ts#L43-L54

@Lms24 Lms24 Sep 3, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

hmm good point, thanks! should we deprecate the option then? WDYT?

Lms24 and others added 4 commits September 3, 2026 14:10
The section had grown into a table followed by ~26 loose paragraphs in no
particular order, with a dangling "Some consequences to be aware of:" lead-in
sitting halfway down the list. Group the prose under one sub-heading per span
op family, ordered to match the table, and move the filtering, sampling and
grouping guidance into a section of its own.

Fold what the table can carry into the table: `navigation.redirect` shares the
`navigation` row instead of a standalone sentence, and `resource.*` moves up
next to the other browser ops. Every attribute in this section is set in both
trace lifecycles, so state that once up front rather than repeating it in ten
paragraphs.

Also document the db span names that were still missing: the SQL drivers
(`pg`, `postgres.js`, `mysql`, `mysql2`, `knex`, `tedious`, Prisma, Nitro
`db0`, Cloudflare D1), mongodb and supabase, plus the new `db.query.summary`
attribute. Supabase auth spans do change (`auth signInWithPassword` becomes
`auth.signInWithPassword`), and the SQL fallback is not uniformly
`Database operation` — each driver drops to the next template it can fill.

Refs #23523
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@Lms24
Lms24 force-pushed the lms/docs-low-card-db-span-names8 branch from 26f15f2 to 3181196 Compare September 3, 2026 13:15
@Lms24
Lms24 enabled auto-merge (squash) September 3, 2026 13:15
@Lms24
Lms24 merged commit ce228bc into develop Sep 3, 2026
38 checks passed
@Lms24
Lms24 deleted the lms/docs-low-card-db-span-names8 branch September 3, 2026 13:17
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