args

Documentation

Overview

Package args contains the argument list, defined as a struct, along with a method that validates passed-in args

Index

• type ArgumentList
  • func (al ArgumentList) Validate() error

Types

type ArgumentList

type ArgumentList struct {
	sdkArgs.DefaultArgumentList
	Username                     string `default:"" help:"The username for the PostgreSQL database"`
	Password                     string `default:"" help:"The password for the specified username"`
	Hostname                     string `default:"localhost" help:"The PostgreSQL hostname to connect to"`
	Database                     string `default:"postgres" help:"The PostgreSQL database name to connect to"`
	Port                         string `default:"5432" help:"The port to connect to the PostgreSQL database"`
	CollectionList               string `` /* 254-byte string literal not displayed */
	CollectionIgnoreDatabaseList string `default:"[]" help:"A JSON array that list databases that will be excluded from collection. Nothing is excluded by default."`
	CollectionIgnoreTableList    string `default:"[]" help:"A JSON array that list tables that will be excluded from collection. Nothing is excluded by default."`
	SSLRootCertLocation          string `default:"" help:"Absolute path to PEM encoded root certificate file"`
	SSLCertLocation              string `default:"" help:"Absolute path to PEM encoded client cert file"`
	SSLKeyLocation               string `default:"" help:"Absolute path to PEM encoded client key file"`
	Timeout                      string `default:"10" help:"Maximum wait for connection, in seconds. Set 0 for no timeout"`
	CustomMetricsQuery           string `` /* 165-byte string literal not displayed */
	CustomMetricsConfig          string `default:"" help:"YAML configuration with one or more custom SQL queries to collect"`
	EnableSSL                    bool   `default:"false" help:"If true will use SSL encryption, false will not use encryption"`
	TrustServerCertificate       bool   `` /* 141-byte string literal not displayed */
	Pgbouncer                    bool   `default:"false" help:"Collects metrics from PgBouncer instance. Assumes connection is through PgBouncer."`
	CollectDbLockMetrics         bool   `` //nolint: stylecheck
	/* 155-byte string literal not displayed */
	CollectBloatMetrics                  bool `default:"true" help:"Enable collecting bloat metrics which can be performance intensive"`
	ShowVersion                          bool `default:"false" help:"Print build information and exit"`
	EnableQueryMonitoring                bool `default:"false" help:"Enable collection of detailed query performance metrics."`
	QueryMonitoringResponseTimeThreshold int  `` /* 181-byte string literal not displayed */
	QueryMonitoringCountThreshold        int  `default:"20" help:"The number of records for each query performance metrics"`
}

ArgumentList struct that holds all PostgreSQL arguments

func (ArgumentList) Validate

func (al ArgumentList) Validate() error

Validate validates PostgreSQl arguments