@@ -34,7 +34,7 @@ Improved Documentation | |||||
- Add an explanation of the `--report-stats` argument to the docs. ([\#13029](https://github.com/matrix-org/synapse/issues/13029)) | - Add an explanation of the `--report-stats` argument to the docs. ([\#13029](https://github.com/matrix-org/synapse/issues/13029)) | ||||
- Add a helpful example bash script to the contrib directory for creating multiple worker configuration files of the same type. Contributed by @villepeh. ([\#13032](https://github.com/matrix-org/synapse/issues/13032)) | - Add a helpful example bash script to the contrib directory for creating multiple worker configuration files of the same type. Contributed by @villepeh. ([\#13032](https://github.com/matrix-org/synapse/issues/13032)) | ||||
- Add missing links to config options. ([\#13166](https://github.com/matrix-org/synapse/issues/13166)) | - Add missing links to config options. ([\#13166](https://github.com/matrix-org/synapse/issues/13166)) | ||||
- Add documentation for anonymised homeserver statistics collection. ([\#13086](https://github.com/matrix-org/synapse/issues/13086)) | |||||
- Add documentation for homeserver usage statistics collection. ([\#13086](https://github.com/matrix-org/synapse/issues/13086)) | |||||
- Add documentation for the existing `databases` option in the homeserver configuration manual. ([\#13212](https://github.com/matrix-org/synapse/issues/13212)) | - Add documentation for the existing `databases` option in the homeserver configuration manual. ([\#13212](https://github.com/matrix-org/synapse/issues/13212)) | ||||
- Clean up references to sample configuration and redirect users to the configuration manual instead. ([\#13077](https://github.com/matrix-org/synapse/issues/13077), [\#13139](https://github.com/matrix-org/synapse/issues/13139)) | - Clean up references to sample configuration and redirect users to the configuration manual instead. ([\#13077](https://github.com/matrix-org/synapse/issues/13077), [\#13139](https://github.com/matrix-org/synapse/issues/13139)) | ||||
- Document how the Synapse team does reviews. ([\#13132](https://github.com/matrix-org/synapse/issues/13132)) | - Document how the Synapse team does reviews. ([\#13132](https://github.com/matrix-org/synapse/issues/13132)) | ||||
@@ -0,0 +1 @@ | |||||
Clarify that homeserver server names are included in the reported data when the `report_stats` config option is enabled. |
@@ -1,3 +1,10 @@ | |||||
matrix-synapse-py3 (1.63.0~rc1+nmu1) UNRELEASED; urgency=medium | |||||
* Clarify that homeserver server names are included in the data reported | |||||
by opt-in server stats reporting (`report_stats` homeserver config option). | |||||
-- Synapse Packaging team <packages@matrix.org> Tue, 19 Jul 2022 12:00:14 +0100 | |||||
matrix-synapse-py3 (1.63.0~rc1) stable; urgency=medium | matrix-synapse-py3 (1.63.0~rc1) stable; urgency=medium | ||||
* New Synapse release 1.63.0rc1. | * New Synapse release 1.63.0rc1. | ||||
@@ -31,7 +31,7 @@ EOF | |||||
# This file is autogenerated, and will be recreated on upgrade if it is deleted. | # This file is autogenerated, and will be recreated on upgrade if it is deleted. | ||||
# Any changes you make will be preserved. | # Any changes you make will be preserved. | ||||
# Whether to report anonymized homeserver usage statistics. | |||||
# Whether to report homeserver usage statistics. | |||||
report_stats: false | report_stats: false | ||||
EOF | EOF | ||||
fi | fi | ||||
@@ -37,7 +37,7 @@ msgstr "" | |||||
#. Type: boolean | #. Type: boolean | ||||
#. Description | #. Description | ||||
#: ../templates:2001 | #: ../templates:2001 | ||||
msgid "Report anonymous statistics?" | |||||
msgid "Report homeserver usage statistics?" | |||||
msgstr "" | msgstr "" | ||||
#. Type: boolean | #. Type: boolean | ||||
@@ -45,11 +45,11 @@ msgstr "" | |||||
#: ../templates:2001 | #: ../templates:2001 | ||||
msgid "" | msgid "" | ||||
"Developers of Matrix and Synapse really appreciate helping the project out " | "Developers of Matrix and Synapse really appreciate helping the project out " | ||||
"by reporting anonymized usage statistics from this 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 in making Matrix a " | |||||
"success, as well as to convince other networks that they should peer with " | |||||
"Matrix." | |||||
"by reporting homeserver usage statistics from this homeserver. Your " | |||||
"homeserver's server name, along with very basic aggregate data (e.g. " | |||||
"number of users) will be reported. But it helps track the growth of the " | |||||
"Matrix community, and helps in making Matrix a success, as well as to " | |||||
"convince other networks that they should peer with Matrix." | |||||
msgstr "" | msgstr "" | ||||
#. Type: boolean | #. Type: boolean | ||||
@@ -10,12 +10,13 @@ _Description: Name of the server: | |||||
Template: matrix-synapse/report-stats | Template: matrix-synapse/report-stats | ||||
Type: boolean | Type: boolean | ||||
Default: false | Default: false | ||||
_Description: Report anonymous statistics? | |||||
_Description: Report homeserver usage statistics? | |||||
Developers of Matrix and Synapse really appreciate helping the | Developers of Matrix and Synapse really appreciate helping the | ||||
project out by reporting anonymized usage statistics from this | |||||
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 in making Matrix a success, as well as to | |||||
convince other networks that they should peer with Matrix. | |||||
project out by reporting homeserver usage statistics from this | |||||
homeserver. Your homeserver's server name, along with very basic | |||||
aggregate data (e.g. number of users) will be reported. But it | |||||
helps track the growth of the Matrix community, and helps in | |||||
making Matrix a success, as well as to convince other networks | |||||
that they should peer with Matrix. | |||||
. | . | ||||
Thank you. | Thank you. |
@@ -69,7 +69,7 @@ | |||||
- [Federation](usage/administration/admin_api/federation.md) | - [Federation](usage/administration/admin_api/federation.md) | ||||
- [Manhole](manhole.md) | - [Manhole](manhole.md) | ||||
- [Monitoring](metrics-howto.md) | - [Monitoring](metrics-howto.md) | ||||
- [Reporting Anonymised Statistics](usage/administration/monitoring/reporting_anonymised_statistics.md) | |||||
- [Reporting Homeserver Usage Statistics](usage/administration/monitoring/reporting_homeserver_usage_statistics.md) | |||||
- [Understanding Synapse Through Grafana Graphs](usage/administration/understanding_synapse_through_grafana_graphs.md) | - [Understanding Synapse Through Grafana Graphs](usage/administration/understanding_synapse_through_grafana_graphs.md) | ||||
- [Useful SQL for Admins](usage/administration/useful_sql_for_admins.md) | - [Useful SQL for Admins](usage/administration/useful_sql_for_admins.md) | ||||
- [Database Maintenance Tools](usage/administration/database_maintenance_tools.md) | - [Database Maintenance Tools](usage/administration/database_maintenance_tools.md) | ||||
@@ -1,11 +1,11 @@ | |||||
# Reporting Anonymised Statistics | |||||
# Reporting Homeserver Usage Statistics | |||||
When generating your Synapse configuration file, you are asked whether you | When generating your Synapse configuration file, you are asked whether you | ||||
would like to report anonymised statistics to Matrix.org. These statistics | |||||
would like to report usage statistics to Matrix.org. These statistics | |||||
provide the foundation a glimpse into the number of Synapse homeservers | provide the foundation a glimpse into the number of Synapse homeservers | ||||
participating in the network, as well as statistics such as the number of | participating in the network, as well as statistics such as the number of | ||||
rooms being created and messages being sent. This feature is sometimes | rooms being created and messages being sent. This feature is sometimes | ||||
affectionately called "phone-home" stats. Reporting | |||||
affectionately called "phone home" stats. Reporting | |||||
[is optional](../../configuration/config_documentation.md#report_stats) | [is optional](../../configuration/config_documentation.md#report_stats) | ||||
and the reporting endpoint | and the reporting endpoint | ||||
[can be configured](../../configuration/config_documentation.md#report_stats_endpoint), | [can be configured](../../configuration/config_documentation.md#report_stats_endpoint), | ||||
@@ -21,9 +21,9 @@ The following statistics are sent to the configured reporting endpoint: | |||||
| Statistic Name | Type | Description | | | Statistic Name | Type | Description | | ||||
|----------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | |----------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||||
| `homeserver` | string | The homeserver's server name. | | |||||
| `memory_rss` | int | The memory usage of the process (in kilobytes on Unix-based systems, bytes on MacOS). | | | `memory_rss` | int | The memory usage of the process (in kilobytes on Unix-based systems, bytes on MacOS). | | ||||
| `cpu_average` | int | CPU time in % of a single core (not % of all cores). | | | `cpu_average` | int | CPU time in % of a single core (not % of all cores). | | ||||
| `homeserver` | string | The homeserver's server name. | | |||||
| `server_context` | string | An arbitrary string used to group statistics from a set of homeservers. | | | `server_context` | string | An arbitrary string used to group statistics from a set of homeservers. | | ||||
| `timestamp` | int | The current time, represented as the number of seconds since the epoch. | | | `timestamp` | int | The current time, represented as the number of seconds since the epoch. | | ||||
| `uptime_seconds` | int | The number of seconds since the homeserver was last started. | | | `uptime_seconds` | int | The number of seconds since the homeserver was last started. | |
@@ -2409,9 +2409,14 @@ metrics_flags: | |||||
--- | --- | ||||
### `report_stats` | ### `report_stats` | ||||
Whether or not to report anonymized homeserver usage statistics. This is originally | |||||
Whether or not to report homeserver usage statistics. This is originally | |||||
set when generating the config. Set this option to true or false to change the current | set when generating the config. Set this option to true or false to change the current | ||||
behavior. | |||||
behavior. See | |||||
[Reporting Homeserver Usage Statistics](../administration/monitoring/reporting_homeserver_usage_statistics.md) | |||||
for information on what data is reported. | |||||
Statistics will be reported 5 minutes after Synapse starts, and then every 3 hours | |||||
after that. | |||||
Example configuration: | Example configuration: | ||||
```yaml | ```yaml | ||||
@@ -2420,7 +2425,7 @@ report_stats: true | |||||
--- | --- | ||||
### `report_stats_endpoint` | ### `report_stats_endpoint` | ||||
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 | ||||
Example configuration: | Example configuration: | ||||
@@ -33,7 +33,7 @@ def main() -> None: | |||||
parser.add_argument( | parser.add_argument( | ||||
"--report-stats", | "--report-stats", | ||||
action="store", | action="store", | ||||
help="Whether the generated config reports anonymized usage statistics", | |||||
help="Whether the generated config reports homeserver usage statistics", | |||||
choices=["yes", "no"], | choices=["yes", "no"], | ||||
) | ) | ||||
@@ -97,16 +97,16 @@ def format_config_error(e: ConfigError) -> Iterator[str]: | |||||
# We split these messages out to allow packages to override with package | # We split these messages out to allow packages to override with package | ||||
# specific instructions. | # specific instructions. | ||||
MISSING_REPORT_STATS_CONFIG_INSTRUCTIONS = """\ | MISSING_REPORT_STATS_CONFIG_INSTRUCTIONS = """\ | ||||
Please opt in or out of reporting anonymized homeserver usage statistics, by | |||||
setting the `report_stats` key in your config file to either True or False. | |||||
Please opt in or out of reporting homeserver usage statistics, by setting | |||||
the `report_stats` key in your config file to either True or False. | |||||
""" | """ | ||||
MISSING_REPORT_STATS_SPIEL = """\ | MISSING_REPORT_STATS_SPIEL = """\ | ||||
We would really appreciate it if you could help our project out by reporting | We would really appreciate it if you could help our 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 us to track the | |||||
growth of the Matrix community, and helps us to make Matrix a success, as well | |||||
as to convince other networks that they should peer with us. | |||||
homeserver usage statistics from your homeserver. Your homeserver's server name, | |||||
along with very basic aggregate data (e.g. number of users) will be reported. But | |||||
it helps us to track the growth of the Matrix community, and helps us to make Matrix | |||||
a success, as well as to convince other networks that they should peer with us. | |||||
Thank you. | Thank you. | ||||
""" | """ | ||||
@@ -621,7 +621,7 @@ class RootConfig: | |||||
generate_group.add_argument( | generate_group.add_argument( | ||||
"--report-stats", | "--report-stats", | ||||
action="store", | action="store", | ||||
help="Whether the generated config reports anonymized usage statistics.", | |||||
help="Whether the generated config reports homeserver usage statistics.", | |||||
choices=["yes", "no"], | choices=["yes", "no"], | ||||
) | ) | ||||
generate_group.add_argument( | generate_group.add_argument( | ||||