postgres

Documentation

Overview

Package postgres provides pgx pool construction, query tracing, and per-request DB stats.

Index

• func NewPool(ctx context.Context, databaseURL string) (*pgxpool.Pool, error)
• func NewReqDBStatsContext(ctx context.Context) context.Context
• func SetQueryObserver(o QueryObserver)
• func WithHTTPMethod(ctx context.Context, method string) context.Context
• type QueryObserver
• type QueryObserverFunc
  • func (f QueryObserverFunc) ObserveQuery(ctx context.Context, method, route, outcome string, dur time.Duration)
• type ReqDBStats
  • func ReqDBStatsFromContext(ctx context.Context) (*ReqDBStats, bool)
  • func (s *ReqDBStats) AddQuery(dur time.Duration, err error)

Functions

func NewPool

func NewPool(ctx context.Context, databaseURL string) (*pgxpool.Pool, error)

NewPool creates a pgxpool.Pool with OTel tracing and structured query logging.

func NewReqDBStatsContext

func NewReqDBStatsContext(ctx context.Context) context.Context

NewReqDBStatsContext returns a new context with an empty ReqDBStats attached.

func SetQueryObserver

func SetQueryObserver(o QueryObserver)

SetQueryObserver sets the global query observer (typically a Prometheus histogram).

func WithHTTPMethod

func WithHTTPMethod(ctx context.Context, method string) context.Context

WithHTTPMethod stores the HTTP method in the context for query metrics labelling.

Types

type QueryObserver

type QueryObserver interface {
	ObserveQuery(ctx context.Context, method, route, outcome string, dur time.Duration)
}

QueryObserver receives per-query metrics (wired by main for Prometheus).

type QueryObserverFunc

type QueryObserverFunc func(ctx context.Context, method, route, outcome string, dur time.Duration)

QueryObserverFunc adapts a plain function to QueryObserver.

func (QueryObserverFunc) ObserveQuery

func (f QueryObserverFunc) ObserveQuery(ctx context.Context, method, route, outcome string, dur time.Duration)

ObserveQuery implements QueryObserver.

type ReqDBStats

type ReqDBStats struct {
	QueryCount    int
	TotalDuration time.Duration
	ErrorCount    int
	// contains filtered or unexported fields
}

ReqDBStats accumulates per-request database query statistics.

func ReqDBStatsFromContext

func ReqDBStatsFromContext(ctx context.Context) (*ReqDBStats, bool)

ReqDBStatsFromContext extracts the ReqDBStats from the context, if present.

func (*ReqDBStats) AddQuery

func (s *ReqDBStats) AddQuery(dur time.Duration, err error)

AddQuery records a single query execution.