-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
docs(dev-infra): Update development environment docs #14585
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
Merged
hubertdeng123
merged 2 commits into
master
from
hubertdeng123/update-setup-guide-development-environments
Aug 8, 2025
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,12 +34,9 @@ devservices up | |
| After that, you can start the development server inside the `sentry` folder: | ||
|
|
||
| ```shell | ||
| sentry devserver --workers | ||
| devservices serve | ||
| ``` | ||
|
|
||
| If you are developing for aesthetics only and do not rely on the async workers, you can omit the `--workers` flag in order | ||
| to use fewer system resources. | ||
|
|
||
| Access it at [http://dev.getsentry.net:8000](http://dev.getsentry.net:8000) (you'll have to wait a bit for webpack to finish). | ||
| A superuser account should have been created for you during bootstrap - `[email protected]` with password `admin`. | ||
| You can create other users with `sentry createuser`. | ||
|
|
@@ -86,8 +83,8 @@ After the server is running we can visit the dev server using `https` at port `: | |
| <Link to="/relay/">Relay</Link> and the ingest workers are not started by default. Follow the instructions below to start them so you can send events to your dev environment Sentry instance: | ||
|
|
||
| - Set `SENTRY_USE_RELAY = True` in `~/.sentry/sentry.conf.py`. | ||
| - Run `devservices up` to start the services Relay needs. (like for example Kafka) | ||
| - (Re-)Start your devserver with the `--ingest` flag (e.g. `sentry devserver --workers --ingest`). This will start the Relay container and all related services alongside your devserver. | ||
| - Run `devservices up --mode ingest` to start the services Relay needs. (like for example Kafka) | ||
| - Start your devserver (e.g. `devservices serve`). | ||
|
|
||
| ## Running the Getsentry Development Server | ||
|
|
||
|
|
@@ -108,7 +105,7 @@ devservices up | |
| After that, you can start the development server inside the `getsentry` folder: | ||
|
|
||
| ```shell | ||
| getsentry devserver --workers | ||
| devservices serve | ||
| ``` | ||
|
|
||
| **Note**: You **cannot** have both sentry and getsentry devserver running at the same time. | ||
|
|
@@ -123,7 +120,7 @@ by `dev.py` if it exists. | |
| To enable the ingest workers, follow the steps described <Link to="#ingestion-pipeline-relay">here</Link> and run | ||
|
|
||
| ```shell | ||
| getsentry devserver --workers --ingest | ||
| devservices serve | ||
| ``` | ||
|
|
||
| ## Running siloed instances | ||
|
|
@@ -134,10 +131,10 @@ The devserver command supports `--silo` option that lets you create siloed insta | |
|
|
||
| ```shell | ||
| # Start control silo servers | ||
| sentry devserver --silo=control --celery-beat --workers | ||
| devservices serve --silo=control --celery-beat | ||
|
|
||
| # Start region silo servers | ||
| sentry devserver --silo=region --celery-beat --workers --ingest | ||
| devservices serve --silo=region --celery-beat | ||
| ``` | ||
|
|
||
| Siloed servers have the following port assignments: | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.