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

Update README.md

Browse Source 
Improve the documentation for `--disable-default-metrics` and update the listing of current flags.
This commit is contained in:
Will Rouesnel 2018-03-21 00:41:58 +11:00 committed by GitHub
parent f00c4b7b87
commit 36e13ca8a5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -47,6 +47,24 @@ Package vendoring is handled with [`govendor`](https://github.com/kardianos/gove
* `web.telemetry-path` * `web.telemetry-path`
Path under which to expose metrics. Path under which to expose metrics.
* `disable-default-metrics`
Use only metrics supplied from `queries.yaml` via `--extend.query-path`
* `extend.query-path`
Path to a YAML file containing custom queries to run. Check out [`queries.yaml`](queries.yaml)
for examples of the format.
* `dumpmaps`
Do not run - print the internal representation of the metric maps. Useful when debugging a custom
queries file.
* `log.level`
Set logging level: one of `debug`, `info`, `warn`, `error`, `fatal`
* `log.format`
Set the log output target and format. e.g. `logger:syslog?appname=bob&local=7` or `logger:stdout?json=true`
Defaults to `logger:stderr`.
### Environment Variables ### Environment Variables
The following environment variables configure the exporter: The following environment variables configure the exporter:
@ -102,11 +120,11 @@ rich self-documenting metrics for the exporter.
The -extend.query-path command-line argument specifies a YAML file containing additional queries to run. The -extend.query-path command-line argument specifies a YAML file containing additional queries to run.
Some examples are provided in [queries.yaml](queries.yaml). Some examples are provided in [queries.yaml](queries.yaml).
### Working with non-officially-supported postgres versions ### Disabling default metrics
To work with non-officially-supported postgres versions you can try disabling (e.g. 8.2.15)
If you want to use this exporter to monitor a postgres installation that is not officially supported (e.g. 8.2.15) or a variant of postgres (e.g. Greenplum). or a variant of postgres (e.g. Greenplum) you can disable the default metrics with the `--disable-default-metrics`
You may try to disable all internal metrics using the -disable-default-metrics command-line argument, then supply your own set of metrics definitions in flag. This removes all built-in metrics, and uses only metrics defined by queries in the `queries.yaml` file you supply
an external config file. (so you must supply one, otherwise the exporter will return nothing but internal statuses and not your database).
### Running as non-superuser ### Running as non-superuser
@ -142,3 +160,5 @@ GRANT SELECT ON postgres_exporter.pg_stat_replication TO postgres_exporter;
* To build a copy for your current architecture run `go run mage.go binary` or just `go run mage.go` * To build a copy for your current architecture run `go run mage.go binary` or just `go run mage.go`
This will create a symlink to the just built binary in the root directory. This will create a symlink to the just built binary in the root directory.
* To build release tar balls run `go run mage.go release`. * To build release tar balls run `go run mage.go release`.
* Build system is a bit temperamental at the moment since the conversion to mage - I am working on getting it
to be a perfect out of the box experience, but am time-constrained on it at the moment.