base

package

Go to main page

Versions in this module

v1

v1.6.3

Jun 7, 2026

Changes in this version

+ type HealthReporter interface

+ Name func() string

+ ReportHealth func() error

type PoolThresholds

+ AlertCooldown time.Duration

type SQLPlugin

+ func (p *SQLPlugin) InitializeFromConfig(rt plugins.Runtime) error

+ func (p *SQLPlugin) ReportHealth() error

v1.6.2

Jun 4, 2026

v1.6.1

May 27, 2026

Changes in this version

type SQLPlugin

+ func (p *SQLPlugin) CheckHealthContext(ctx context.Context) error

+ func (p *SQLPlugin) GetValidatedConn(ctx context.Context) (*sql.Conn, error)

+ func (p *SQLPlugin) IsConnectedContext(ctx context.Context) bool

+ func (p *SQLPlugin) ReconnectContext(ctx context.Context) error

+ func (p *SQLPlugin) SetProvider(provider interfaces.DBProvider)

+ func (p *SQLPlugin) SharedProviderResourceName() string

v1.6.0-beta

Mar 29, 2026

v1.5.5

Mar 8, 2026

v1.5.4

Mar 2, 2026

v1.5.3

Feb 10, 2026

Changes in this version

+ var ErrAlreadyClosed = errors.New("database already closed")

+ var ErrNotConnected = errors.New("database not connected")

+ type AutoReconnector struct

+ func NewAutoReconnector(target Reconnectable, interval time.Duration, maxAttempts int) *AutoReconnector

+ func (a *AutoReconnector) GetAttempts() int64

+ func (a *AutoReconnector) Start(ctx context.Context)

+ func (a *AutoReconnector) Stop()

+ type ConnectionPoolStats struct

+ Idle int64

+ InUse int64

+ MaxIdleClosed int64

+ MaxIdleConnections int64

+ MaxLifetimeClosed int64

+ MaxOpenConnections int64

+ OpenConnections int64

+ WaitCount int64

+ WaitDuration time.Duration

+ type HealthCheckable interface

+ CheckHealth func() error

+ Name func() string

+ type HealthChecker struct

+ func NewHealthChecker(target HealthCheckable, interval time.Duration, customQuery string) *HealthChecker

+ func (h *HealthChecker) IsHealthy() bool

+ func (h *HealthChecker) Start(ctx context.Context)

+ func (h *HealthChecker) Stop()

+ type LeakDetector struct

+ func NewLeakDetector(target Monitorable, threshold time.Duration) *LeakDetector

+ func (l *LeakDetector) Start(ctx context.Context)

+ func (l *LeakDetector) Stop()

+ type MetricsConfig struct

+ Enabled bool

+ Labels map[string]string

+ Namespace string

+ SlowQueryThreshold time.Duration

+ Subsystem string

+ func DefaultMetricsConfig() *MetricsConfig

+ type MetricsRecorder interface

+ IncConnectAttempt func()

+ IncConnectFailure func()

+ IncConnectRetry func()

+ IncConnectSuccess func()

+ RecordConnectionPoolStats func(stats *ConnectionPoolStats)

+ RecordHealthCheck func(success bool)

+ RecordQuery func(duration time.Duration, err error, threshold time.Duration)

+ RecordTx func(duration time.Duration, committed bool)

+ type Monitorable interface

+ GetStats func() *ConnectionPoolStats

+ Name func() string

+ type NoOpMetricsRecorder struct

+ func (n *NoOpMetricsRecorder) IncConnectAttempt()

+ func (n *NoOpMetricsRecorder) IncConnectFailure()

+ func (n *NoOpMetricsRecorder) IncConnectRetry()

+ func (n *NoOpMetricsRecorder) IncConnectSuccess()

+ func (n *NoOpMetricsRecorder) RecordConnectionPoolStats(stats *ConnectionPoolStats)

+ func (n *NoOpMetricsRecorder) RecordHealthCheck(success bool)

+ func (n *NoOpMetricsRecorder) RecordQuery(duration time.Duration, err error, threshold time.Duration)

+ func (n *NoOpMetricsRecorder) RecordTx(duration time.Duration, committed bool)

+ type PoolMonitor struct

+ func NewPoolMonitor(target Monitorable, interval time.Duration, thresholds *PoolThresholds) *PoolMonitor

+ func (m *PoolMonitor) Start(ctx context.Context)

+ func (m *PoolMonitor) Stop()

+ type PoolThresholds struct

+ UsagePercentage float64

+ WaitCount int64

+ WaitDuration time.Duration

+ type PrometheusMetrics struct

+ func NewPrometheusMetrics(config *MetricsConfig) *PrometheusMetrics

+ func (pm *PrometheusMetrics) GetGatherer() prometheus.Gatherer

+ func (pm *PrometheusMetrics) IncConnectAttempt()

+ func (pm *PrometheusMetrics) IncConnectFailure()

+ func (pm *PrometheusMetrics) IncConnectRetry()

+ func (pm *PrometheusMetrics) IncConnectSuccess()

+ func (pm *PrometheusMetrics) RecordConnectionPoolStats(stats *ConnectionPoolStats)

+ func (pm *PrometheusMetrics) RecordHealthCheck(success bool)

+ func (pm *PrometheusMetrics) RecordQuery(duration time.Duration, err error, threshold time.Duration)

+ func (pm *PrometheusMetrics) RecordTx(duration time.Duration, committed bool)

+ type QueryMonitor struct

+ func NewQueryMonitor(enabled bool, threshold time.Duration, recorder MetricsRecorder) *QueryMonitor

+ func (m *QueryMonitor) MonitorExec(ctx context.Context, db *sql.DB, query string, args []interface{}) (sql.Result, error)

+ func (m *QueryMonitor) MonitorQuery(ctx context.Context, db *sql.DB, query string, args []interface{}, ...) error

+ func (m *QueryMonitor) MonitorQueryRow(ctx context.Context, db *sql.DB, query string, args []interface{}, ...) error

+ type Reconnectable interface

+ IsConnected func() bool

+ Name func() string

+ Reconnect func() error

+ type Recoverable interface

+ IsConnected func() bool

+ Reconnect func() error

+ type SQLPlugin struct

+ func NewBaseSQLPlugin(id, name, desc, version, confPrefix string, weight int, ...) *SQLPlugin

+ func (p *SQLPlugin) CheckHealth() error

+ func (p *SQLPlugin) CleanupTasks() error

+ func (p *SQLPlugin) GetAutoReconnector() *AutoReconnector

+ func (p *SQLPlugin) GetDB() (*sql.DB, error)

+ func (p *SQLPlugin) GetDBWithContext(ctx context.Context) (*sql.DB, error)

+ func (p *SQLPlugin) GetDialect() string

+ func (p *SQLPlugin) GetMetricsRecorder() MetricsRecorder

+ func (p *SQLPlugin) GetQueryMonitor() *QueryMonitor

+ func (p *SQLPlugin) GetStats() *ConnectionPoolStats

+ func (p *SQLPlugin) InitializeResources(rt plugins.Runtime) error

+ func (p *SQLPlugin) IsConnected() bool

+ func (p *SQLPlugin) Reconnect() error

+ func (p *SQLPlugin) SetMetricsRecorder(recorder MetricsRecorder)

+ func (p *SQLPlugin) StartupTasks() error

v1.5.2

Jan 15, 2026

v1.5.0

Dec 5, 2025

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL