...

Package reaper

import "github.com/cybertec-postgresql/pgwatch/v5/internal/reaper"
Overview
Index

Overview ▾

Package reaper is responsible to query the metrics from monitored sources and send measurements to sinks.

Index ▾

Constants
Variables
func CheckFolderExistsAndReadable(path string) bool
func DoesEmergencyTriggerfileExist(fname string) bool
func GetGoPsutilCPU(interval float64) ([]map[string]any, error)
func GetGoPsutilDiskPG(DataDirs, TblspaceDirs []map[string]any) ([]map[string]any, error)
func GetGoPsutilDiskTotals() ([]map[string]any, error)
func GetGoPsutilMem() ([]map[string]any, error)
func GetLoadAvgLocal() ([]map[string]any, error)
func GetPathUnderlyingDeviceID(path string) (uint64, error)
func IsDirectlyFetchableMetric(md *sources.SourceConn, metric string) bool
func QueryMeasurements(ctx context.Context, md *sources.SourceConn, sql string, args ...any) (metrics.Measurements, error)
func TryCreateMetricsFetchingHelpers(ctx context.Context, md *sources.SourceConn) (err error)
func TryCreateMissingExtensions(ctx context.Context, md *sources.SourceConn, extensionNames []string, existingExtensions map[string]int) []string
func checkHasLocalPrivileges(logsDirPath string) error
func checkHasRemotePrivileges(ctx context.Context, mdb *sources.SourceConn, logsDirPath string) error
func getFileWithLatestTimestamp(files []string) (string, error)
func getFileWithNextModTimestamp(logsGlobPath, currentFile string) (string, error)
func goPsutilCalcCPUUtilization(probe0, probe1 cpu.TimesStat) float64
func severityToEnglish(serverLang, errorSeverity string) string
func tryDetermineLogSettings(ctx context.Context, conn db.PgxIface) (string, string, string, error)
func zeroEventCounts(eventCounts map[string]int64)
type ChangeDetectionResults
    func (cdr *ChangeDetectionResults) String() string
    func (cdr *ChangeDetectionResults) Total() int
type ConcurrentMetricDefs
    func NewConcurrentMetricDefs() *ConcurrentMetricDefs
    func (cmd *ConcurrentMetricDefs) Assign(newDefs *metrics.Metrics)
    func (cmd *ConcurrentMetricDefs) GetMetricDef(name string) (m metrics.Metric, ok bool)
    func (cmd *ConcurrentMetricDefs) GetPresetDef(name string) (m metrics.Preset, ok bool)
    func (cmd *ConcurrentMetricDefs) GetPresetMetrics(name string) (m map[string]float64)
type ExistingPartitionInfo
type InstanceMetricCache
    func NewInstanceMetricCache() *InstanceMetricCache
    func (imc *InstanceMetricCache) Get(key string, age time.Duration) metrics.Measurements
    func (imc *InstanceMetricCache) Put(key string, data metrics.Measurements)
type LogParser
    func NewLogParser(ctx context.Context, mdb *sources.SourceConn, storeCh chan<- metrics.MeasurementEnvelope) (*LogParser, error)
    func (lp *LogParser) GetMeasurementEnvelope() metrics.MeasurementEnvelope
    func (lp *LogParser) HasSendIntervalElapsed() bool
    func (lp *LogParser) ParseLogs() error
    func (lp *LogParser) parseLogsLocal() error
    func (lp *LogParser) parseLogsRemote() error
    func (lp *LogParser) regexMatchesToMap(matches []string) map[string]string
