Skip to content

Commit aebe554

Browse files
authored
chore: clearer message for errors-only mode (#3487)
1 parent 92d7d83 commit aebe554

File tree

2 files changed

+15
-4
lines changed

2 files changed

+15
-4
lines changed

.env

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
COMPOSE_PROJECT_NAME=sentry-self-hosted
2+
# Set COMPOSE_PROFILES to "feature-complete" to enable all features
3+
# To enable errors monitoring only, set COMPOSE_PROFILES=errors-only
4+
# See https://develop.sentry.dev/self-hosted/experimental/errors-only/
25
COMPOSE_PROFILES=feature-complete
36
SENTRY_EVENT_RETENTION_DAYS=90
47
# You can either use a port number or an IP:PORT combo for SENTRY_BIND

sentry/sentry.conf.example.py

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,18 @@ def get_internal_network():
7272
env("SENTRY_EVENT_RETENTION_DAYS", "90")
7373
)
7474

75+
# Self-hosted Sentry infamously has a lot of Docker containers required to make
76+
# all the features work. Oftentimes, users don't use the full feature set that
77+
# requires all the containers. This is a way to enable only the error monitoring
78+
# feature which also reduces the amount of containers required to run Sentry.
79+
#
80+
# To make Sentry work with all features, set `COMPOSE_PROFILES` to `feature-complete`
81+
# in your `.env` file. To enable only the error monitoring feature, set
82+
# `COMPOSE_PROFILES` to `errors-only`.
83+
#
84+
# See https://develop.sentry.dev/self-hosted/experimental/errors-only/
85+
SENTRY_SELF_HOSTED_ERRORS_ONLY = env("COMPOSE_PROFILES") != "feature-complete"
86+
7587
#########
7688
# Redis #
7789
#########
@@ -373,10 +385,6 @@ def get_internal_network():
373385
# if you're using it directly like a CDN instead of using the loader script.
374386
JS_SDK_LOADER_DEFAULT_SDK_URL = "https://browser.sentry-cdn.com/%s/bundle%s.min.js"
375387

376-
377-
# If you would like to use self-hosted Sentry with only errors enabled, please set this
378-
SENTRY_SELF_HOSTED_ERRORS_ONLY = env("COMPOSE_PROFILES") != "feature-complete"
379-
380388
#####################
381389
# Insights Settings #
382390
#####################

0 commit comments

Comments
 (0)