tracking

func NewConnection ¶

func NewConnection(conn types.Interface, log logger.Logger, cfg *config.DatabaseConfig) types.Interface

NewConnection returns a database.Interface that wraps conn and records query/operation metrics and logs. The wrapper delegates all calls to the provided conn, uses conn.DatabaseType() NewConnection returns a types.Interface that wraps conn and records per-operation performance metrics, slow queries, and errors using the provided logger.

The wrapper uses conn.DatabaseType() as the vendor identifier and derives per-connection tracking settings from cfg via NewSettings.

func NewStatement ¶

func NewStatement(stmt types.Statement, log logger.Logger, vendor, query string, settings Settings) types.Statement

NewStatement creates a Statement wrapper that tracks performance for prepared statements. NewStatement wraps the provided statement with a tracking implementation that records execution metrics for Query, QueryRow, and Exec.

The returned types.Statement uses the supplied logger, vendor identifier, optional query string, and settings to control tracking behavior.

func NewTransaction ¶

func NewTransaction(tx types.Tx, log logger.Logger, vendor string, settings Settings) types.Tx

NewTransaction creates a Transaction wrapper that tracks performance for database transactions. NewTransaction creates a Transaction wrapper around the provided tx that records execution metrics for all transaction operations. The wrapper delegates calls to the given tx while capturing timing and error information, stores the provided logger, vendor, and settings, and initializes an internal Context used for tracking.

func SanitizeArgs ¶

func SanitizeArgs(args []any, maxLen int) []any

SanitizeArgs returns a sanitized copy of the provided argument slice suitable for logging.

If args is empty, it returns nil. String values are truncated using TruncateString with maxLen; byte slices are replaced with the placeholder "<bytes len=N>"; all other values are formatted with "%v" and then truncated using TruncateString. The returned slice has SanitizeArgs returns a sanitized copy of args suitable for logging. If args is empty it returns nil. String values are truncated to maxLen runes using TruncateString. Byte slices are replaced with the placeholder "<bytes len=N>" where N is the byte length. Other values are formatted with "%v" and then truncated to maxLen. The returned slice has the same length and element order as the input.

func TrackDBOperation ¶

func TrackDBOperation(ctx context.Context, tc *Context, query string, args []any, start time.Time, err error)

TrackDBOperation logs database operation performance metrics and errors. It provides centralized tracking for all database operations including queries, statements, and transactions. The function handles slow query detection, TrackDBOperation records metrics and emits a log event for a completed database operation.

TrackDBOperation is a no-op if tc or its Logger is nil. It records the operation's duration to request-scoped metrics, clamps the query string to the configured maximum length, and — when enabled — includes a sanitized form of parameters suitable for logging. If err is non-nil the error is logged (with sql.ErrNoRows logged at debug level); if there is no error and the duration exceeds the configured slow-query threshold a warning is emitted, otherwise a debug message is emitted.

func TruncateString ¶

func TruncateString(value string, maxLen int) string

TruncateString returns value truncated to at most maxLen characters. If maxLen <= 0 or value is already shorter than or equal to maxLen, the original string is returned. When maxLen <= 3 the function returns the first maxLen characters (no ellipsis); otherwise it returns the first TruncateString truncates value to at most maxLen runes, adding "..." when space allows to indicate truncation.

If maxLen <= 0 the original value is returned unchanged. If the string's rune count is less than or equal to maxLen the original value is returned. When maxLen <= 3 the function returns the first maxLen runes without an ellipsis. For maxLen > 3 the result contains the first (maxLen-3) runes followed by "...". Multi-byte characters are handled safely by operating on runes.