type Reaper
    func NewReaper(ctx context.Context, opts *cmdopts.Options) (r *Reaper)
    func (r *Reaper) AddSysinfoToMeasurements(data metrics.Measurements, md *sources.SourceConn)
    func (r *Reaper) CloseResourcesForRemovedMonitoredDBs(hostsToShutDown map[string]bool)
    func (r *Reaper) CreateSourceHelpers(ctx context.Context, srcL log.Logger, monitoredSource *sources.SourceConn)
    func (r *Reaper) DetectConfigurationChanges(ctx context.Context, md *sources.SourceConn) ChangeDetectionResults
    func (r *Reaper) DetectIndexChanges(ctx context.Context, md *sources.SourceConn) ChangeDetectionResults
    func (r *Reaper) DetectPrivilegeChanges(ctx context.Context, md *sources.SourceConn) ChangeDetectionResults
    func (r *Reaper) DetectSprocChanges(ctx context.Context, md *sources.SourceConn) (changeCounts ChangeDetectionResults)
    func (r *Reaper) DetectTableChanges(ctx context.Context, md *sources.SourceConn) ChangeDetectionResults
    func (r *Reaper) FetchMetric(ctx context.Context, md *sources.SourceConn, metricName string) (_ *metrics.MeasurementEnvelope, err error)
    func (r *Reaper) FetchStatsDirectlyFromOS(ctx context.Context, md *sources.SourceConn, metricName string) (*metrics.MeasurementEnvelope, error)
    func (r *Reaper) GetInstanceUpMeasurement(ctx context.Context, md *sources.SourceConn) (metrics.Measurements, error)
    func (r *Reaper) GetObjectChangesMeasurement(ctx context.Context, md *sources.SourceConn) (metrics.Measurements, error)
    func (r *Reaper) LoadMetrics() (err error)
    func (r *Reaper) LoadSources(ctx context.Context) (err error)
    func (r *Reaper) PrintMemStats()
    func (r *Reaper) Ready() bool
    func (r *Reaper) Reap(ctx context.Context)
    func (r *Reaper) ShutdownOldWorkers(ctx context.Context, hostsToShutDown map[string]bool)
    func (r *Reaper) WriteMeasurements(ctx context.Context)
    func (r *Reaper) WriteMonitoredSources(ctx context.Context)
    func (r *Reaper) reapMetricMeasurements(ctx context.Context, md *sources.SourceConn, metricName string)

Package files

cache.go database.go doc.go file.go logparser.go logparser_local.go logparser_remote.go metric.go psutil.go psutil_linux.go reaper.go

Constants

const (
    metricCPULoad           = "cpu_load"
    metricPsutilCPU         = "psutil_cpu"
    metricPsutilDisk        = "psutil_disk"
    metricPsutilDiskIoTotal = "psutil_disk_io_total"
    metricPsutilMem         = "psutil_mem"
)
const (
    sqlPgDirs = `select current_setting('data_directory') as dd, current_setting('log_directory') as ld`
    sqlTsDirs = `select spcname::text as name, pg_catalog.pg_tablespace_location(oid) as location from pg_catalog.pg_tablespace where not spcname like any(array[E'pg\\_%'])`
)
const (
    monitoredDbsDatastoreSyncIntervalSeconds = 600              // write actively monitored DBs listing to metrics store after so many seconds
    monitoredDbsDatastoreSyncMetricName      = "configured_dbs" // FYI - for Postgres datastore there's also the admin.all_unique_dbnames table with all recent DB unique names with some metric data
    dbMetricJoinStr                          = "¤¤¤"            // just some unlikely string for a DB name to avoid using maps of maps for DB+metric data

)
const (
    specialMetricChangeEvents         = "change_events"
    specialMetricServerLogEventCounts = "server_log_event_counts"
    specialMetricInstanceUp           = "instance_up"
)
const csvLogDefaultGlobSuffix = "*.csv"
const csvLogDefaultRegEx = `^^(?P<log_time>.*?),"?(?P<user_name>.*?)"?,"?(?P<database_name>.*?)"?,(?P<process_id>\d+),"?(?P<connection_from>.*?)"?,(?P<session_id>.*?),(?P<session_line_num>\d+),"?(?P<command_tag>.*?)"?,(?P<session_start_time>.*?),(?P<virtual_transaction_id>.*?),(?P<transaction_id>.*?),(?P<error_severity>\w+),`
const maxChunkSize uint64 = 10 * 1024 * 1024 // 10 MB
const maxTrackedFiles = 2500

Variables

var directlyFetchableOSMetrics = []string{metricPsutilCPU, metricPsutilDisk, metricPsutilDiskIoTotal, metricPsutilMem, metricCPULoad}
var hostLastKnownStatusInRecovery = make(map[string]bool) // isInRecovery
var lastSQLFetchError sync.Map
var metricDefs = NewConcurrentMetricDefs()
var metricsConfig map[string]float64 // set to host.Metrics or host.MetricsStandby (in case optional config defined and in recovery state

Constants and types

