database

Documentation

Index

• func GetMetric(name string) (prometheus.Metric, error)
• func NewEngine(ctx context.Context, conn pgxconn.PgxConn) *metricsEngineImpl
• type Engine

Functions

func GetMetric

func GetMetric(name string) (prometheus.Metric, error)

GetMetric returns the metric whose Description best matches the supplied name.

func NewEngine

func NewEngine(ctx context.Context, conn pgxconn.PgxConn) *metricsEngineImpl

NewEngine creates an engine that performs database metrics evaluation every evalInterval. The engine runs predefined queries that returns a BIGINT as the metric value which is then set as a value to Prometheus metric.

Note: Make sure to call this only when the database is TimescaleDB. Plain Postgres will cause evaluation errors.

Types

type Engine

type Engine interface {
	Run() error
	IsRunning() bool
}