feat: Add tracing spans for database operations#2885
Merged
tyt2y3 merged 3 commits intoSeaQL:masterfrom Jan 17, 2026
Merged
Conversation
Contributor
Author
tyt2y3
reviewed
Jan 9, 2026
Comment on lines
+312
to
+315
| #[cfg(feature = "tracing-spans")] | ||
| let result = fut.instrument(span.clone()).await; | ||
| #[cfg(not(feature = "tracing-spans"))] | ||
| let result = fut.await; |
Member
There was a problem hiding this comment.
thanks you for the PR. is it possible to reduce the number of feature guarded statements using macros?
Contributor
Author
There was a problem hiding this comment.
@tyt2y3 Thanks for the suggestion — I refactored the tracing-spans instrumentation into a single with_db_span! macro.
- Add with_db_span! macro that encapsulates all tracing logic - Update db_connection.rs and transaction.rs to use the macro - Remove use tracing::Instrument (now using UFCS) - Call sites no longer need #[cfg(feature = "tracing-spans")]
4 tasks
🎉 Released In 2.0.0-rc.29 🎉Huge thanks for the contribution! |
strwbrr-fox
pushed a commit
to strwbrr-fox/sea-orm
that referenced
this pull request
Jan 27, 2026
* Add ObservabilityHook for distributed tracing support * Refactor: use with_db_span! macro to reduce #[cfg] statements - Add with_db_span! macro that encapsulates all tracing logic - Update db_connection.rs and transaction.rs to use the macro - Remove use tracing::Instrument (now using UFCS) - Call sites no longer need #[cfg(feature = "tracing-spans")]
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds optional tracing instrumentation for database operations, enabling distributed tracing and observability.
tracing-spansfeature flag for opt-in tracing supportexecute,query_one,query_all) and transaction flows (begin,commit,rollback)db.system,db.operation,db.statement,otel.status_code).instrument(span)pattern for proper async span context propagationMotivation
As noted in #2867, logs alone make it difficult to understand database call hierarchies and timing within request contexts. Spans provide:
Design Decision
The original issue proposed an
ObservabilityHookpattern. This PR takes a simpler approach by using thetracingcrate directly:tracingis the de facto standard for Rust instrumentationUsage
Span Attributes
db.systempostgresql,mysql,sqlitedb.operationSELECT,INSERT,UPDATE,DELETEdb.statementSELECT * FROM users WHERE id = $1otel.status_codeOK,ERRORexception.messageCloses #2867