Skip to content

Commit b9f4584

Browse files
docs(dev-infra): Update development environment docs (#14585)
<!-- Use this checklist to make sure your PR is ready for merge. You may delete any sections you don't need. --> ## DESCRIBE YOUR PR This changes the workflow for getting people onboarded onto their sentry development environments to use the new `devservices serve` and devservices modes for enabling ingestion. ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [x] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) ## EXTRA RESOURCES - [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
1 parent 5bc9b18 commit b9f4584

File tree

1 file changed

+7
-10
lines changed
  • develop-docs/development-infrastructure/environment

1 file changed

+7
-10
lines changed

develop-docs/development-infrastructure/environment/index.mdx

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,9 @@ devservices up
3434
After that, you can start the development server inside the `sentry` folder:
3535

3636
```shell
37-
sentry devserver --workers
37+
devservices serve
3838
```
3939

40-
If you are developing for aesthetics only and do not rely on the async workers, you can omit the `--workers` flag in order
41-
to use fewer system resources.
42-
4340
Access it at [http://dev.getsentry.net:8000](http://dev.getsentry.net:8000) (you'll have to wait a bit for webpack to finish).
4441
A superuser account should have been created for you during bootstrap - `[email protected]` with password `admin`.
4542
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 `:
8683
<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:
8784

8885
- Set `SENTRY_USE_RELAY = True` in `~/.sentry/sentry.conf.py`.
89-
- Run `devservices up` to start the services Relay needs. (like for example Kafka)
90-
- (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.
86+
- Run `devservices up --mode ingest` to start the services Relay needs. (like for example Kafka)
87+
- Start your devserver (e.g. `devservices serve`).
9188

9289
## Running the Getsentry Development Server
9390

@@ -108,7 +105,7 @@ devservices up
108105
After that, you can start the development server inside the `getsentry` folder:
109106

110107
```shell
111-
getsentry devserver --workers
108+
devservices serve
112109
```
113110

114111
**Note**: You **cannot** have both sentry and getsentry devserver running at the same time.
@@ -123,7 +120,7 @@ by `dev.py` if it exists.
123120
To enable the ingest workers, follow the steps described <Link to="#ingestion-pipeline-relay">here</Link> and run
124121

125122
```shell
126-
getsentry devserver --workers --ingest
123+
devservices serve
127124
```
128125

129126
## Running siloed instances
@@ -134,10 +131,10 @@ The devserver command supports `--silo` option that lets you create siloed insta
134131

135132
```shell
136133
# Start control silo servers
137-
sentry devserver --silo=control --celery-beat --workers
134+
devservices serve --silo=control --celery-beat
138135

139136
# Start region silo servers
140-
sentry devserver --silo=region --celery-beat --workers --ingest
137+
devservices serve --silo=region --celery-beat
141138
```
142139

143140
Siloed servers have the following port assignments:

0 commit comments

Comments
 (0)