matrix-docker-ansible-deploy/docs/configuring-playbook-prometheus-postgres.md
Suguru Hirahara bf5373479b
Use common expression on documentation regarding playbook configuration
Overall the playbook uses the expression "Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file:" with the heading "Adjusting the playbook configuration" for sections to explain what to be added as variables

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-12 20:59:15 +09:00

1.8 KiB

Enabling metrics and graphs for Postgres (optional)

Expanding on the metrics exposed by the synapse exporter and the node exporter, the playbook enables the postgres exporter that exposes more detailed information about what's happening on your postgres database.

Adjusting the playbook configuration

To enable the postgres exporter, add the following configuration to your inventory/host_vars/matrix.DOMAIN/vars.yml file:

prometheus_postgres_exporter_enabled: true

What does it do?

Name Description
prometheus_postgres_exporter_enabled Enable the postgres prometheus exporter. This sets up the docker container, connects it to the database and adds a 'job' to the prometheus config which tells prometheus about this new exporter. The default is 'false'
prometheus_postgres_exporter_database_username The 'username' for the user that the exporter uses to connect to the database. The default is 'matrix_prometheus_postgres_exporter'
prometheus_postgres_exporter_database_password The 'password' for the user that the exporter uses to connect to the database. By default, this is auto-generated by the playbook
prometheus_postgres_exporter_container_labels_traefik_enabled If set to true, exposes the Postgres exporter metrics on https://matrix.DOMAIN/metrics/postgres-exporter for usage with an external Prometheus server. To password-protect the metrics, see matrix_metrics_exposure_http_basic_auth_users on that other documentation page.

More information