Skip to content

Commit fa35715

Browse files
authored
Add section about error monitoring to the README (#1699)
1 parent 2341015 commit fa35715

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Official bootstrap for running your own [Sentry](https://sentry.io/) with [Docke
1414

1515
### Installation
1616

17-
To get started with all the defaults, simply clone the repo and run `./install.sh` in your local check-out. Sentry uses Python 3 by default since December 4th, 2020 and Sentry 21.1.0 is the last version to support Python 2.
17+
To get started with all the defaults, simply clone the repo and run `./install.sh` in your local check-out. Please also read the section below about monitoring. Sentry uses Python 3 by default since December 4th, 2020 and Sentry 21.1.0 is the last version to support Python 2.
1818

1919
During the install, a prompt will ask if you want to create a user account. If you require that the install not be blocked by the prompt, run `./install.sh --skip-user-prompt`.
2020

@@ -65,3 +65,18 @@ sudo SENTRY_IMAGE=us.gcr.io/sentryio/sentry:83b1380 ./install.sh
6565
```
6666

6767
Where you replace `83b1380` with the sha you want to use.
68+
69+
### Self-Hosted Monitoring
70+
71+
We'd love to catch errors in self-hosted so you don't run into them, and so we can fix them faster! When you run `./install.sh`, you will be prompted to select whether to opt in or out of our monitoring. If you opt into our monitoring, we will send information to our own self-hosted Sentry instance for development and debugging purposes. We may collect:
72+
73+
- OS username
74+
- IP address
75+
- install log
76+
- runtime errors in Sentry
77+
- performance data
78+
79+
Thirty (30) day retention. No marketing. Privacy policy at sentry.io/privacy.
80+
81+
Starting with the 22.10.0 release in October, we will require those running the Sentry installer to choose to opt in or out. If you are running the installer under automation, you may want to set `REPORT_SELF_HOSTED_ISSUES` or pass `--(no-)report-self-hosted-issues` to the installer accordingly.
82+

0 commit comments

Comments
 (0)