launchbadge/sqlx

Log queries including bind arguments and execution time

Open

#162 opened on Mar 26, 2020

View on GitHub
 (9 comments) (0 reactions) (0 assignees)Rust (13,916 stars) (1,307 forks)batch import
enhancementhelp wanted

Description

TRACE sqlx::query > SELECT …, elapsed: 0.04ms

    SELECT foo, bar, baz
    FROM this_table_over_here
    WHERE foo = $1 AND bar = $2
    ORDER BY baz

    $1 = 50
    $2 = 694

TRACE sqlx::query > INSERT INTO table_name …, elapsed: 12.04ms

Log format is very "let's figure out what we think looks best". Use log. We should new line + indent like error stack traces for the query body. Not sure how to nicely show the bind arguments.

Contributor guide

Tech stack
rust
Domain
backenddatabaseobservability
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Rust programmingUnderstanding of sqlx query executionFamiliarity with the `log` crate
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Examine the current trace logging in sqlx, likely in `sqlx core/src/query.rs` or similar, to understand where the elapsed time and bind arguments are available. Determine how to format the output with newlines and indentation for the query body and how to display bind arguments. Review any prior discussion or linked PRs in the issue for design preferences. Implement using the `log::trace!` macro and ensure the format is consistent with other sqlx logs.