Skip to content
This repository has been archived by the owner on Aug 14, 2024. It is now read-only.

feat(self-hosted): Add docs for self-hosted errors only #1336

Merged
merged 7 commits into from
Jul 22, 2024
Merged

feat(self-hosted): Add docs for self-hosted errors only #1336

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4657640
add docs for self-hosted errors only
hubertdeng123 Jul 18, 2024
9904a21
update doc
hubertdeng123 Jul 18, 2024
7f9c3a5
add newline
hubertdeng123 Jul 18, 2024
dc65e9c
make docs less markety
hubertdeng123 Jul 18, 2024
2915131
mention minimizing resource usage for errors only
hubertdeng123 Jul 18, 2024
12a9fc0
make self hosted sentry bigger heading
hubertdeng123 Jul 18, 2024
b07d693
update wording
hubertdeng123 Jul 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions src/docs/self-hosted/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,37 @@ By default Sentry sends anonymous usage statistics to the Sentry team. It helps

You can disable this feature by adding `SENTRY_BEACON = False` into `sentry.conf.py` file.

## Errors-only Self-hosted Sentry

**Disclaimer: This is an experimental beta feature. This means that features and workflows are not completely tested, so use at your own risk!**

Starting from 24.8.0+, users will have the ability to choose between two distinct types of self-hosted Sentry deployments.

**Errors Only**

Errors Only self-hosted offers a small subset of features with an emphasis on minimizing system resources. This lightweight option includes only the following features:
1. Issues
2. Alerts
3. Integrations
4. Dashboards
5. Releases
6. Discover

In order to enable errors only self-hosted, you'll need to update your [.env file](https://github.com/getsentry/self-hosted/blob/master/.env) to include `COMPOSE_PROFILES=errors-only`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This applies to existing install too, right? Will it apply in reverse (that is, if I insert this flag then take it off, will that cause issues?)? If not, we should be very clear about that.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, applies for existing installs. If you insert this flag and use errors-only self-hosted and want to switch back to feature complete sentry there shouldn't be issues.


**Feature Complete**

This is our default version of self-hosted Sentry. It includes most of the features that are available on our SaaS product. This includes everything offered in the Errors Only version, plus the following:
1. Traces
2. Profiles
3. Replays
4. Insights (Requests, Queries, Assets, etc)
5. User Feedback
6. Performance
7. Crons

This version of Sentry is enabled by default upon installation. Ensure that your [.env file](https://github.com/getsentry/self-hosted/blob/master/.env) includes `COMPOSE_PROFILES=feature-complete`.

## Configuration

You very likely will want to adjust the default configuration for your Sentry installation as well. These facilities are available for that purpose:
Expand Down
Loading