README
¶
dbtrace
Per-request DB call counting + pool logging. Off by default.
Enable
Config (db_trace.*) |
Env | Meaning |
|---|---|---|
enabled |
RESOLVESPEC_DB_TRACE_ENABLED |
per-request logging |
min_calls (5) |
..._MIN_CALLS |
log if tx+pooled+raw >= N |
min_duration (0) |
..._MIN_DURATION |
or request took >= D |
pool_log |
..._POOL_LOG |
log pool stats on each dbmanager metrics publish |
Wire: dbtrace.Configure(dbtrace.FromConfig(cfg.DBTrace)) and wrap handlers with dbtrace.Middleware (outside the auth middleware).
Log fields
txtransactions begun ·tx_queriesadapter queries insideRunInTransaction(share the tx connection)pooledadapter queries outside a tx (each takes a pool connection)rawdirect*sql.DBcalls, with kinds:auth.session,auth.activity,security.column,security.row,probe.pg_proc(lookupModeAutoonly),keystore.validate- Connections used ≈
tx + pooled + raw
Pool log
dbtrace pool <name>: open in_use idle max opened=+N waits=+N wait_time=+D — opened/waits are deltas since last publish.
Limits
- tx attribution is per request, assumes sequential use of a request's context
auth.activityruns detached after the response: not in the request's log lineBeginTx/CommitTx(manual tx) not counted; onlyRunInTransaction- Raw counters cover the hot paths listed above only (not login/OAuth/passkey/TOTP)
Documentation
¶
Overview ¶
Package dbtrace counts database calls per request and logs the heavy ones. It is off until Configure enables it; the hot-path helpers are no-ops for contexts without a tracker.
Connection use per request ≈ tx + pooled + raw (each pooled/raw call takes its own pool connection; calls inside RunInTransaction share the tx's).
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Configure ¶
func Configure(o Options)
Configure sets the active options. Safe to call at any time.
func Middleware ¶
Middleware tracks every request and logs those over the configured thresholds once the handler returns. Options are read per request, so Configure can toggle it at runtime. Raw calls made by detached goroutines after the response (e.g. session activity) are not included in the log line.
Types ¶
type Options ¶
type Options struct {
Enabled bool
MinCalls int // log when tx+pooled+raw >= MinCalls
MinDuration time.Duration // or when the request took at least this (0 = off)
PoolLog bool // log pool deltas on each dbmanager metrics publish
}
Options controls tracing.
func FromConfig ¶
func FromConfig(c config.DBTraceConfig) Options
FromConfig maps the application config to Options.
Source Files