Merge branch 'master' into master

Author: tmc

.gitignore

@@ -14,3 +14,7 @@
 /release
 /*.prom
 /.metrics.*.*.prom
+/.metrics.*.*.prom.unique
+/.assets-branch
+/.metrics.*.added
+/.metrics.*.removed

.travis.yml

@@ -3,7 +3,7 @@ services:
 - docker
 language: go
 go:
-- '1.10'
+- '1.11'
 before_install:
 - go get -v github.com/mattn/goveralls
 - sudo wget -O /usr/local/bin/p2 https://github.com/wrouesnel/p2cli/releases/download/r4/p2
@@ -12,6 +12,7 @@ before_install:
   && sudo chmod +x /usr/local/bin/docker-compose
 - sudo apt-get update && sudo apt-get install postgresql-client-common
 script:
+- "./gh-assets-clone.sh"
 - go run mage.go -v all
 - "$HOME/gopath/bin/goveralls -coverprofile=cover.out -service=travis-ci"
 - go run mage.go docker
@@ -21,10 +22,17 @@ after_success:
   ; docker push wrouesnel/postgres_exporter:$TRAVIS_TAG ; fi
 - if [ "$TRAVIS_BRANCH" == "master" ]; then docker push wrouesnel/postgres_exporter
   ; fi
+- "./postgres-metrics-get-changes.sh .assets-branch/metriclists"
+- if [ "$TRAVIS_BRANCH" == "master" ]; then ./gh-metrics-push.sh ; fi
 env:
   global:
   - DOCKER_USER=wrouesnel
-  - secure: f0H5HKL/5f/ZZVGZ7puegWZ6eig0TmruihuSEJCx1+Y6yDZn7l8lH+eETP9KAzH27c3CG1F9ytu/3gnnTOafXnDLlCve3fL5sKF3+pNQRwi3IojsODjdfPW+KEbG+1RD7IgkCn+DSRmvvpLr4zGOmZFEM1ZtLL878u4Hsrv/X5pDbKJgG/cXDRJfsu/EcpviO4WM8zOakBY8QihXhGpZiRtpRDCXWjW49PdCkW9hsfzFaU1yjvih9EJ0cfcH+9CFCRkezwAPlCETbOv288uHXc6bCuEEX1bgJ0ZzEXYAyoO00+12ePbQZEGNikSVT55nfC+jZLLTavQkFi862Hcx/lmJpA/7aeNYOrDcomwWMRRc4Ava2+cod7acVvo45SHRq+Jj9ofDhj9s0T/aZwV+2doc9GwDN9J6aEs9Nham2G955K1H0fmMW9lv0ThSVEZ3XbzCHyR4nPAwJQXrzauqbbihCim/g/YC5gbVs7O/4GkN2Z9LK30IJr1/NtJdIa6fMk3Zdhp6LGbXCvVFRbE0rMiTLbB8O3ll2smCu3aFYv7J9IfvI0ol0ww7kULpyf/vqxkK0NJXsKgoK/Uo1lM9gNpJBHsMt9nWnDvLj2DKZNTqkxzJeG8O98ADrQWEGFhpcsSsbW9pAMsrp6D4LQikN8KoFvh9F8h9lBsYpafzlOA=
+  - GIT_ASSETS_BRANCH=assets
+  - secure: sl1d85bipYhHlHTZ4fwkWrZ07px+lPMQrKPaiyQ9i5tylQAcMqwDroK0pb5HIyIl6PEx72D5atQWnEqluA/0rFt3SxqxtvT+wj6CPmmZfh2fUSol7I07QzAsi95d7q0fg2mStDdfs134Uu+JjxGKEGRu2SL3Zq+LKpaNPtIZVBqrCYYAySLiEJx+DEOfwt1ktn/qHapV5d5FYdfd7trfV411NITyA8AGk6Gy0HztRDGbfcoLOsM+CnVi1p59uUL9ck/hL2DbsB44qDKeWQaruMLwWNDETu+EVwHlDEHGBPb+wdDALnW+Ts3CAUpuGXftHV35XLLbH7NXOnS6QiH938ycfPf3INY51lV7cL6bNtFWDKMAIcPf4wQO2ts4qFhuiUeFdo7qrC6uEI5Fy/sELBgWl4O2opVY3Tf8s8OO/DSb4Cxy6solKgaETkl6EcShaEj7H/Cn7vT0+SLKCpSQlvVQXDLGg6eZTyBA+OWNElE0UvWV7znxWBlke+9NARIl4FcB/SY4A6v1ztpandHWMjNLLxZyVxFEswfU9hvf0qL9SW38OJ5cIK8pvmH2QWG7Xg/j0B3o7SHMdsM+pcSwrzsM6OENgvxPNBb/DinmMyQKxTCVcVmMo7uIS89RIylvN79E8U6NagdFkiLfa3xEHq8zCzEkHi3bsLRvytgT2X0=
+  - secure: 1JL8KcgkLueQ2DLL81UMYzIHX3qm1TjcO40QL2ZOfdirFWBshOiTwTXeWj5qZaGBzoVV5ezhyZaBY+t3/pObslm20ERce879hEw+TSnKN30wfBqNyv2r7rfsbKkXauultb8RNu9y/9XS0DCEyGdSTQh9UaCa4z6ulu39hffDddrGQjwW1P2gT3Npu1cDYd1iSO36rrA6yXjaoN8OW8U4znKVjOGnarxxFnXJkiYv2PfIrZA6BpL3d0syJtWDyr1G+B48oK9VK+fBV9K0G0E67fJvqB3ANXN3D41il3S+cs8Ulcd7hF+LWxpMsP2r1/XHYSDw3Iiz0QFKKzoyxNdipvdjAVDxrWylyLnmTBYzXk41kRv88mKVLBQM1dbzsLXYcsE2pgIZxxq9OHGZ5CUJ8t0oz5D9oXMUy4QOMQ36jZdvD048aB7DGp4EF2J7ILIhUZrHHErOlXotnsYvNMvamNwqB5Jg4NC+y5QHxERJ+HK5oPrLy+iCb2kmWatSB6vO5OeX/F7IRiqtZghJRddEeMdQ1a6H0GeV1BF7Hx8j3TPMJ66qSAb0RA1lQQCN4l+/YMEWmQD8amf1O5NY116waf+Co4qkvt3c4QctQOMwu3Ra7uLlp6GG61OmHhPTCGSv/LZp6CVtROLY5IltKv7qBzksjvXkO1SzhJOxi0JkZmg=
+branches:
+  except:
+  - assets
 deploy:
   skip_cleanup: true
   provider: releases

Dockerfile

@@ -1,5 +1,11 @@
+FROM debian:7.11-slim
+RUN useradd -u 20001 postgres_exporter
+
 FROM scratch
 
+COPY --from=0 /etc/passwd /etc/passwd
+USER postgres_exporter
+
 ARG binary
 
 COPY $binary /postgres_exporter

Makefile

@@ -1,11 +1,13 @@
 [![Build Status](https://travis-ci.org/wrouesnel/postgres_exporter.svg?branch=master)](https://travis-ci.org/wrouesnel/postgres_exporter)
 [![Coverage Status](https://coveralls.io/repos/github/wrouesnel/postgres_exporter/badge.svg?branch=master)](https://coveralls.io/github/wrouesnel/postgres_exporter?branch=master)
 [![Go Report Card](https://goreportcard.com/badge/github.com/wrouesnel/postgres_exporter)](https://goreportcard.com/report/github.com/wrouesnel/postgres_exporter)
+[![Docker Pulls](https://img.shields.io/docker/pulls/wrouesnel/postgres_exporter.svg)](https://hub.docker.com/r/wrouesnel/postgres_exporter/tags)
 
 # PostgreSQL Server Exporter
 
 Prometheus exporter for PostgreSQL server metrics.
-Supported Postgres versions: 9.1 and up.
+
+CI Tested PostgreSQL versions: `9.4`, `9.5`, `9.6`, `10`, `11`
 
 ## Quick Start
 This package is available for Docker:
@@ -24,7 +26,7 @@ The default make file behavior is to build the binary:
 ```
 $ go get github.com/wrouesnel/postgres_exporter
 $ cd ${GOPATH-$HOME/go}/src/github.com/wrouesnel/postgres_exporter
-$ go run mage.go
+$ go run mage.go binary
 $ export DATA_SOURCE_NAME="postgresql://login:password@hostname:port/dbname"
 $ ./postgres_exporter <flags>
 ```
@@ -48,16 +50,19 @@ Package vendoring is handled with [`govendor`](https://github.com/kardianos/gove
   Path under which to expose metrics. Default is `/metrics`.
 
 * `disable-default-metrics`
-  Use only metrics supplied from `queries.yaml` via `--extend.query-path`
+  Use only metrics supplied from `queries.yaml` via `--extend.query-path`.
+
+* `disable-settings-metrics`
+  Use the flag if you don't want to scrape `pg_settings`.
 
 * `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`
 
@@ -77,21 +82,23 @@ The following environment variables configure the exporter:
   URI may contain the username and password to connect with.
 
 * `DATA_SOURCE_URI`
-   an alternative to DATA_SOURCE_NAME which exclusively accepts the raw URI
+   an alternative to `DATA_SOURCE_NAME` which exclusively accepts the raw URI
    without a username and password component.
 
 * `DATA_SOURCE_USER`
   When using `DATA_SOURCE_URI`, this environment variable is used to specify
   the username.
+
 * `DATA_SOURCE_USER_FILE`
   The same, but reads the username from a file.
 
 * `DATA_SOURCE_PASS`
   When using `DATA_SOURCE_URI`, this environment variable is used to specify
   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`.
 
@@ -101,13 +108,16 @@ The following environment variables configure the exporter:
 * `PG_EXPORTER_DISABLE_DEFAULT_METRICS`
   Use only metrics supplied from `queries.yaml`. Value can be `true` or `false`. Default is `false`.
 
+* `PG_EXPORTER_DISABLE_SETTINGS_METRICS`
+  Use the flag if you don't want to scrape `pg_settings`. Value can be `true` or `false`. Defauls 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.
 
-* `PG_EXPORTER_CONTANT_LABELS`
+* `PG_EXPORTER_CONSTANT_LABELS`
   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.
 
 ### Setting the Postgres server's data source name
@@ -119,6 +129,10 @@ For running it locally on a default Debian/Ubuntu install, this will work (trans
 
     sudo -u postgres DATA_SOURCE_NAME="user=postgres host=/var/run/postgresql/ sslmode=disable" postgres_exporter
 
+Also, you can set a list of sources to scrape different instances from the one exporter setup. Just define a comma separated string.
+
+    sudo -u postgres DATA_SOURCE_NAME="port=5432,port=6432" postgres_exporter
+
 See the [github.com/lib/pq](http://github.com/lib/pq) module for other ways to format the connection string.
 
 ### Adding new metrics
@@ -142,31 +156,78 @@ The -extend.query-path command-line argument specifies a YAML file containing ad
 Some examples are provided in [queries.yaml](queries.yaml).
 
 ### Disabling default metrics
-To work with non-officially-supported postgres versions you can try disabling (e.g. 8.2.15) 
+To work with non-officially-supported postgres versions you can try disabling (e.g. 8.2.15)
 or a variant of postgres (e.g. Greenplum) you can disable the default metrics with the `--disable-default-metrics`
 flag. This removes all built-in metrics, and uses only metrics defined by queries in the `queries.yaml` file you supply
 (so you must supply one, otherwise the exporter will return nothing but internal statuses and not your database).
 
+### Automatically discover databases
+To scrape metrics from all databases on a database server, the database DSN's can be dynamically discovered via the 
+`--auto-discover-databases` flag. When true, `SELECT datname FROM pg_database` is run for all configured DSN's. From the 
+result a new set of DSN's is created for which the metrics are scraped.
+
 ### 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 functions and 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. Functions need to be created to share this
+data with the non-superuser. Only creating the views will leave out the most
+important bits of data.
 
 ```sql
-CREATE USER postgres_exporter PASSWORD 'password';
+-- To use IF statements, hence to be able to check if the user exists before
+-- attempting creation, we need to switch to procedural SQL (PL/pgSQL)
+-- instead of standard SQL.
+-- More: https://www.postgresql.org/docs/9.3/plpgsql-overview.html
+-- To preserve compatibility with <9.0, DO blocks are not used; instead,
+-- a function is created and dropped.
+CREATE OR REPLACE FUNCTION __tmp_create_user() returns void as $$
+BEGIN
+  IF NOT EXISTS (
+          SELECT                       -- SELECT list can stay empty for this
+          FROM   pg_catalog.pg_user
+          WHERE  usename = 'postgres_exporter') THEN
+    CREATE USER postgres_exporter;
+  END IF;
+END;
+$$ language plpgsql;
+
+SELECT __tmp_create_user();
+DROP FUNCTION __tmp_create_user();
+
+ALTER USER postgres_exporter WITH PASSWORD 'password';
 ALTER USER postgres_exporter SET SEARCH_PATH TO postgres_exporter,pg_catalog;
 
--- If deploying as non-superuser (for example in AWS RDS)
--- GRANT postgres_exporter TO :MASTER_USER;
-CREATE SCHEMA postgres_exporter AUTHORIZATION postgres_exporter;
+-- If deploying as non-superuser (for example in AWS RDS), uncomment the GRANT
+-- line below and replace <MASTER_USER> with your root user.
+-- GRANT postgres_exporter TO <MASTER_USER>;
+CREATE SCHEMA IF NOT EXISTS postgres_exporter;
+GRANT USAGE ON SCHEMA postgres_exporter TO postgres_exporter;
+
+CREATE OR REPLACE FUNCTION get_pg_stat_activity() RETURNS SETOF pg_stat_activity AS
+$$ SELECT * FROM pg_catalog.pg_stat_activity; $$
+LANGUAGE sql
+VOLATILE
+SECURITY DEFINER;
 
-CREATE VIEW postgres_exporter.pg_stat_activity
+CREATE OR REPLACE VIEW postgres_exporter.pg_stat_activity
 AS
-  SELECT * from pg_catalog.pg_stat_activity;
+  SELECT * from get_pg_stat_activity();
 
 GRANT SELECT ON postgres_exporter.pg_stat_activity TO postgres_exporter;
 
-CREATE VIEW postgres_exporter.pg_stat_replication AS
-  SELECT * from pg_catalog.pg_stat_replication;
+CREATE OR REPLACE FUNCTION get_pg_stat_replication() RETURNS SETOF pg_stat_replication AS
+$$ SELECT * FROM pg_catalog.pg_stat_replication; $$
+LANGUAGE sql
+VOLATILE
+SECURITY DEFINER;
+
+CREATE OR REPLACE VIEW postgres_exporter.pg_stat_replication
+AS
+  SELECT * FROM get_pg_stat_replication();
 
 GRANT SELECT ON postgres_exporter.pg_stat_replication TO postgres_exporter;
 ```