README
¶
PostgreSQL Input Plugin
This postgresql plugin provides metrics for your postgres database. It currently works with postgres versions 8.1+. It uses data from the built in pg_stat_database and pg_stat_bgwriter views. The metrics recorded depend on your version of postgres. See table:
pg version 9.2+ 9.1 8.3-9.0 8.1-8.2 7.4-8.0(unsupported)
--- --- --- ------- ------- -------
datid x x x x
datname x x x x
numbackends x x x x x
xact_commit x x x x x
xact_rollback x x x x x
blks_read x x x x x
blks_hit x x x x x
tup_returned x x x
tup_fetched x x x
tup_inserted x x x
tup_updated x x x
tup_deleted x x x
conflicts x x
temp_files x
temp_bytes x
deadlocks x
blk_read_time x
blk_write_time x
stats_reset* x x
* value ignored and therefore not recorded.
More information about the meaning of these metrics can be found in the PostgreSQL Documentation
Configuration
Specify address via a postgresql connection string:
host=localhost port=5432 user=telegraf database=telegraf
Or via an url matching:
postgres://[pqgotest[:password]]@host:port[/dbname]?sslmode=[disable|verify-ca|verify-full]
All connection parameters are optional. Without the dbname parameter, the driver will default to a database with the same name as the user. This dbname is just for instantiating a connection with the server and doesn't restrict the databases we are trying to grab metrics for.
A list of databases to explicitly ignore. If not specified, metrics for all databases are gathered. Do NOT use with the 'databases' option.
ignored_databases = ["postgres", "template0", "template1"]
A list of databases to pull metrics about. If not specified, metrics for all databases are gathered. Do NOT use with the 'ignored_databases' option.
databases = ["app_production", "testing"]
TLS Configuration
Add the sslkey, sslcert and sslrootcert options to your DSN:
host=localhost user=pgotest dbname=app_production sslmode=require sslkey=/etc/telegraf/key.pem sslcert=/etc/telegraf/cert.pem sslrootcert=/etc/telegraf/ca.pem
Configuration example
[[inputs.postgresql]]
## specify address via a url matching:
## postgres://[pqgotest[:password]]@localhost[/dbname]?sslmode=[disable|verify-ca|verify-full]
## or a simple string:
## host=localhost user=pqgotest password=... sslmode=... dbname=app_production
##
## All connection parameters are optional.
##
## Without the dbname parameter, the driver will default to a database
## with the same name as the user. This dbname is just for instantiating a
## connection with the server and doesn't restrict the databases we are trying
## to grab metrics for.
##
address = "host=localhost user=postgres sslmode=disable"
## A custom name for the database that will be used as the "server" tag in the
## measurement output. If not specified, a default one generated from
## the connection address is used.
# outputaddress = "db01"
## connection configuration.
## maxlifetime - specify the maximum lifetime of a connection.
## default is forever (0s)
# max_lifetime = "0s"
## A list of databases to explicitly ignore. If not specified, metrics for all
## databases are gathered. Do NOT use with the 'databases' option.
# ignored_databases = ["postgres", "template0", "template1"]
## A list of databases to pull metrics about. If not specified, metrics for all
## databases are gathered. Do NOT use with the 'ignored_databases' option.
# databases = ["app_production", "testing"]
## Whether to use prepared statements when connecting to the database.
## This should be set to false when connecting through a PgBouncer instance
## with pool_mode set to transaction.
prepared_statements = true
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Postgresql ¶
type Postgresql struct {
Service
Databases []string `toml:"databases"`
IgnoredDatabases []string `toml:"ignored_databases"`
PreparedStatements bool `toml:"prepared_statements"`
}
func (*Postgresql) Description ¶
func (p *Postgresql) Description() string
func (*Postgresql) Gather ¶
func (p *Postgresql) Gather(acc telegraf.Accumulator) error
func (*Postgresql) IgnoredColumns ¶
func (p *Postgresql) IgnoredColumns() map[string]bool
func (*Postgresql) Init ¶ added in v1.22.0
func (p *Postgresql) Init() error
func (*Postgresql) SampleConfig ¶
func (p *Postgresql) SampleConfig() string
type Service ¶ added in v1.14.0
type Service struct {
Address string
OutputAddress string
MaxIdle int
MaxOpen int
MaxLifetime config.Duration
DB *sql.DB
IsPgBouncer bool `toml:"-"`
}
Service common functionality shared between the postgresql and postgresql_extensible packages.
func (*Service) SanitizedAddress ¶ added in v1.14.0
SanitizedAddress utility function to strip sensitive information from the connection string.
Source Files