mysql

Documentation

Index

• func CheckHealth() error
• func GetDB() (*sql.DB, error)
• func GetDialect() string
• func IsConnected() bool
• type DBMysqlClient
  • func NewMysqlClient() *DBMysqlClient
  • func (m *DBMysqlClient) CleanupTasks() error
  • func (m *DBMysqlClient) StartupTasks() error
• type PrometheusConfig
• type PrometheusMetrics
  • func NewPrometheusMetrics(config *PrometheusConfig) *PrometheusMetrics
  • func (m *PrometheusMetrics) GetGatherer() prometheus.Gatherer
  • func (m *PrometheusMetrics) IncConnectAttempt(config *conf.Mysql)
  • func (m *PrometheusMetrics) IncConnectFailure(config *conf.Mysql)
  • func (m *PrometheusMetrics) IncConnectRetry(config *conf.Mysql)
  • func (m *PrometheusMetrics) IncConnectSuccess(config *conf.Mysql)
  • func (m *PrometheusMetrics) RecordHealthCheck(success bool, config *conf.Mysql)
  • func (m *PrometheusMetrics) RecordQuery(op string, dur time.Duration, err error, threshold time.Duration, ...)
  • func (m *PrometheusMetrics) RecordTx(dur time.Duration, committed bool, config *conf.Mysql)
  • func (m *PrometheusMetrics) UpdateMetrics(stats *base.ConnectionPoolStats, config *conf.Mysql)

Functions

func CheckHealth

func CheckHealth() error

CheckHealth performs health check

func GetDB

func GetDB() (*sql.DB, error)

GetDB gets the database connection from the MySQL plugin

func GetDialect

func GetDialect() string

GetDialect gets the database dialect

func IsConnected

func IsConnected() bool

IsConnected checks if the database is connected

Types

type DBMysqlClient

type DBMysqlClient struct {
	*base.BaseSQLPlugin
	// contains filtered or unexported fields
}

DBMysqlClient represents MySQL client plugin instance

func NewMysqlClient

func NewMysqlClient() *DBMysqlClient

NewMysqlClient creates a new MySQL client plugin instance

func (*DBMysqlClient) CleanupTasks

func (m *DBMysqlClient) CleanupTasks() error

CleanupTasks gracefully closes database connection

func (*DBMysqlClient) StartupTasks

func (m *DBMysqlClient) StartupTasks() error

StartupTasks initializes database connection

type PrometheusConfig

type PrometheusConfig struct {
	Namespace string
	Subsystem string
	Labels    map[string]string
}

PrometheusConfig configuration for Prometheus metrics

type PrometheusMetrics

type PrometheusMetrics struct {
	// contains filtered or unexported fields
}

PrometheusMetrics holds all Prometheus metrics for MySQL

func NewPrometheusMetrics

func NewPrometheusMetrics(config *PrometheusConfig) *PrometheusMetrics

NewPrometheusMetrics creates new Prometheus metrics instance

func (*PrometheusMetrics) GetGatherer

func (m *PrometheusMetrics) GetGatherer() prometheus.Gatherer

GetGatherer returns the Prometheus gatherer

func (*PrometheusMetrics) IncConnectAttempt

func (m *PrometheusMetrics) IncConnectAttempt(config *conf.Mysql)

IncConnectAttempt increments connection attempt counter

func (*PrometheusMetrics) IncConnectFailure

func (m *PrometheusMetrics) IncConnectFailure(config *conf.Mysql)

IncConnectFailure increments connection failure counter

func (*PrometheusMetrics) IncConnectRetry

func (m *PrometheusMetrics) IncConnectRetry(config *conf.Mysql)

IncConnectRetry increments connection retry counter

func (*PrometheusMetrics) IncConnectSuccess

func (m *PrometheusMetrics) IncConnectSuccess(config *conf.Mysql)

IncConnectSuccess increments connection success counter

func (*PrometheusMetrics) RecordHealthCheck

func (m *PrometheusMetrics) RecordHealthCheck(success bool, config *conf.Mysql)

RecordHealthCheck records health check result

func (*PrometheusMetrics) RecordQuery

func (m *PrometheusMetrics) RecordQuery(op string, dur time.Duration, err error, threshold time.Duration, config *conf.Mysql, errorType string)

RecordQuery records SQL query duration, errors and slow query count

func (*PrometheusMetrics) RecordTx

func (m *PrometheusMetrics) RecordTx(dur time.Duration, committed bool, config *conf.Mysql)

RecordTx records transaction duration and status

func (*PrometheusMetrics) UpdateMetrics

func (m *PrometheusMetrics) UpdateMetrics(stats *base.ConnectionPoolStats, config *conf.Mysql)

UpdateMetrics updates all metrics with current stats