aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNeil Alexander <neilalexander@users.noreply.github.com>2022-07-19 11:51:46 +0100
committerNeil Alexander <neilalexander@users.noreply.github.com>2022-07-19 11:51:46 +0100
commit583b8ea273be82ebdf2a9f81fd51a150d910b349 (patch)
tree7b105cbfdb10466a291b07ea6a583d2cded7076f
parentbcff14adea471cbb496924622295c62c02a82720 (diff)
Update FAQ
-rw-r--r--docs/FAQ.md9
-rw-r--r--setup/config/config_global.go6
-rw-r--r--userapi/util/phonehomestats.go6
3 files changed, 12 insertions, 9 deletions
diff --git a/docs/FAQ.md b/docs/FAQ.md
index 47f39b9e..f8255684 100644
--- a/docs/FAQ.md
+++ b/docs/FAQ.md
@@ -86,9 +86,12 @@ would be a huge help too, as that will help us to understand where the memory us
You may need to revisit the connection limit of your PostgreSQL server and/or make changes to the `max_connections` lines in your Dendrite configuration. Be aware that each Dendrite component opens its own database connections and has its own connection limit, even in monolith mode!
-## What is being reported when enabling anonymous stats?
+## What is being reported when enabling phone-home statistics?
-If anonymous stats reporting is enabled, the following data is send to the defined endpoint.
+Phone-home statistics contain your server's domain name, some configuration information about
+your deployment and aggregated information about active users on your deployment. They are sent
+to the endpoint URL configured in your Dendrite configuration file only. The following is an
+example of the data that is sent:
```json
{
@@ -106,7 +109,7 @@ If anonymous stats reporting is enabled, the following data is send to the defin
"go_arch": "amd64",
"go_os": "linux",
"go_version": "go1.16.13",
- "homeserver": "localhost:8800",
+ "homeserver": "my.domain.com",
"log_level": "trace",
"memory_rss": 93452,
"monolith": true,
diff --git a/setup/config/config_global.go b/setup/config/config_global.go
index ac1380a4..10827bb2 100644
--- a/setup/config/config_global.go
+++ b/setup/config/config_global.go
@@ -73,7 +73,7 @@ type Global struct {
// ServerNotices configuration used for sending server notices
ServerNotices ServerNotices `yaml:"server_notices"`
- // ReportStats configures opt-in anonymous stats reporting.
+ // ReportStats configures opt-in phone-home statistics reporting.
ReportStats ReportStats `yaml:"report_stats"`
// Configuration for the caches.
@@ -189,9 +189,9 @@ func (c *Cache) Verify(errors *ConfigErrors, isMonolith bool) {
checkPositive(errors, "max_size_estimated", int64(c.EstimatedMaxSize))
}
-// ReportStats configures opt-in anonymous stats reporting.
+// ReportStats configures opt-in phone-home statistics reporting.
type ReportStats struct {
- // Enabled configures anonymous usage stats of the server
+ // Enabled configures phone-home statistics of the server
Enabled bool `yaml:"enabled"`
// Endpoint the endpoint to report stats to
diff --git a/userapi/util/phonehomestats.go b/userapi/util/phonehomestats.go
index ad93a50e..b17f6206 100644
--- a/userapi/util/phonehomestats.go
+++ b/userapi/util/phonehomestats.go
@@ -139,7 +139,7 @@ func (p *phoneHomeStats) collect() {
output := bytes.Buffer{}
if err = json.NewEncoder(&output).Encode(p.stats); err != nil {
- logrus.WithError(err).Error("unable to encode anonymous stats")
+ logrus.WithError(err).Error("Unable to encode phone-home statistics")
return
}
@@ -147,14 +147,14 @@ func (p *phoneHomeStats) collect() {
request, err := http.NewRequestWithContext(ctx, http.MethodPost, p.cfg.Global.ReportStats.Endpoint, &output)
if err != nil {
- logrus.WithError(err).Error("unable to create anonymous stats request")
+ logrus.WithError(err).Error("Unable to create phone-home statistics request")
return
}
request.Header.Set("User-Agent", "Dendrite/"+internal.VersionString())
_, err = p.client.Do(request)
if err != nil {
- logrus.WithError(err).Error("unable to send anonymous stats")
+ logrus.WithError(err).Error("Unable to send phone-home statistics")
return
}
}