Skip to content

Add info about PG_* env vars to README #199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 16, 2018
Merged

Add info about PG_* env vars to README #199

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e06d914
Add info about PG_* env vars to README
samuelb Jun 20, 2018
3036b90
Merge branch 'master' into master
samuelb Jul 9, 2018
8f07687
Merge branch 'master' into master
wrouesnel Jul 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ Package vendoring is handled with [`govendor`](https://github.com/kardianos/gove
### Flags

* `web.listen-address`
Address to listen on for web interface and telemetry.
Address to listen on for web interface and telemetry. Default is `:9187`.

* `web.telemetry-path`
Path under which to expose metrics.
Path under which to expose metrics. Default is `/metrics`.

* `disable-default-metrics`
Use only metrics supplied from `queries.yaml` via `--extend.query-path`
Expand Down Expand Up @@ -88,6 +88,21 @@ The following environment variables configure the exporter:
the password to connect with.
* `DATA_SOURCE_PASS_FILE`
The same as above but reads the password from a file.

* `PG_EXPORTER_WEB_LISTEN_ADDRESS`
Address to listen on for web interface and telemetry. Default is `:9187`.

* `PG_EXPORTER_WEB_TELEMETRY_PATH`
Path under which to expose metrics. Default is `/metrics`.

* `PG_EXPORTER_DISABLE_DEFAULT_METRICS`
Use only metrics supplied from `queries.yaml`. Value can be `true` or `false`. Default is `false`.

* `PG_EXPORTER_EXTEND_QUERY_PATH`
Path to a YAML file containing custom queries to run. Check out [`queries.yaml`](queries.yaml)
for examples of the format.

Settings set by environment variables starting with `PG_` will be overwritten by the corresponding CLI flag if given.

### Setting the Postgres server's data source name

Expand Down