var pgSeverities = [...]string{"DEBUG", "INFO", "NOTICE", "WARNING", "ERROR", "LOG", "FATAL", "PANIC"}
var pgSeveritiesLocale = map[string]map[string]string{
    "C.": {"DEBUG": "DEBUG", "LOG": "LOG", "INFO": "INFO", "NOTICE": "NOTICE", "WARNING": "WARNING", "ERROR": "ERROR", "FATAL": "FATAL", "PANIC": "PANIC"},
    "de": {"DEBUG": "DEBUG", "LOG": "LOG", "INFO": "INFO", "HINWEIS": "NOTICE", "WARNUNG": "WARNING", "FEHLER": "ERROR", "FATAL": "FATAL", "PANIK": "PANIC"},
    "fr": {"DEBUG": "DEBUG", "LOG": "LOG", "INFO": "INFO", "NOTICE": "NOTICE", "ATTENTION": "WARNING", "ERREUR": "ERROR", "FATAL": "FATAL", "PANIK": "PANIC"},
    "it": {"DEBUG": "DEBUG", "LOG": "LOG", "INFO": "INFO", "NOTIFICA": "NOTICE", "ATTENZIONE": "WARNING", "ERRORE": "ERROR", "FATALE": "FATAL", "PANICO": "PANIC"},
    "ko": {"디버그": "DEBUG", "로그": "LOG", "정보": "INFO", "알림": "NOTICE", "경고": "WARNING", "오류": "ERROR", "치명적오류": "FATAL", "손상": "PANIC"},
    "pl": {"DEBUG": "DEBUG", "DZIENNIK": "LOG", "INFORMACJA": "INFO", "UWAGA": "NOTICE", "OSTRZEŻENIE": "WARNING", "BŁĄD": "ERROR", "KATASTROFALNY": "FATAL", "PANIKA": "PANIC"},
    "ru": {"ОТЛАДКА": "DEBUG", "СООБЩЕНИЕ": "LOG", "ИНФОРМАЦИЯ": "INFO", "ЗАМЕЧАНИЕ": "NOTICE", "ПРЕДУПРЕЖДЕНИЕ": "WARNING", "ОШИБКА": "ERROR", "ВАЖНО": "FATAL", "ПАНИКА": "PANIC"},
    "sv": {"DEBUG": "DEBUG", "LOGG": "LOG", "INFO": "INFO", "NOTIS": "NOTICE", "VARNING": "WARNING", "FEL": "ERROR", "FATALT": "FATAL", "PANIK": "PANIC"},
    "tr": {"DEBUG": "DEBUG", "LOG": "LOG", "BİLGİ": "INFO", "NOT": "NOTICE", "UYARI": "WARNING", "HATA": "ERROR", "ÖLÜMCÜL (FATAL)": "FATAL", "KRİTİK": "PANIC"},
    "zh": {"调试": "DEBUG", "日志": "LOG", "信息": "INFO", "注意": "NOTICE", "警告": "WARNING", "错误": "ERROR", "致命错误": "FATAL", "比致命错误还过分的错误": "PANIC"},
}
var prevCPULoadTimeStats cpu.TimesStat

"cache" of last CPU utilization stats for GetGoPsutilCPU to get more exact results and not having to sleep

var prevCPULoadTimeStatsLock sync.RWMutex
var prevCPULoadTimestamp time.Time
var specialMetrics = map[string]bool{specialMetricChangeEvents: true, specialMetricServerLogEventCounts: true}

func CheckFolderExistsAndReadable

func CheckFolderExistsAndReadable(path string) bool

func DoesEmergencyTriggerfileExist

func DoesEmergencyTriggerfileExist(fname string) bool

func GetGoPsutilCPU

func GetGoPsutilCPU(interval float64) ([]map[string]any, error)

Simulates "psutil" metric output. Assumes the result from last call as input, otherwise uses a 1s measurement

func GetGoPsutilDiskPG

func GetGoPsutilDiskPG(DataDirs, TblspaceDirs []map[string]any) ([]map[string]any, error)

func GetGoPsutilDiskTotals

func GetGoPsutilDiskTotals() ([]map[string]any, error)

func GetGoPsutilMem

func GetGoPsutilMem() ([]map[string]any, error)

func GetLoadAvgLocal

func GetLoadAvgLocal() ([]map[string]any, error)

func GetPathUnderlyingDeviceID

func GetPathUnderlyingDeviceID(path string) (uint64, error)

func IsDirectlyFetchableMetric

func IsDirectlyFetchableMetric(md *sources.SourceConn, metric string) bool

func QueryMeasurements

func QueryMeasurements(ctx context.Context, md *sources.SourceConn, sql string, args ...any) (metrics.Measurements, error)

func TryCreateMetricsFetchingHelpers

func TryCreateMetricsFetchingHelpers(ctx context.Context, md *sources.SourceConn) (err error)

Called once on daemon startup to try to create "metric fething helper" functions automatically

func TryCreateMissingExtensions

func TryCreateMissingExtensions(ctx context.Context, md *sources.SourceConn, extensionNames []string, existingExtensions map[string]int) []string

