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
anonymized usage statistics from your homeserver. Only very [basic aggregate
data](#usage-statistics-being-submitted) (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 anonymized 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
```


## Usage statistics being submitted

If statistics reporting is enabled, the information that gets submitted to the matrix.org team [according to the source code](https://github.com/matrix-org/synapse/blob/master/synapse/app/homeserver.py) is:

- your homeserver's domain name

- uptime of the homeserver program

- [Python](https://www.python.org/) 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
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`
Add details about the telemetry data that gets sent (if enabled) 2018-11-01 16:40:45 +00:00			`anonymized usage statistics from your homeserver. Only very [basic aggregate`
			`data](#usage-statistics-being-submitted) (e.g. number of users) will be reported, but it 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`

fixed a small path typo in playbook telemetry docs 2019-03-01 06:48:45 +00:00			If you'd like to help by enabling submission of anonymized 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
			`matrix_synapse_report_stats: true`
			```
Add details about the telemetry data that gets sent (if enabled) 2018-11-01 16:40:45 +00:00

			`## Usage statistics being submitted`

			`If statistics reporting is enabled, the information that gets submitted to the matrix.org team [according to the source code](https://github.com/matrix-org/synapse/blob/master/synapse/app/homeserver.py) is:`

			`- your homeserver's domain name`

			`- uptime of the homeserver program`

			`- [Python](https://www.python.org/) 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`

fixed a small path typo in playbook telemetry docs 2019-03-01 06:48:45 +00:00			`- CPU and memory statistics for the homeserver program`
Update Synapse (0.99.1.1 -> 0.99.2) 2019-03-02 07:37:35 +00:00
			`- database engine type and version`