pub-solar/matrix-docker-ansible-deploy
5
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Merge pull request #2286 from array-in-a-matrix/stats

Browse source 
Add statistics reporting for dendrite
This commit is contained in:
Slavi Pantaleev 2022-11-22 19:11:35 +02:00 committed by GitHub
parent e37db0c888 3505f62f02
commit b4eb3b466f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 12 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/configuring-playbook-telemetry.md
View file

@ -12,15 +12,17 @@ growth of the Matrix community, and helps to make Matrix a success.
If you'd like to **help by enabling submission of general usage statistics** for your homeserver, add this to your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`): If you'd like to **help by enabling submission of general usage statistics** for your homeserver, add this to your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`):
```yaml ```yaml
matrix_synapse_report_stats: true matrix_synapse_report_stats: true # for synapse
matrix_dendrite_report_stats: true # for dendrite
``` ```
## Usage statistics being submitted ## Usage statistics being submitted
When enabled, Synapse will regularly upload a few dozen statistics about your server. When enabled, your homeserver will regularly upload a few dozen statistics about your server.
This data includes your homeserver's domain, the total number of users, the number of active This data includes your homeserver's domain, the total number of users, the number of active
users, the total number of rooms, and the number of messages sent per day on your homeserver. users, the total number of rooms, and the number of messages sent per day on your homeserver.
See [Synapse's documentation](https://github.com/matrix-org/synapse/blob/develop/docs/usage/administration/monitoring/reporting_homeserver_usage_statistics.md#available-statistics) See [Synapse's documentation](https://github.com/matrix-org/synapse/blob/develop/docs/usage/administration/monitoring/reporting_homeserver_usage_statistics.md#available-statistics) or [Dendrite's documentation](https://github.com/matrix-org/dendrite/blob/main/docs/FAQ.md#what-is-being-reported-when-enabling-phone-home-statistics)
for the full list of statistics that are reported. for the full list of statistics that are reported.

4
roles/custom/matrix-dendrite/defaults/main.yml
View file

@ -196,3 +196,7 @@ matrix_dendrite_configuration_extension: "{{ matrix_dendrite_configuration_exten
matrix_dendrite_configuration: "{{ matrix_dendrite_configuration_yaml | from_yaml | combine(matrix_dendrite_configuration_extension, recursive=True) }}" matrix_dendrite_configuration: "{{ matrix_dendrite_configuration_yaml | from_yaml | combine(matrix_dendrite_configuration_extension, recursive=True) }}"
matrix_dendrite_userapi_auto_join_rooms: [] matrix_dendrite_userapi_auto_join_rooms: []
# statistics reporting configuration. These statistics contain the server
# name, number of active users and some information on your deployment config.
matrix_dendrite_report_stats: false

3
roles/custom/matrix-dendrite/templates/dendrite/dendrite.yaml.j2
View file

@ -416,3 +416,6 @@ tracing:
# stdout by Dendrite. # stdout by Dendrite.
logging: [] logging: []
# statistics reporting configuration. These statistics contain the server
# name, number of active users and some information on your deployment config.
report_stats: {{ matrix_dendrite_report_stats|to_json }}