matrix-docker-ansible-deploy/docs/configuring-playbook-telemetry.md

# 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](https://matrix.org) team would really appreciate it if you could help the project out by reporting
usage statistics from your homeserver. Enabling usage statistics 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`):

```yaml
matrix_synapse_report_stats: true # for synapse 

matrix_dendrite_report_stats: true # for dendrite 
```


## Usage statistics being submitted

When enabled, your homeserver e 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
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) 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.
Annotate certain features as optional/advanced We've had some people get confused into installing Matrix Corporal and having pain with that. With this documentation change, we try to make it clearer that it's an advanced feature not to be touched unless you know what you're doing. On a similar note, we also make sure other things are properly labeled as "(optional)" and/or "(advanced)". 2018-11-26 05:23:42 +00:00			`# Enabling Telemetry for your Matrix server (optional)`
Add documentation about Telemetry configuration 2018-11-01 16:21:38 +00:00
			`By default, this playbook configures your Matrix homeserver to not send any telemetry data anywhere.`

			`The [matrix.org](https://matrix.org) team would really appreciate it if you could help the project out by reporting`
Update telemetry documentation to more closely match upstream Synapse no longer describes the stats as anonymized since the `server_name` is included. https://github.com/matrix-org/synapse/pull/13321 2022-07-19 14:58:19 +00:00			`usage statistics from your homeserver. Enabling usage statistics helps track the`
Add documentation about Telemetry configuration 2018-11-01 16:21:38 +00:00			`growth of the Matrix community, and helps to make Matrix a success.`

Add details about the telemetry data that gets sent (if enabled) 2018-11-01 16:40:45 +00:00
			`## Enabling Telemetry`

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 14:14:34 +00:00			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`):
Add documentation about Telemetry configuration 2018-11-01 16:21:38 +00:00
			```yaml
Update configuring-playbook-telemetry.md 2022-11-22 16:30:19 +00:00			`matrix_synapse_report_stats: true # for synapse`

			`matrix_dendrite_report_stats: true # for dendrite`
Add documentation about Telemetry configuration 2018-11-01 16:21:38 +00:00			```
Add details about the telemetry data that gets sent (if enabled) 2018-11-01 16:40:45 +00:00

			`## Usage statistics being submitted`

Update configuring-playbook-telemetry.md 2022-11-22 16:32:03 +00:00			`When enabled, your homeserver e will regularly upload a few dozen statistics about your server.`
Explicitly mention that your homeserver's domain is included in telemetry 2022-07-19 16:42:53 +00:00			`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.`

Update configuring-playbook-telemetry.md 2022-11-22 16:32:03 +00:00			`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)`
Explicitly mention that your homeserver's domain is included in telemetry 2022-07-19 16:42:53 +00:00			`for the full list of statistics that are reported.`