From 020c66a2c15f93ec44fde14c092f0ae10498d694 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Thu, 25 Jul 2024 20:30:41 +0300 Subject: [PATCH] Announce synapse-usage-exporter support Related to https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3442 --- CHANGELOG.md | 9 +++++++++ docs/configuring-playbook-prometheus-grafana.md | 1 + docs/configuring-playbook-synapse.md | 4 +++- docs/configuring-playbook.md | 2 ++ 4 files changed, 15 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3304d3a93..859c046d1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,12 @@ +# 2024-07-25 + +## synapse-usage-exporter support + +Thanks to [Michael Hollister](https://github.com/Michael-Hollister) from [FUTO](https://www.futo.org/), the creators of the [Circles app](https://circu.li/), the playbook can now set up [synapse-usage-exporter](https://github.com/loelkes/synapse-usage-exporter) - a small [Flask](https://flask.palletsprojects.com)-based webservice which can capture usage statistics from Synapse (via HTTP `PUT`) and then make them available for Prometheus to scrape. + +To learn more see our [Enabling synapse-usage-exporter for Synapse usage statistics](docs/configuring-playbook-synapse-usage-exporter.md) documentation page. + + # 2024-07-06 ## matrix-alertmanager-receiver support diff --git a/docs/configuring-playbook-prometheus-grafana.md b/docs/configuring-playbook-prometheus-grafana.md index 131b1752e..2bcb1d8e1 100644 --- a/docs/configuring-playbook-prometheus-grafana.md +++ b/docs/configuring-playbook-prometheus-grafana.md @@ -121,6 +121,7 @@ scrape_configs: ## More information +- [Enabling synapse-usage-exporter for Synapse usage statistics](configuring-playbook-synapse-usage-exporter.md) - [Understanding Synapse Performance Issues Through Grafana Graphs](https://element-hq.github.io/synapse/latest/usage/administration/understanding_synapse_through_grafana_graphs.html) at the Synapse Github Wiki - [The Prometheus scraping rules](https://github.com/element-hq/synapse/tree/master/contrib/prometheus) (we use v2) - [The Synapse Grafana dashboard](https://github.com/element-hq/synapse/tree/master/contrib/grafana) diff --git a/docs/configuring-playbook-synapse.md b/docs/configuring-playbook-synapse.md index e99a56e7f..b165b1a14 100644 --- a/docs/configuring-playbook-synapse.md +++ b/docs/configuring-playbook-synapse.md @@ -161,4 +161,6 @@ Due to this, it's recommended to only store and maintain template files in your This playbook allows you to enable Synapse metrics, which can provide insight into the performance and activity of Synapse. -To enable Synapse metrics see [`configuring-playbook-prometheus-grafana.md`](./configuring-playbook-prometheus-grafana.md) +To enable Synapse runtime metrics see: [Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server](configuring-playbook-prometheus-grafana.md) + +To enable Synapse usage metrics, see: [Enabling synapse-usage-exporter for Synapse usage statistics](configuring-playbook-synapse-usage-exporter.md) diff --git a/docs/configuring-playbook.md b/docs/configuring-playbook.md index 64c47fbe6..e1ed4eb42 100644 --- a/docs/configuring-playbook.md +++ b/docs/configuring-playbook.md @@ -42,6 +42,8 @@ When you're done with all the configuration you'd like to do, continue with [Ins - [Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server](configuring-playbook-prometheus-grafana.md) (optional) +- [Enabling synapse-usage-exporter for Synapse usage statistics](configuring-playbook-synapse-usage-exporter.md) (optional) + ### Core service adjustments - Homeserver configuration: