-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
docs(self-hosted): Restructure experimental section into 'Production Enhancements' and 'Optional Features' #15376
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
9974050
b97bc4e
3ce9350
09e1506
6dfd9a3
b3b13d2
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| title: Self-Hosted Optional Features | ||
| sidebar_title: Optional Features | ||
| sidebar_order: 60 | ||
| --- | ||
|
|
||
| <PageGrid /> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| title: Self-Hosted Production Enhancements | ||
| sidebar_title: Production Enhancements | ||
| sidebar_order: 50 | ||
| --- | ||
|
|
||
| In order to make your self-hosted Sentry installation more production-ready, we provide some additional guides to help you optimize your Sentry instance. | ||
|
|
||
| <PageGrid /> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,10 @@ | ||
| --- | ||
| title: Self-Hosted Monitoring | ||
| sidebar_title: Monitoring | ||
| sidebar_order: 10 | ||
| sidebar_order: 2 | ||
| --- | ||
|
|
||
| <Alert title="Important" level="warning"> | ||
| These are community-contributed docs. Sentry does not officially provide support for self-hosted configurations beyond the default install. | ||
| </Alert> | ||
|
|
||
| This page is considered experimental because everyone will have different setup and requirements for their monitoring system. It is also best to use your existing monitoring system, and try to integrate Sentry with it, instead of spinning up a new one. | ||
| Everyone will have different setup and requirements for their monitoring system, it is best to use your existing monitoring system, and try to integrate Sentry with it, instead of spinning up a new one. | ||
|
|
||
| Most containers have a `statsd` client that you can point to your monitoring system. If you have a native `statsd` server instance, you can directly use it. If you don't, you might want to add some kind of converter that converts the ingested `statsd` format into your own. For example, if you are using Prometheus, you can use [prometheus-statsd-exporter](https://github.com/prometheus/statsd_exporter) to bridge the gap. | ||
|
|
||
|
|
@@ -19,7 +15,7 @@ We recommend [the original `statsd` server made by Etsy](https://github.com/stat | |
| Sentry does not provide any alerts if your host instance is low on resources such as free memory or disk space. You will need to configure this own your own relative to your needs. It is critical for you to monitor the disk space as once it gets full, it will be much harder to recover from there. | ||
|
|
||
| <Alert title="Note"> | ||
| After changing configuration files, don't forget to restart the containers with `docker compose restart`. See the <Link to="/self-hosted/#configuration">configuration section</Link> for more information. | ||
| After changing configuration files, re-run the <code>./install.sh</code> script, to rebuild and restart the containers. See the <Link to="/self-hosted/#configuration">configuration section</Link> for more information. | ||
| </Alert> | ||
|
|
||
| ## Sentry-related configurations | ||
|
|
@@ -88,6 +84,8 @@ metrics: | |
| # periodic_secs: 5 | ||
| ``` | ||
|
|
||
| Defined metric keys are specified on [statsd.rs file](https://github.com/getsentry/relay/blob/master/relay-server/src/statsd.rs). | ||
|
|
||
| ### Symbolicator | ||
|
|
||
| You can configure Symbolicator to send metrics to Statsd server by configuring your `symbolicator/config.yml` file: | ||
|
|
@@ -99,6 +97,32 @@ metrics: | |
| prefix: "sentry.symbolicator" # Adjust this to your needs, default is "symbolicator" | ||
| ``` | ||
|
|
||
| ### Uptime Checker | ||
|
|
||
| You can configure Uptime Checker to send metrics to Statsd server by configuring your `docker-compose.yml` file: | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. They should be using the override file instead of the main one, right?
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Or lets add these to env to pass on the already existing env variables for these and people can set them in their .env files
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yeah it should be override
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'd actually go with the second option: add these to pass in already set env variables and just document these. |
||
|
|
||
| ```yaml | ||
| services: | ||
| # Other services | ||
| uptime-checker: | ||
| # ... | ||
| environment: | ||
| UPTIME_CHECKER_STATSD_ADDR: "100.100.123.123:8125" # It's recommended to use IP address instead of domain name | ||
| ``` | ||
|
|
||
| ### Taskbroker | ||
|
|
||
| You can configure Taskbroker to send metrics to Statsd server by configuring your `docker-compose.yml` file: | ||
|
|
||
| ```yaml | ||
| services: | ||
| # Other services | ||
| taskbroker: | ||
| # ... | ||
| environment: | ||
| TASKBROKER_STATSD_ADDR: "100.100.123.123:8125" # It's recommended to use IP address instead of domain name | ||
| ``` | ||
|
|
||
| ## Sentry dependencies | ||
|
|
||
| We don't provide configurations for Sentry's dependencies such as PostgreSQL, Kafka, Redis, Memcached and ClickHouse that are bundled with the Docker Compose file. You will need to provide monitoring configuration for those service yourself adjusted to your needs. | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think mentioning the new Seaweed system and the default S3 enabled backend is important here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But.... we'll have objectstore soon.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not so soon. Even then, useing seaweed for all things storage on self-hosted would be good.