Called once on daemon startup if some commonly wanted extension (most notably pg_stat_statements) is missing. With newer Postgres version can even succeed if the user is not a real superuser due to some cloud-specific whitelisting or "trusted extensions" (a feature from v13). Ignores errors.

func checkHasLocalPrivileges

func checkHasLocalPrivileges(logsDirPath string) error

func checkHasRemotePrivileges

func checkHasRemotePrivileges(ctx context.Context, mdb *sources.SourceConn, logsDirPath string) error

func getFileWithLatestTimestamp

func getFileWithLatestTimestamp(files []string) (string, error)

func getFileWithNextModTimestamp

func getFileWithNextModTimestamp(logsGlobPath, currentFile string) (string, error)

func goPsutilCalcCPUUtilization

func goPsutilCalcCPUUtilization(probe0, probe1 cpu.TimesStat) float64

func severityToEnglish

func severityToEnglish(serverLang, errorSeverity string) string

func tryDetermineLogSettings

func tryDetermineLogSettings(ctx context.Context, conn db.PgxIface) (string, string, string, error)

func zeroEventCounts

func zeroEventCounts(eventCounts map[string]int64)

type ChangeDetectionResults

type ChangeDetectionResults struct {
    Target  string
    Created int
    Altered int
    Dropped int
}

func (*ChangeDetectionResults) String

func (cdr *ChangeDetectionResults) String() string

func (*ChangeDetectionResults) Total

func (cdr *ChangeDetectionResults) Total() int

type ConcurrentMetricDefs

type ConcurrentMetricDefs struct {
    *metrics.Metrics
    sync.RWMutex
}

func NewConcurrentMetricDefs

func NewConcurrentMetricDefs() *ConcurrentMetricDefs

func (*ConcurrentMetricDefs) Assign

func (cmd *ConcurrentMetricDefs) Assign(newDefs *metrics.Metrics)

func (*ConcurrentMetricDefs) GetMetricDef

func (cmd *ConcurrentMetricDefs) GetMetricDef(name string) (m metrics.Metric, ok bool)

func (*ConcurrentMetricDefs) GetPresetDef

func (cmd *ConcurrentMetricDefs) GetPresetDef(name string) (m metrics.Preset, ok bool)

func (*ConcurrentMetricDefs) GetPresetMetrics

func (cmd *ConcurrentMetricDefs) GetPresetMetrics(name string) (m map[string]float64)

type ExistingPartitionInfo

type ExistingPartitionInfo struct {
    StartTime time.Time
    EndTime   time.Time
}

type InstanceMetricCache

type InstanceMetricCache struct {
    cache map[string](metrics.Measurements) // [dbUnique+metric]lastly_fetched_data
    sync.RWMutex
}

func NewInstanceMetricCache

func NewInstanceMetricCache() *InstanceMetricCache

func (*InstanceMetricCache) Get

func (imc *InstanceMetricCache) Get(key string, age time.Duration) metrics.Measurements

func (*InstanceMetricCache) Put

func (imc *InstanceMetricCache) Put(key string, data metrics.Measurements)

type LogParser

type LogParser struct {
    ctx                context.Context
    LogsMatchRegex     *regexp.Regexp
    LogFolder          string
    ServerMessagesLang string
    LogTruncOnRotation string
    SourceConn         *sources.SourceConn
    Interval           float64
    StoreCh            chan<- metrics.MeasurementEnvelope
    eventCounts        map[string]int64 // for the specific DB. [WARNING: 34, ERROR: 10, ...], zeroed on storage send
    eventCountsTotal   map[string]int64 // for the whole instance
    lastSendTime       time.Time
    fileOffsets        map[string]uint64 // map of log file paths to last read offsets
}

func NewLogParser

func NewLogParser(ctx context.Context, mdb *sources.SourceConn, storeCh chan<- metrics.MeasurementEnvelope) (*LogParser, error)

func (*LogParser) GetMeasurementEnvelope

func (lp *LogParser) GetMeasurementEnvelope() metrics.MeasurementEnvelope

GetMeasurementEnvelope converts current event counts to a MeasurementEnvelope

func (*LogParser) HasSendIntervalElapsed

func (lp *LogParser) HasSendIntervalElapsed() bool

func (*LogParser) ParseLogs

func (lp *LogParser) ParseLogs() error

func (*LogParser) parseLogsLocal

func (lp *LogParser) parseLogsLocal() error

func (*LogParser) parseLogsRemote

func (lp *LogParser) parseLogsRemote() error

func (*LogParser) regexMatchesToMap

func (lp *LogParser) regexMatchesToMap(matches []string) map[string]string

type Reaper

