From 4657640a19cf5021572952aaa4d1c1c9a9621aa3 Mon Sep 17 00:00:00 2001 From: Hubert Deng Date: Thu, 18 Jul 2024 13:24:35 -0700 Subject: [PATCH 1/7] add docs for self-hosted errors only --- src/docs/self-hosted/index.mdx | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/src/docs/self-hosted/index.mdx b/src/docs/self-hosted/index.mdx index 53ea60d60b..fd0ef484a5 100644 --- a/src/docs/self-hosted/index.mdx +++ b/src/docs/self-hosted/index.mdx @@ -107,6 +107,31 @@ 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 + +This feature is experimental and now in beta. Starting from 24.8.0+ onwards, users will have the option to choose between two types of self-hosted Sentry deployments. + +**Errors Only** +This is an opt in version of self-hosted Sentry that is much more lightweight than the feature complete version. This includes features around Sentry's bread and butter, issues. +1. Issues +2. Alerts +3. Integrations +4. Dashboards +5. Releases +6. Discover + +**Feature Complete** +This is the default version of self-hosted Sentry that includes many of the features that we offer on SaaS. This includes everything offered in the errors only version but also additional main features listed below! +1. Traces +2. Profiles +3. Replays +4. Insights (Requests, Queries, Assets, etc) +5. User Feedback +6. Performance +7. Crons + +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`. + ## Configuration You very likely will want to adjust the default configuration for your Sentry installation as well. These facilities are available for that purpose: From 9904a214b22343776e123cd8f6f6202921d2adb0 Mon Sep 17 00:00:00 2001 From: Hubert Deng Date: Thu, 18 Jul 2024 13:37:40 -0700 Subject: [PATCH 2/7] update doc --- src/docs/self-hosted/index.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/docs/self-hosted/index.mdx b/src/docs/self-hosted/index.mdx index fd0ef484a5..342065aa31 100644 --- a/src/docs/self-hosted/index.mdx +++ b/src/docs/self-hosted/index.mdx @@ -109,10 +109,10 @@ You can disable this feature by adding `SENTRY_BEACON = False` into `sentry.conf ### Errors-only Self-hosted Sentry -This feature is experimental and now in beta. Starting from 24.8.0+ onwards, users will have the option to choose between two types of self-hosted Sentry deployments. +This feature is experimental and now in beta. Starting from 24.8.0+ onwards, users will have the ability to choose between two distinct types of self-hosted Sentry deployments, tailored to their specific needs and preferences. -**Errors Only** -This is an opt in version of self-hosted Sentry that is much more lightweight than the feature complete version. This includes features around Sentry's bread and butter, issues. +**Errors Only**\n +Opt for a sleek and efficient version of self-hosted Sentry that focuses on what we do best—tackling issues head-on. This lightweight option includes these features: 1. Issues 2. Alerts 3. Integrations @@ -120,8 +120,8 @@ This is an opt in version of self-hosted Sentry that is much more lightweight th 5. Releases 6. Discover -**Feature Complete** -This is the default version of self-hosted Sentry that includes many of the features that we offer on SaaS. This includes everything offered in the errors only version but also additional main features listed below! +**Feature Complete**\n +This is our default version of self-hosted Sentry that is most similar feature parity wise to our SaaS product. This includes everything offered in the Errors Only version, as well as many other amazing features. 1. Traces 2. Profiles 3. Replays From 7f9c3a50c812864cf9925347241d9202a8d0380a Mon Sep 17 00:00:00 2001 From: Hubert Deng Date: Thu, 18 Jul 2024 13:42:02 -0700 Subject: [PATCH 3/7] add newline --- src/docs/self-hosted/index.mdx | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/docs/self-hosted/index.mdx b/src/docs/self-hosted/index.mdx index 342065aa31..a1bfdfbd87 100644 --- a/src/docs/self-hosted/index.mdx +++ b/src/docs/self-hosted/index.mdx @@ -111,7 +111,8 @@ You can disable this feature by adding `SENTRY_BEACON = False` into `sentry.conf This feature is experimental and now in beta. Starting from 24.8.0+ onwards, users will have the ability to choose between two distinct types of self-hosted Sentry deployments, tailored to their specific needs and preferences. -**Errors Only**\n +**Errors Only** + Opt for a sleek and efficient version of self-hosted Sentry that focuses on what we do best—tackling issues head-on. This lightweight option includes these features: 1. Issues 2. Alerts @@ -120,7 +121,8 @@ Opt for a sleek and efficient version of self-hosted Sentry that focuses on what 5. Releases 6. Discover -**Feature Complete**\n +**Feature Complete** + This is our default version of self-hosted Sentry that is most similar feature parity wise to our SaaS product. This includes everything offered in the Errors Only version, as well as many other amazing features. 1. Traces 2. Profiles From dc65e9c756cbcb4330937d035fb21312be269d2d Mon Sep 17 00:00:00 2001 From: Hubert Deng Date: Thu, 18 Jul 2024 14:01:47 -0700 Subject: [PATCH 4/7] make docs less markety --- src/docs/self-hosted/index.mdx | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/src/docs/self-hosted/index.mdx b/src/docs/self-hosted/index.mdx index a1bfdfbd87..05d08e0c11 100644 --- a/src/docs/self-hosted/index.mdx +++ b/src/docs/self-hosted/index.mdx @@ -109,11 +109,13 @@ You can disable this feature by adding `SENTRY_BEACON = False` into `sentry.conf ### Errors-only Self-hosted Sentry -This feature is experimental and now in beta. Starting from 24.8.0+ onwards, users will have the ability to choose between two distinct types of self-hosted Sentry deployments, tailored to their specific needs and preferences. +**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** -Opt for a sleek and efficient version of self-hosted Sentry that focuses on what we do best—tackling issues head-on. This lightweight option includes these features: +Errors Only self-hosted offers a small subset of features focusing on what we do best: tackling issues head-on. This lightweight option includes only the following features: 1. Issues 2. Alerts 3. Integrations @@ -121,9 +123,11 @@ Opt for a sleek and efficient version of self-hosted Sentry that focuses on what 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`. + **Feature Complete** -This is our default version of self-hosted Sentry that is most similar feature parity wise to our SaaS product. This includes everything offered in the Errors Only version, as well as many other amazing features. +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 @@ -132,7 +136,7 @@ This is our default version of self-hosted Sentry that is most similar feature p 6. Performance 7. Crons -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`. +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 From 2915131e2f4bf2a05ae3ac008b49d984ad068a57 Mon Sep 17 00:00:00 2001 From: Hubert Deng Date: Thu, 18 Jul 2024 14:07:13 -0700 Subject: [PATCH 5/7] mention minimizing resource usage for errors only --- src/docs/self-hosted/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs/self-hosted/index.mdx b/src/docs/self-hosted/index.mdx index 05d08e0c11..3c342835f7 100644 --- a/src/docs/self-hosted/index.mdx +++ b/src/docs/self-hosted/index.mdx @@ -115,7 +115,7 @@ Starting from 24.8.0+, users will have the ability to choose between two distinc **Errors Only** -Errors Only self-hosted offers a small subset of features focusing on what we do best: tackling issues head-on. This lightweight option includes only the following features: +Errors Only self-hosted offers a small subset of features with an emphasis on minimizing system resources while focusing on what we do best: tackling issues head-on. This lightweight option includes only the following features: 1. Issues 2. Alerts 3. Integrations From 12a9fc019e9aa98ed641babb276af72b9928aa7a Mon Sep 17 00:00:00 2001 From: Hubert Deng Date: Thu, 18 Jul 2024 14:11:00 -0700 Subject: [PATCH 6/7] make self hosted sentry bigger heading --- src/docs/self-hosted/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs/self-hosted/index.mdx b/src/docs/self-hosted/index.mdx index 3c342835f7..5d70951fc5 100644 --- a/src/docs/self-hosted/index.mdx +++ b/src/docs/self-hosted/index.mdx @@ -107,7 +107,7 @@ 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 +## 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!** From b07d69358ff76e76e837e2707b237ecb96d7f9f5 Mon Sep 17 00:00:00 2001 From: Hubert Deng Date: Mon, 22 Jul 2024 10:58:50 -0700 Subject: [PATCH 7/7] update wording Co-authored-by: Alex Zaslavsky --- src/docs/self-hosted/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs/self-hosted/index.mdx b/src/docs/self-hosted/index.mdx index 5d70951fc5..71c0eca5dd 100644 --- a/src/docs/self-hosted/index.mdx +++ b/src/docs/self-hosted/index.mdx @@ -115,7 +115,7 @@ Starting from 24.8.0+, users will have the ability to choose between two distinc **Errors Only** -Errors Only self-hosted offers a small subset of features with an emphasis on minimizing system resources while focusing on what we do best: tackling issues head-on. This lightweight option includes only the following features: +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