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

Merge pull request #1954 from aaronraimist/stats

Browse source 
Update telemetry documentation to more closely match upstream
This commit is contained in:
Slavi Pantaleev 2022-07-19 18:38:29 +03:00 committed by GitHub
parent 65bfc1396e 817830bb3d
commit 2a131fd507
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -3,8 +3,7 @@
By default, this playbook configures your Matrix homeserver to not send any telemetry data anywhere. 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 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 usage statistics from your homeserver. Enabling usage statistics helps track the
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. growth of the Matrix community, and helps to make Matrix a success.
@ -19,28 +18,5 @@ matrix_synapse_report_stats: true
## Usage statistics being submitted ## 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: See [Synapse's documentation](https://github.com/matrix-org/synapse/blob/develop/docs/usage/administration/monitoring/reporting_homeserver_usage_statistics.md#available-statistics)
for a list of the individual parameters that are reported.
- 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

4
roles/matrix-synapse/templates/synapse/homeserver.yaml.j2
View file

@ -1587,11 +1587,11 @@ metrics_flags:
# #
#known_servers: true #known_servers: true
# Whether or not to report anonymized homeserver usage statistics. # Whether or not to report homeserver usage statistics.
# #
report_stats: {{ matrix_synapse_report_stats|to_json }} report_stats: {{ matrix_synapse_report_stats|to_json }}
# The endpoint to report the anonymized homeserver usage statistics to. # The endpoint to report homeserver usage statistics to.
# Defaults to https://matrix.org/report-usage-stats/push # Defaults to https://matrix.org/report-usage-stats/push
# #
#report_stats_endpoint: https://example.com/report-usage-stats/push #report_stats_endpoint: https://example.com/report-usage-stats/push