pg

package
v1.3.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 23, 2026 License: Apache-2.0 Imports: 21 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	MetricDatabaseTransactionsPerSecond = "database_transactions_per_second"
	MetricDatabaseConnections           = "database_connections"
	MetricSystemDbSize                  = "system_db_size"
	MetricDatabaseAutovacuumCount       = "database_autovacuum_count"
	MetricServerUptime                  = "server_uptime"
	MetricPgDatabase                    = "pg_database"
	MetricPgUserTables                  = "pg_user_tables"
	MetricPgBgwriter                    = "pg_bgwriter"
	MetricPgWal                         = "pg_wal"
	MetricDatabaseWaitEvents            = "database_wait_events"
	MetricHardware                      = "hardware"
	MetricPgCheckpointer                = "pg_checkpointer"
	MetricCpuUtilization                = "cpu_utilization"
	MetricMemoryUsed                    = "memory_used"
)

Metric collector key constants. These are the Key values used in adapter MetricCollector entries.

View Source 
const AlterSystemQuery = `
ALTER SYSTEM SET %s = %s;
`
View Source 
const AlterSystemResetQuery = `
ALTER SYSTEM RESET %s;

`
View Source 
const CheckPGStatStatementsQuery = `
SELECT COUNT(*) FROM public.pg_stat_statements;
`
View Source 
const CurrentDatabaseQuery = `
SELECT current_database();
`

CurrentDatabaseQuery returns the name of the database the agent is connected to.

View Source 
const (
	DEFAULT_CONFIG_KEY = "postgresql"
)
View Source 
const MaxConnectionsQuery = `
SELECT setting::integer FROM pg_settings WHERE  name = 'max_connections';
`
View Source 
const PGVersionQuery = `
SELECT version();
`

PGVersion returns the version of the PostgreSQL instance

View Source 
const ReloadConfigQuery = `
SELECT pg_reload_conf();
`
View Source 
const Select1Query = `
SELECT 1;
`
View Source 
const UserDatabaseCountQuery = `
SELECT count(*)::integer FROM pg_database WHERE NOT datistemplate AND datallowconn;
`

UserDatabaseCountQuery counts the non-template, connectable databases in the cluster. A count greater than 1 indicates the tuned database shares the cluster with other user databases.

Variables

This section is empty.

Functions

func AlterSystem 

func AlterSystem(pgPool *pgxpool.Pool, name string, value string) error

func AlterSystemReset added in v0.6.1 

func AlterSystemReset(pgPool *pgxpool.Pool, name string) error

func BuildCatalogCollectors added in v1.1.0 

func BuildCatalogCollectors(
	pool *pgxpool.Pool,
	pgMajorVersion int,
	cfg CollectorsConfig,
	prepareCtx queries.PrepareCtx,
) ([]queries.CatalogCollector, error)

BuildCatalogCollectors creates the full set of catalog collectors, applying per-collector config from CollectorsConfig (enabled filter, interval overrides). A nil pool is allowed for construction-only callers (e.g. tests); the pointer is only dereferenced when a collector's Collect is invoked.

func CatalogCollectorsForVersion added in v1.1.0 

func CatalogCollectorsForVersion(pool *pgxpool.Pool, pgVersion string, cfg CollectorsConfig) ([]queries.CatalogCollector, error)

CatalogCollectorsForVersion builds the catalog collector set with a pre-loaded/adjusted CollectorsConfig.

func CheckPGStatStatements added in v0.4.0 

func CheckPGStatStatements(pgPool *pgxpool.Pool) error

func CurrentDatabase added in v1.3.0 

func CurrentDatabase(pgPool *pgxpool.Pool) (string, error)

CurrentDatabase returns the name of the database the agent is connected to (i.e. the database being tuned).

func DatabaseSystemInfo added in v1.3.0 

func DatabaseSystemInfo(pgPool *pgxpool.Pool) ([]metrics.FlatValue, error)

DatabaseSystemInfo returns the system-info metrics describing which database the agent is tuning (pg_current_database) and how many user databases share the cluster (pg_database_count). This lets us tell whether the tuned database runs standalone or alongside other databases in the same cluster.

func GetActiveConfig 

func GetActiveConfig(
	pool *pgxpool.Pool,
	ctx context.Context,
) (agent.ConfigArraySchema, error)

func InferNumericType added in v0.6.3 

func InferNumericType(setting interface{}) interface{}

