You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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/)
Copy file name to clipboardExpand all lines: develop-docs/development-infrastructure/environment/index.mdx
+7-10Lines changed: 7 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,12 +34,9 @@ devservices up
34
34
After that, you can start the development server inside the `sentry` folder:
35
35
36
36
```shell
37
-
sentry devserver --workers
37
+
devservices serve
38
38
```
39
39
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
-
43
40
Access it at [http://dev.getsentry.net:8000](http://dev.getsentry.net:8000) (you'll have to wait a bit for webpack to finish).
44
41
A superuser account should have been created for you during bootstrap - `[email protected]` with password `admin`.
45
42
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 `:
86
83
<Linkto="/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:
87
84
88
85
- 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`).
91
88
92
89
## Running the Getsentry Development Server
93
90
@@ -108,7 +105,7 @@ devservices up
108
105
After that, you can start the development server inside the `getsentry` folder:
109
106
110
107
```shell
111
-
getsentry devserver --workers
108
+
devservices serve
112
109
```
113
110
114
111
**Note**: You **cannot** have both sentry and getsentry devserver running at the same time.
@@ -123,7 +120,7 @@ by `dev.py` if it exists.
123
120
To enable the ingest workers, follow the steps described <Linkto="#ingestion-pipeline-relay">here</Link> and run
124
121
125
122
```shell
126
-
getsentry devserver --workers --ingest
123
+
devservices serve
127
124
```
128
125
129
126
## Running siloed instances
@@ -134,10 +131,10 @@ The devserver command supports `--silo` option that lets you create siloed insta
0 commit comments