RepoMirrors/postgres_exporter
1
0
Fork 0
mirror of https://github.com/prometheus-community/postgres_exporter synced 2025-04-04 23:29:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Will Rouesnel 2018-11-11 15:45:30 +11:00
parent 474a600842
commit fec1a171ba
No known key found for this signature in database
GPG Key ID: 72DC65802A1091C5
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -5,7 +5,8 @@
# PostgreSQL Server Exporter # PostgreSQL Server Exporter
Prometheus exporter for PostgreSQL server metrics. Prometheus exporter for PostgreSQL server metrics.
Supported Postgres versions: 9.1 and up.
CI Tested PostgreSQL versions: `9.1`, `9.2`, `9.3`, `9.4`, `9.5`, `9.6`, `10`, `11`
## Quick Start ## Quick Start
This package is available for Docker: This package is available for Docker:
@ -105,7 +106,7 @@ The following environment variables configure the exporter:
Path to a YAML file containing custom queries to run. Check out [`queries.yaml`](queries.yaml) Path to a YAML file containing custom queries to run. Check out [`queries.yaml`](queries.yaml)
for examples of the format. for examples of the format.
* `PG_EXPORTER_CONTANT_LABELS` * `PG_EXPORTER_CONSTANT_LABELS`
Labels to set in all metrics. A list of `label=value` pairs, separated by commas. Labels to set in all metrics. A list of `label=value` pairs, separated by commas.
Settings set by environment variables starting with `PG_` will be overwritten by the corresponding CLI flag if given. Settings set by environment variables starting with `PG_` will be overwritten by the corresponding CLI flag if given.
@ -149,14 +150,20 @@ flag. This removes all built-in metrics, and uses only metrics defined by querie
### Running as non-superuser ### Running as non-superuser
To be able to collect metrics from pg_stat_activity and pg_stat_replication as non-superuser you have to create views as a superuser, and assign permissions separately to those. In PostgreSQL, views run with the permissions of the user that created them so they can act as security barriers. To be able to collect metrics from `pg_stat_activity` and `pg_stat_replication`
as non-superuser you have to create views as a superuser, and assign permissions
separately to those.
In PostgreSQL, views run with the permissions of the user that created them so
they can act as security barriers.
```sql ```sql
CREATE USER postgres_exporter PASSWORD 'password'; CREATE USER postgres_exporter PASSWORD 'password';
ALTER USER postgres_exporter SET SEARCH_PATH TO postgres_exporter,pg_catalog; ALTER USER postgres_exporter SET SEARCH_PATH TO postgres_exporter,pg_catalog;
-- If deploying as non-superuser (for example in AWS RDS) -- If deploying as non-superuser (for example in AWS RDS), uncomment the GRANT
-- GRANT postgres_exporter TO :MASTER_USER; -- line below and replace <MASTER_USER> with your root user.
-- GRANT postgres_exporter TO <MASTER_USER>
CREATE SCHEMA postgres_exporter AUTHORIZATION postgres_exporter; CREATE SCHEMA postgres_exporter AUTHORIZATION postgres_exporter;
CREATE VIEW postgres_exporter.pg_stat_activity CREATE VIEW postgres_exporter.pg_stat_activity