From 1ce56f8b594156386cf4e17cb0ac73da40c8af3e Mon Sep 17 00:00:00 2001 From: Harshit Bansal Date: Wed, 11 Mar 2020 00:32:50 +0530 Subject: [PATCH] Document port specification in postgres input plugins (#7132) --- etc/telegraf.conf | 18 +++++++++--------- plugins/inputs/pgbouncer/README.md | 6 +++--- plugins/inputs/postgresql/README.md | 6 +++--- plugins/inputs/postgresql_extensible/README.md | 8 ++++---- 4 files changed, 19 insertions(+), 19 deletions(-) diff --git a/etc/telegraf.conf b/etc/telegraf.conf index dfa9a974e..a13162b52 100644 --- a/etc/telegraf.conf +++ b/etc/telegraf.conf @@ -3772,7 +3772,7 @@ # # timeout = "5ms" -# # A plugin to collect stats from Opensmtpd - a validating, recursive, and caching DNS resolver +# # A plugin to collect stats from Opensmtpd - a validating, recursive, and caching DNS resolver # [[inputs.opensmtpd]] # ## If running as a restricted user you can prepend sudo for additional access: # #use_sudo = false @@ -5592,10 +5592,10 @@ # # Read metrics from one or many pgbouncer servers # [[inputs.pgbouncer]] # ## specify address via a url matching: -# ## postgres://[pqgotest[:password]]@localhost[/dbname]\ +# ## postgres://[pqgotest[:password]]@host:port[/dbname]\ # ## ?sslmode=[disable|verify-ca|verify-full] # ## or a simple string: -# ## host=localhost user=pqotest password=... sslmode=... dbname=app_production +# ## host=localhost port=5432 user=pqotest password=... sslmode=... dbname=app_production # ## # ## All connection parameters are optional. # ## @@ -5605,10 +5605,10 @@ # # Read metrics from one or many postgresql servers # [[inputs.postgresql]] # ## specify address via a url matching: -# ## postgres://[pqgotest[:password]]@localhost[/dbname]\ +# ## postgres://[pqgotest[:password]]@host:port[/dbname]\ # ## ?sslmode=[disable|verify-ca|verify-full] # ## or a simple string: -# ## host=localhost user=pqotest password=... sslmode=... dbname=app_production +# ## host=localhost port=5432 user=pqotest password=... sslmode=... dbname=app_production # ## # ## All connection parameters are optional. # ## @@ -5617,7 +5617,7 @@ # ## connection with the server and doesn't restrict the databases we are trying # ## to grab metrics for. # ## -# address = "host=localhost user=postgres sslmode=disable" +# address = "host=localhost port=5432 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. @@ -5640,10 +5640,10 @@ # # Read metrics from one or many postgresql servers # [[inputs.postgresql_extensible]] # ## specify address via a url matching: -# ## postgres://[pqgotest[:password]]@localhost[/dbname]\ +# ## postgres://[pqgotest[:password]]@host:port[/dbname]\ # ## ?sslmode=[disable|verify-ca|verify-full] # ## or a simple string: -# ## host=localhost user=pqotest password=... sslmode=... dbname=app_production +# ## host=localhost port=5432 user=pqotest password=... sslmode=... dbname=app_production # # # ## All connection parameters are optional. # # ## Without the dbname parameter, the driver will default to a database @@ -5651,7 +5651,7 @@ # ## connection with the server and doesn't restrict the databases we are trying # ## to grab metrics for. # # -# address = "host=localhost user=postgres sslmode=disable" +# address = "host=localhost port=5432 user=postgres sslmode=disable" # # ## connection configuration. # ## maxlifetime - specify the maximum lifetime of a connection. diff --git a/plugins/inputs/pgbouncer/README.md b/plugins/inputs/pgbouncer/README.md index 58e3352c3..987b6a382 100644 --- a/plugins/inputs/pgbouncer/README.md +++ b/plugins/inputs/pgbouncer/README.md @@ -12,10 +12,10 @@ More information about the meaning of these metrics can be found in the ```toml [[inputs.pgbouncer]] ## specify address via a url matching: - ## postgres://[pqgotest[:password]]@localhost[/dbname]\ + ## postgres://[pqgotest[:password]]@host:port[/dbname]\ ## ?sslmode=[disable|verify-ca|verify-full] ## or a simple string: - ## host=localhost user=pqotest password=... sslmode=... dbname=app_production + ## host=localhost port=5432 user=pqotest password=... sslmode=... dbname=app_production ## ## All connection parameters are optional. ## @@ -30,7 +30,7 @@ Specify address via a postgresql connection string: Or via an url matching: - `postgres://[pqgotest[:password]]@localhost[/dbname]?sslmode=[disable|verify-ca|verify-full]` + `postgres://[pqgotest[:password]]@host:port[/dbname]?sslmode=[disable|verify-ca|verify-full]` All connection parameters are optional. diff --git a/plugins/inputs/postgresql/README.md b/plugins/inputs/postgresql/README.md index 21f9097aa..2ebc33ad6 100644 --- a/plugins/inputs/postgresql/README.md +++ b/plugins/inputs/postgresql/README.md @@ -33,11 +33,11 @@ More information about the meaning of these metrics can be found in the [Postgre ## Configuration Specify address via a postgresql connection string: - `host=/run/postgresql user=telegraf database=telegraf` - + `host=localhost port=5432 user=telegraf database=telegraf` + Or via an url matching: - `postgres://[pqgotest[:password]]@localhost[/dbname]?sslmode=[disable|verify-ca|verify-full]` + `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. diff --git a/plugins/inputs/postgresql_extensible/README.md b/plugins/inputs/postgresql_extensible/README.md index 4621e46b5..337b13d1b 100644 --- a/plugins/inputs/postgresql_extensible/README.md +++ b/plugins/inputs/postgresql_extensible/README.md @@ -14,11 +14,11 @@ The example below has two queries are specified, with the following parameters: ``` [[inputs.postgresql_extensible]] # specify address via a url matching: - # postgres://[pqgotest[:password]]@localhost[/dbname]?sslmode=... + # postgres://[pqgotest[:password]]@host:port[/dbname]?sslmode=... # or a simple string: - # host=localhost user=pqotest password=... sslmode=... dbname=app_production + # host=localhost port=5432 user=pqotest password=... sslmode=... dbname=app_production # - # All connection parameters are optional. + # 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 @@ -45,7 +45,7 @@ The example below has two queries are specified, with the following parameters: # the where clause (aka with the dbname) # # The script option can be used to specify the .sql file path. - # If script and sqlquery options specified at same time, sqlquery will be used + # If script and sqlquery options specified at same time, sqlquery will be used # # the tagvalue field is used to define custom tags (separated by comas). # the query is expected to return columns which match the names of the