feat(server-utils)!: Emit low cardinality knex, tedious and prisma db span names - #23602
feat(server-utils)!: Emit low cardinality knex, tedious and prisma db span names#23602Lms24 wants to merge 1 commit into
Conversation
… span names
With span streaming, these three name their query spans from the span name
conventions instead of the SQL statement. They are grouped because each needs a
different fallback: knex drops to its existing `{operation} {namespace}.{table}`,
tedious has no statement to summarize and keeps `getSpanName`, and prisma resolves
its statement from either `db.statement` or `db.query.text` depending on version.
knex and prisma also report the new `db.query.summary` attribute.
`traceLifecycle: 'static'` keeps the existing names.
Refs #23523
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 2 potential issues.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit c57ede4. Configure here.
| // `from`/`join` can't leak a value into the summary. | ||
| const querySummary = dbStatement | ||
| ? _INTERNAL_getSqlQuerySummary(_INTERNAL_sanitizeSqlQuery(dbStatement)) | ||
| : undefined; |
There was a problem hiding this comment.
Truncation breaks summary sanitization
Medium Severity
Knex truncates the SQL with truncate before _INTERNAL_sanitizeSqlQuery and _INTERNAL_getSqlQuerySummary. Truncation can cut an open string literal, so the sanitize pass misses it and FROM/JOIN tokens inside that literal can land in db.query.summary and the streamed span name, which is the leak this sanitization step is meant to block.
Reviewed by Cursor Bugbot for commit c57ede4. Configure here.
|
|
||
| return startInactiveSpan({ | ||
| name: dbStatement ?? getName(name, operation, table) ?? 'knex.query', | ||
| name: streamedName ?? dbStatement ?? getName(name, operation, table) ?? 'knex.query', |
There was a problem hiding this comment.
Feat PR missing integration tests
Medium Severity
Flagged because the PR review guidelines ask feat PRs to include at least one integration or E2E test. This change adds streamed low-cardinality names and db.query.summary for knex, prisma, and tedious, but the commit has no tests that assert the new naming or attributes under traceLifecycle: 'stream' versus static.
Additional Locations (2)
Triggered by project rule: PR Review Guidelines for Cursor Bot
Reviewed by Cursor Bugbot for commit c57ede4. Configure here.
size-limit report 📦
|


With span streaming enabled:
db.query.summary{operation} {namespace}.{table}{operation} {namespace}db.query.summaryattribute on knex and prismatraceLifecycle: 'static'keeps the existing namesGrouped because each needs a different per-driver fallback.
Refs #23523