inferNumericType attempts to parse a string setting into a numeric Go type. Returns int64 if parseable as integer, float64 if parseable as float, or the original string if neither. This preserves JSON serialization format (200 not "200") without relying on the potentially unreliable vartype metadata.

func IsConnectionError added in v0.6.3 

func IsConnectionError(err error) bool

IsConnectionError returns true if err indicates a connection-level problem (as opposed to a query-level error like a missing relation or syntax error).

func MaxConnections 

func MaxConnections(pgPool *pgxpool.Pool) (uint32, error)

func PGMajorVersion added in v1.1.0 

func PGMajorVersion(version string) (int, error)

PGMajorVersion extracts the integer major version from a version string like "16.4".

func PGVersion 

func PGVersion(pgPool *pgxpool.Pool) (string, error)

Example: 16.4

func ReloadConfig 

func ReloadConfig(pgPool *pgxpool.Pool) error

func RestartRequiredParams added in v1.1.6 

func RestartRequiredParams(pgPool *pgxpool.Pool, ctx context.Context, parameterNames []string) ([]string, error)

RestartRequiredParams returns the subset of the supplied parameter names whose value cannot be changed without restarting PostgreSQL (i.e. pg_settings.context = 'postmaster').

func StandardCatalogCollectors added in v1.1.0 

func StandardCatalogCollectors(pool *pgxpool.Pool, pgVersion string) ([]queries.CatalogCollector, error)

StandardCatalogCollectors loads CollectorsConfig from viper and builds the default catalog collector set for the given pool and PG version string. Use CatalogCollectorsForVersion when you need to mutate the config first.

func UserDatabaseCount added in v1.3.0 

func UserDatabaseCount(pgPool *pgxpool.Pool) (int, error)

UserDatabaseCount returns the number of non-template, connectable databases in the cluster.

func ValidateRestartPolicy added in v1.1.6 

func ValidateRestartPolicy(
	pgPool *pgxpool.Pool,
	ctx context.Context,
	parameterNames []string,
	knobApp agent.KnobApplication,
) (bool, error)

ValidateRestartPolicy queries which of the supplied parameter names would require a PostgreSQL restart and enforces the agent's apply policy:

  • if at least one requires a restart but agent.IsRestartAllowed is false, a *agent.RestartNotAllowedError is returned;
  • if at least one requires a restart but KnobApplication=reload, the apply is refused with a plain error to prevent partial application.

The boolean result reports whether any of the parameters require a restart (used by callers to decide whether to perform one). On a policy violation the boolean is still true so the caller can log accurately if it wishes.

func WaitPostgresReady 

func WaitPostgresReady(pgPool *pgxpool.Pool, ctx context.Context) error

Types

type CollectorsConfig added in v1.1.0 

type CollectorsConfig struct {
	PgStatStatements    collectorconfig.TypedEntry[queries.PgStatStatementsConfig]
	PgClass             collectorconfig.TypedEntry[queries.PgClassConfig]
	PgStats             collectorconfig.TypedEntry[queries.PgStatsConfig]
	PgStatUserTables    collectorconfig.TypedEntry[queries.PgStatUserTablesConfig]
	PgStatUserIndexes   collectorconfig.TypedEntry[queries.PgStatUserIndexesConfig]
	PgStatioUserIndexes collectorconfig.TypedEntry[queries.PgStatioUserIndexesConfig]

	// Simple holds config for collectors that only use BaseConfig.
	Simple map[string]collectorconfig.BaseConfig
}

CollectorsConfig holds the parsed, typed configuration for every collector.

func CollectorsConfigFromViper added in v1.1.0 

func CollectorsConfigFromViper() (CollectorsConfig, error)

CollectorsConfigFromViper reads the collectors YAML section, overlays environment variables with pattern DBT_COLLECTOR_{NAME}_{FIELD}, validates, and returns the config.

type Config 

type Config struct {
	ConnectionURL     string `mapstructure:"connection_url" validate:"required"`
	ServiceName       string `mapstructure:"service_name"`        // TODO(eddie): Should be moved under pgprem, as it doesn't apply to all other PG providers
	RestartScriptPath string `mapstructure:"restart_script_path"` // When set, restarts execute this script directly (no shell) instead of `systemctl restart`. Must be an executable path with no arguments. Takes precedence over ServiceName.
	AllowRestart      bool   `mapstructure:"allow_restart"`
}

func ConfigFromViper 

func ConfigFromViper(key *string) (Config, error)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.