Reaper is the struct that responsible for fetching metrics measurements from the sources and storing them to the sinks

type Reaper struct {
    *cmdopts.Options
    ready                atomic.Bool
    measurementCh        chan metrics.MeasurementEnvelope
    measurementCache     *InstanceMetricCache
    logger               log.Logger
    monitoredSources     sources.SourceConns
    prevLoopMonitoredDBs sources.SourceConns
    cancelFuncs          map[string]context.CancelFunc
}

func NewReaper

func NewReaper(ctx context.Context, opts *cmdopts.Options) (r *Reaper)

NewReaper creates a new Reaper instance

func (*Reaper) AddSysinfoToMeasurements

func (r *Reaper) AddSysinfoToMeasurements(data metrics.Measurements, md *sources.SourceConn)

func (*Reaper) CloseResourcesForRemovedMonitoredDBs

func (r *Reaper) CloseResourcesForRemovedMonitoredDBs(hostsToShutDown map[string]bool)

func (*Reaper) CreateSourceHelpers

func (r *Reaper) CreateSourceHelpers(ctx context.Context, srcL log.Logger, monitoredSource *sources.SourceConn)

CreateSourceHelpers creates the extensions and metric helpers for the monitored source

func (*Reaper) DetectConfigurationChanges

func (r *Reaper) DetectConfigurationChanges(ctx context.Context, md *sources.SourceConn) ChangeDetectionResults

func (*Reaper) DetectIndexChanges

func (r *Reaper) DetectIndexChanges(ctx context.Context, md *sources.SourceConn) ChangeDetectionResults

func (*Reaper) DetectPrivilegeChanges

func (r *Reaper) DetectPrivilegeChanges(ctx context.Context, md *sources.SourceConn) ChangeDetectionResults

func (*Reaper) DetectSprocChanges

func (r *Reaper) DetectSprocChanges(ctx context.Context, md *sources.SourceConn) (changeCounts ChangeDetectionResults)

func (*Reaper) DetectTableChanges

func (r *Reaper) DetectTableChanges(ctx context.Context, md *sources.SourceConn) ChangeDetectionResults

func (*Reaper) FetchMetric

func (r *Reaper) FetchMetric(ctx context.Context, md *sources.SourceConn, metricName string) (_ *metrics.MeasurementEnvelope, err error)

func (*Reaper) FetchStatsDirectlyFromOS

func (r *Reaper) FetchStatsDirectlyFromOS(ctx context.Context, md *sources.SourceConn, metricName string) (*metrics.MeasurementEnvelope, error)

func (*Reaper) GetInstanceUpMeasurement

func (r *Reaper) GetInstanceUpMeasurement(ctx context.Context, md *sources.SourceConn) (metrics.Measurements, error)

GetInstanceUpMeasurement returns a single measurement with "instance_up" metric used to detect if the instance is up or down

func (*Reaper) GetObjectChangesMeasurement

func (r *Reaper) GetObjectChangesMeasurement(ctx context.Context, md *sources.SourceConn) (metrics.Measurements, error)

func (*Reaper) LoadMetrics

func (r *Reaper) LoadMetrics() (err error)

LoadMetrics loads metric definitions from the reader

func (*Reaper) LoadSources

func (r *Reaper) LoadSources(ctx context.Context) (err error)

LoadSources loads sources from the reader

func (*Reaper) PrintMemStats

func (r *Reaper) PrintMemStats()

func (*Reaper) Ready

func (r *Reaper) Ready() bool

Ready() returns true if the service is healthy and operating correctly

func (*Reaper) Reap

func (r *Reaper) Reap(ctx context.Context)

Reap() starts the main monitoring loop. It is responsible for fetching metrics measurements from the sources and storing them to the sinks. It also manages the lifecycle of the metric gatherers. In case of a source or metric definition change, it will start or stop the gatherers accordingly.

func (*Reaper) ShutdownOldWorkers

func (r *Reaper) ShutdownOldWorkers(ctx context.Context, hostsToShutDown map[string]bool)

func (*Reaper) WriteMeasurements

func (r *Reaper) WriteMeasurements(ctx context.Context)

WriteMeasurements() writes the metrics to the sinks

func (*Reaper) WriteMonitoredSources

func (r *Reaper) WriteMonitoredSources(ctx context.Context)

WriteMonitoredSources writes actively monitored DBs listing to sinks every monitoredDbsDatastoreSyncIntervalSeconds (default 10min)

func (*Reaper) reapMetricMeasurements

func (r *Reaper) reapMetricMeasurements(ctx context.Context, md *sources.SourceConn, metricName string)