matrix-docker-ansible-deploy/docs/configuring-playbook-telemetry.md
Aki Salminen 5733f4d157
Update configuring-playbook-telemetry.md
Change anonymized to more proper term as server vice this is not anonymized. Server name is the first parameter that is collected. And if server happens to be for individual use these statistics would be at personal level without any anonymising.
2020-09-07 17:14:34 +03:00

1.6 KiB

Enabling Telemetry for your Matrix server (optional)

By default, this playbook configures your Matrix homeserver to not send any telemetry data anywhere.

The matrix.org team would really appreciate it if you could help the project out by reporting anonymized usage statistics from your homeserver. Only very basic aggregate data (e.g. number of users) will be reported, but it helps track the growth of the Matrix community, and helps to make Matrix a success.

Enabling Telemetry

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):

matrix_synapse_report_stats: true

Usage statistics being submitted

If statistics reporting is enabled, the information that gets submitted to the matrix.org team according to the source code is:

  • your homeserver's domain name

  • uptime of the homeserver program

  • Python version powering your homeserver

  • total number of users on your home server (including bridged users)

  • total number of native Matrix users on your home server

  • total number of rooms on your homeserver

  • total number of daily active users on your homeserver

  • total number of daily active rooms on your homeserver

  • total number of messages sent per day

  • cache setting information

  • CPU and memory statistics for the homeserver program

  • database engine type and version