mirror of
https://github.com/1f349/dendrite.git
synced 2024-11-09 22:42:58 +00:00
Update FAQ
This commit is contained in:
parent
bcff14adea
commit
583b8ea273
@ -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!
|
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
|
```json
|
||||||
{
|
{
|
||||||
@ -106,7 +109,7 @@ If anonymous stats reporting is enabled, the following data is send to the defin
|
|||||||
"go_arch": "amd64",
|
"go_arch": "amd64",
|
||||||
"go_os": "linux",
|
"go_os": "linux",
|
||||||
"go_version": "go1.16.13",
|
"go_version": "go1.16.13",
|
||||||
"homeserver": "localhost:8800",
|
"homeserver": "my.domain.com",
|
||||||
"log_level": "trace",
|
"log_level": "trace",
|
||||||
"memory_rss": 93452,
|
"memory_rss": 93452,
|
||||||
"monolith": true,
|
"monolith": true,
|
||||||
|
@ -73,7 +73,7 @@ type Global struct {
|
|||||||
// ServerNotices configuration used for sending server notices
|
// ServerNotices configuration used for sending server notices
|
||||||
ServerNotices ServerNotices `yaml:"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"`
|
ReportStats ReportStats `yaml:"report_stats"`
|
||||||
|
|
||||||
// Configuration for the caches.
|
// Configuration for the caches.
|
||||||
@ -189,9 +189,9 @@ func (c *Cache) Verify(errors *ConfigErrors, isMonolith bool) {
|
|||||||
checkPositive(errors, "max_size_estimated", int64(c.EstimatedMaxSize))
|
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 {
|
type ReportStats struct {
|
||||||
// Enabled configures anonymous usage stats of the server
|
// Enabled configures phone-home statistics of the server
|
||||||
Enabled bool `yaml:"enabled"`
|
Enabled bool `yaml:"enabled"`
|
||||||
|
|
||||||
// Endpoint the endpoint to report stats to
|
// Endpoint the endpoint to report stats to
|
||||||
|
@ -139,7 +139,7 @@ func (p *phoneHomeStats) collect() {
|
|||||||
|
|
||||||
output := bytes.Buffer{}
|
output := bytes.Buffer{}
|
||||||
if err = json.NewEncoder(&output).Encode(p.stats); err != nil {
|
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
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -147,14 +147,14 @@ func (p *phoneHomeStats) collect() {
|
|||||||
|
|
||||||
request, err := http.NewRequestWithContext(ctx, http.MethodPost, p.cfg.Global.ReportStats.Endpoint, &output)
|
request, err := http.NewRequestWithContext(ctx, http.MethodPost, p.cfg.Global.ReportStats.Endpoint, &output)
|
||||||
if err != nil {
|
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
|
return
|
||||||
}
|
}
|
||||||
request.Header.Set("User-Agent", "Dendrite/"+internal.VersionString())
|
request.Header.Set("User-Agent", "Dendrite/"+internal.VersionString())
|
||||||
|
|
||||||
_, err = p.client.Do(request)
|
_, err = p.client.Do(request)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
logrus.WithError(err).Error("unable to send anonymous stats")
|
logrus.WithError(err).Error("Unable to send phone-home statistics")
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user