Skip to content

Commit

Permalink
Add configuration docs to Postgresql input plugin (#2515)
Browse files Browse the repository at this point in the history
* Add configuration docs to Postgresql input plugin

Add configuration docs to PostgreSQL input plugin README (mostly from the source code) though I've not included the configuration example that seems to use all he connections on the database[1].

[1] #2410

* Fix typo in readme and sampleConfig string.
  • Loading branch information
ddryden authored and sparrc committed Mar 9, 2017
1 parent 0686112 commit 8ca01a5
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
22 changes: 22 additions & 0 deletions plugins/inputs/postgresql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,25 @@ _* value ignored and therefore not recorded._


More information about the meaning of these metrics can be found in the [PostgreSQL Documentation](http://www.postgresql.org/docs/9.2/static/monitoring-stats.html#PG-STAT-DATABASE-VIEW)

## Configruation
Specify address via a url matching:

`postgres://[pqgotest[:password]]@localhost[/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"]`

### Configuration example
```
[[inputs.postgresql]]
address = "postgres://telegraf@localhost/someDB"
ignored_databases = ["template0", "template1"]
```
2 changes: 1 addition & 1 deletion plugins/inputs/postgresql/postgresql.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ var sampleConfig = `
# 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 'ignore_databases' option.
## databases are gathered. Do NOT use with the 'ignored_databases' option.
# databases = ["app_production", "testing"]
`

Expand Down

0 comments on commit 8ca01a5

Please sign in to comment.