bc1849d7ff
* Replace "just run-tags install-all/setup-all,start" with "just install-all/setup-all" Thanks to the tip by Slavi that the overhead of ensure-matrix-users-created is negligible. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Edit installing instructions - Move the anchor links to docs/just.md - Add note about running "ensure-matrix-users-created" tags, if ansible-playbook's tags not "setup-all,ensure-matrix-users-created,start", ie. either "setup-all,start", "setup-email2matrix,start", "setup-aux-files,setup-corporal,start", or "setup-matrix-user-verification-service,start" Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update descriptions about installation - Introduce the most conservative and stable raw ansible-playbook command. - Introduce the just commands on installing.md and maintenance-upgrading-services.md, not on quick-start.md, since it is too early for quick start guide readers who are just starting to climb learning curve to use the shortcuts. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-playbook-etherpad.md: remove the note about ensure-matrix-users-created Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> --------- Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2.6 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.example.com/vars.yml file:
prometheus_postgres_exporter_enabled: true
Installing
After configuring the playbook, run it with playbook tags as below:
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
The shortcut commands with the just program are also available: just install-all or just setup-all
just install-all is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your vars.yml to remove other components, you'd need to run just setup-all, or these components will still remain installed. Note these shortcuts run the ensure-matrix-users-created tag too.
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.example.com/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
- The PostgresSQL dashboard (generic postgres dashboard)