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 the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:

```yaml
matrix_synapse_report_stats: true # for synapse

matrix_dendrite_report_stats: true # for dendrite
```


## Usage statistics being submitted

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 users, the total number of rooms, and the number of messages sent per day on your homeserver.

See [Synapse's documentation](https://github.com/element-hq/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 13:23:42 +08:00			`# Enabling Telemetry for your Matrix server (optional)`
Add documentation about Telemetry configuration 2018-11-02 00:21:38 +08:00
			`By default, this playbook configures your Matrix homeserver to not send any telemetry data anywhere.`

Edit line breaks in sentences and paragraphs Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> 2024-10-19 01:32:11 +08:00			`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.`
Add documentation about Telemetry configuration 2018-11-02 00:21:38 +08:00
Add details about the telemetry data that gets sent (if enabled) 2018-11-02 00:40:45 +08:00
			`## Enabling Telemetry`

Replace DOMAIN with example.com Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> 2024-10-17 21:17:56 +08:00			If you'd like to help by enabling submission of general usage statistics for your homeserver, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
Add documentation about Telemetry configuration 2018-11-02 00:21:38 +08:00
			```yaml
Replace (almost) all matrix-org/synapse references with element-hq/synapse Issues and Pull Requests were not migrated to the new organization/repository, so `matrix-org/synapse/pull` and `matrix-org/synapse/issues` references were kept as-is. `matrix-org/synapse-s3-storage-provider` references were also kept, as that module still continues living under the `matrix-org` organization. This patch mainly aims to change documentation-related things, not actual usage in full yet. For polish that, another more comprehensive patch is coming later. 2024-01-17 13:58:01 +08:00			`matrix_synapse_report_stats: true # for synapse`
Update configuring-playbook-telemetry.md 2022-11-23 00:30:19 +08:00
Replace (almost) all matrix-org/synapse references with element-hq/synapse Issues and Pull Requests were not migrated to the new organization/repository, so `matrix-org/synapse/pull` and `matrix-org/synapse/issues` references were kept as-is. `matrix-org/synapse-s3-storage-provider` references were also kept, as that module still continues living under the `matrix-org` organization. This patch mainly aims to change documentation-related things, not actual usage in full yet. For polish that, another more comprehensive patch is coming later. 2024-01-17 13:58:01 +08:00			`matrix_dendrite_report_stats: true # for dendrite`
Add documentation about Telemetry configuration 2018-11-02 00:21:38 +08:00			```
Add details about the telemetry data that gets sent (if enabled) 2018-11-02 00:40:45 +08:00

			`## Usage statistics being submitted`

Edit line breaks in sentences and paragraphs Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> 2024-10-19 01:32:11 +08:00			`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 users, the total number of rooms, and the number of messages sent per day on your homeserver.`
Explicitly mention that your homeserver's domain is included in telemetry 2022-07-20 00:42:53 +08:00
Edit line breaks in sentences and paragraphs Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> 2024-10-19 01:32:11 +08:00			`See [Synapse's documentation](https://github.com/element-hq/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.`