Skip to content

feat: Add tracing spans for database operations #2885

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
uuushiro wants to merge 3 commits into
base: master
Choose a base branch
from
Open

feat: Add tracing spans for database operations #2885

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
57ec8c7
Add ObservabilityHook for distributed tracing support
uuushiro Dec 27, 2025
ae1ec85
Merge remote-tracking branch 'upstream/master' into feature/tracing-s…
uuushiro Jan 10, 2026
2eff1b9
Refactor: use with_db_span! macro to reduce #[cfg] statements
uuushiro Jan 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ features = [
"proxy",
"rbac",
"schema-sync",
"tracing-spans",
"runtime-tokio-native-tls",
"postgres-array",
"postgres-vector",
Expand Down Expand Up @@ -105,6 +106,7 @@ uuid = { version = "1", features = ["v4"] }

[features]
debug-print = []
tracing-spans = []
default = [
"macros",
"with-json",
Expand Down
204 changes: 131 additions & 73 deletions src/database/db_connection.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,95 +144,153 @@ impl ConnectionTrait for DatabaseConnection {
#[instrument(level = "trace")]
#[allow(unused_variables)]
async fn execute_raw(&self, stmt: Statement) -> Result<ExecResult, DbErr> {
match &self.inner {
#[cfg(feature = "sqlx-mysql")]
DatabaseConnectionType::SqlxMySqlPoolConnection(conn) => conn.execute(stmt).await,
#[cfg(feature = "sqlx-postgres")]
DatabaseConnectionType::SqlxPostgresPoolConnection(conn) => conn.execute(stmt).await,
#[cfg(feature = "sqlx-sqlite")]
DatabaseConnectionType::SqlxSqlitePoolConnection(conn) => conn.execute(stmt).await,
#[cfg(feature = "rusqlite")]
DatabaseConnectionType::RusqliteSharedConnection(conn) => conn.execute(stmt),
#[cfg(feature = "mock")]
DatabaseConnectionType::MockDatabaseConnection(conn) => conn.execute(stmt),
#[cfg(feature = "proxy")]
DatabaseConnectionType::ProxyDatabaseConnection(conn) => conn.execute(stmt).await,
DatabaseConnectionType::Disconnected => Err(conn_err("Disconnected")),
}
crate::with_db_span!(
"sea_orm.execute",
self.get_database_backend(),
stmt.sql.as_str(),
record_stmt = true,
async {
match &self.inner {
#[cfg(feature = "sqlx-mysql")]
DatabaseConnectionType::SqlxMySqlPoolConnection(conn) => {
conn.execute(stmt).await
}
#[cfg(feature = "sqlx-postgres")]
DatabaseConnectionType::SqlxPostgresPoolConnection(conn) => {
conn.execute(stmt).await
}
#[cfg(feature = "sqlx-sqlite")]
DatabaseConnectionType::SqlxSqlitePoolConnection(conn) => {
conn.execute(stmt).await
}
#[cfg(feature = "rusqlite")]
DatabaseConnectionType::RusqliteSharedConnection(conn) => conn.execute(stmt),
#[cfg(feature = "mock")]
DatabaseConnectionType::MockDatabaseConnection(conn) => conn.execute(stmt),
#[cfg(feature = "proxy")]
DatabaseConnectionType::ProxyDatabaseConnection(conn) => {
conn.execute(stmt).await
}
DatabaseConnectionType::Disconnected => Err(conn_err("Disconnected")),
}
}
)
}

#[instrument(level = "trace")]
#[allow(unused_variables)]
async fn execute_unprepared(&self, sql: &str) -> Result<ExecResult, DbErr> {
match &self.inner {
#[cfg(feature = "sqlx-mysql")]
DatabaseConnectionType::SqlxMySqlPoolConnection(conn) => {
conn.execute_unprepared(sql).await
}
#[cfg(feature = "sqlx-postgres")]
DatabaseConnectionType::SqlxPostgresPoolConnection(conn) => {
conn.execute_unprepared(sql).await
}
#[cfg(feature = "sqlx-sqlite")]
DatabaseConnectionType::SqlxSqlitePoolConnection(conn) => {
conn.execute_unprepared(sql).await
}
#[cfg(feature = "rusqlite")]
DatabaseConnectionType::RusqliteSharedConnection(conn) => conn.execute_unprepared(sql),
#[cfg(feature = "mock")]
DatabaseConnectionType::MockDatabaseConnection(conn) => {
let db_backend = conn.get_database_backend();
let stmt = Statement::from_string(db_backend, sql);
conn.execute(stmt)
}
#[cfg(feature = "proxy")]
DatabaseConnectionType::ProxyDatabaseConnection(conn) => {
let db_backend = conn.get_database_backend();
let stmt = Statement::from_string(db_backend, sql);
conn.execute(stmt).await
crate::with_db_span!(
"sea_orm.execute_unprepared",
self.get_database_backend(),
sql,
record_stmt = false,
async {
match &self.inner {
#[cfg(feature = "sqlx-mysql")]
DatabaseConnectionType::SqlxMySqlPoolConnection(conn) => {
conn.execute_unprepared(sql).await
}
#[cfg(feature = "sqlx-postgres")]
DatabaseConnectionType::SqlxPostgresPoolConnection(conn) => {
conn.execute_unprepared(sql).await
}
#[cfg(feature = "sqlx-sqlite")]
DatabaseConnectionType::SqlxSqlitePoolConnection(conn) => {
conn.execute_unprepared(sql).await
}
#[cfg(feature = "rusqlite")]
DatabaseConnectionType::RusqliteSharedConnection(conn) => {
conn.execute_unprepared(sql)
}
#[cfg(feature = "mock")]
DatabaseConnectionType::MockDatabaseConnection(conn) => {
let db_backend = conn.get_database_backend();
let stmt = Statement::from_string(db_backend, sql);
conn.execute(stmt)
}
#[cfg(feature = "proxy")]
DatabaseConnectionType::ProxyDatabaseConnection(conn) => {
let db_backend = conn.get_database_backend();
let stmt = Statement::from_string(db_backend, sql);
conn.execute(stmt).await
}
DatabaseConnectionType::Disconnected => Err(conn_err("Disconnected")),
}
}
DatabaseConnectionType::Disconnected => Err(conn_err("Disconnected")),
}
)
}

#[instrument(level = "trace")]
#[allow(unused_variables)]
async fn query_one_raw(&self, stmt: Statement) -> Result<Option<QueryResult>, DbErr> {
match &self.inner {
#[cfg(feature = "sqlx-mysql")]
DatabaseConnectionType::SqlxMySqlPoolConnection(conn) => conn.query_one(stmt).await,
#[cfg(feature = "sqlx-postgres")]
DatabaseConnectionType::SqlxPostgresPoolConnection(conn) => conn.query_one(stmt).await,
#[cfg(feature = "sqlx-sqlite")]
DatabaseConnectionType::SqlxSqlitePoolConnection(conn) => conn.query_one(stmt).await,
#[cfg(feature = "rusqlite")]
DatabaseConnectionType::RusqliteSharedConnection(conn) => conn.query_one(stmt),
#[cfg(feature = "mock")]
DatabaseConnectionType::MockDatabaseConnection(conn) => conn.query_one(stmt),
#[cfg(feature = "proxy")]
DatabaseConnectionType::ProxyDatabaseConnection(conn) => conn.query_one(stmt).await,
DatabaseConnectionType::Disconnected => Err(conn_err("Disconnected")),
}
crate::with_db_span!(
"sea_orm.query_one",
self.get_database_backend(),
stmt.sql.as_str(),
record_stmt = true,
async {
match &self.inner {
#[cfg(feature = "sqlx-mysql")]
DatabaseConnectionType::SqlxMySqlPoolConnection(conn) => {
conn.query_one(stmt).await
}
#[cfg(feature = "sqlx-postgres")]
DatabaseConnectionType::SqlxPostgresPoolConnection(conn) => {
conn.query_one(stmt).await
}
#[cfg(feature = "sqlx-sqlite")]
DatabaseConnectionType::SqlxSqlitePoolConnection(conn) => {
conn.query_one(stmt).await
}
#[cfg(feature = "rusqlite")]
DatabaseConnectionType::RusqliteSharedConnection(conn) => conn.query_one(stmt),
#[cfg(feature = "mock")]
DatabaseConnectionType::MockDatabaseConnection(conn) => conn.query_one(stmt),
#[cfg(feature = "proxy")]
DatabaseConnectionType::ProxyDatabaseConnection(conn) => {
conn.query_one(stmt).await
}
DatabaseConnectionType::Disconnected => Err(conn_err("Disconnected")),
}
}
)
}

#[instrument(level = "trace")]
#[allow(unused_variables)]
async fn query_all_raw(&self, stmt: Statement) -> Result<Vec<QueryResult>, DbErr> {
match &self.inner {
#[cfg(feature = "sqlx-mysql")]
DatabaseConnectionType::SqlxMySqlPoolConnection(conn) => conn.query_all(stmt).await,
#[cfg(feature = "sqlx-postgres")]
DatabaseConnectionType::SqlxPostgresPoolConnection(conn) => conn.query_all(stmt).await,
#[cfg(feature = "sqlx-sqlite")]
DatabaseConnectionType::SqlxSqlitePoolConnection(conn) => conn.query_all(stmt).await,
#[cfg(feature = "rusqlite")]
DatabaseConnectionType::RusqliteSharedConnection(conn) => conn.query_all(stmt),
#[cfg(feature = "mock")]
DatabaseConnectionType::MockDatabaseConnection(conn) => conn.query_all(stmt),
#[cfg(feature = "proxy")]
DatabaseConnectionType::ProxyDatabaseConnection(conn) => conn.query_all(stmt).await,
DatabaseConnectionType::Disconnected => Err(conn_err("Disconnected")),
}
crate::with_db_span!(
"sea_orm.query_all",
self.get_database_backend(),
stmt.sql.as_str(),
record_stmt = true,
async {
match &self.inner {
#[cfg(feature = "sqlx-mysql")]
DatabaseConnectionType::SqlxMySqlPoolConnection(conn) => {
conn.query_all(stmt).await
}
#[cfg(feature = "sqlx-postgres")]
DatabaseConnectionType::SqlxPostgresPoolConnection(conn) => {
conn.query_all(stmt).await
}
#[cfg(feature = "sqlx-sqlite")]
DatabaseConnectionType::SqlxSqlitePoolConnection(conn) => {
conn.query_all(stmt).await
}
#[cfg(feature = "rusqlite")]
DatabaseConnectionType::RusqliteSharedConnection(conn) => conn.query_all(stmt),
#[cfg(feature = "mock")]
DatabaseConnectionType::MockDatabaseConnection(conn) => conn.query_all(stmt),
#[cfg(feature = "proxy")]
DatabaseConnectionType::ProxyDatabaseConnection(conn) => {
conn.query_all(stmt).await
}
DatabaseConnectionType::Disconnected => Err(conn_err("Disconnected")),
}
}
)
}

#[cfg(feature = "mock")]
Expand Down
Loading
Loading