diff --git a/develop-docs/development/environment/index.mdx b/develop-docs/development/environment/index.mdx index 59f03da7f760a..8d25d2c0d844c 100644 --- a/develop-docs/development/environment/index.mdx +++ b/develop-docs/development/environment/index.mdx @@ -16,14 +16,12 @@ After installation you should be able to run `devenv bootstrap` which will guide When you're done with setup, you'll want to also review the development workflow. - ## Keeping your environment up-to-date Simply run `devenv sync` inside of your sentry or getsentry repo. NOTE: After running `devenv sync` you may need to restart your terminal to continue. - ## Running the Development Server The `devservices` ensure that you have all the services required for local development running. See the [devservices docs](/services/devservices/) for more information on managing services. @@ -108,6 +106,8 @@ sentry devservices up snuba See also: Sentry vs Getsentry +Before running `getsentry`, you might need to run `devenv sync` inside the `getsentry` directory if you have previously run `sentry` locally, as there might be differences between the environments. + Just like running `sentry` (see above), you can start the `devservices` using the following command in the `getsentry` folder: ```shell @@ -122,9 +122,7 @@ getsentry devserver --workers **Note**: You **cannot** have both sentry and getsentry devserver running at the same time. -After the server warms up for a little while, you must access it -at [http://dev.getsentry.net:8000](http://dev.getsentry.net:8000/). -Using localhost doesn't work. +After the server warms up, access it at [http://dev.getsentry.net:8000](http://dev.getsentry.net:8000/). Using localhost won't work. Note that the **http** protocol is used, not **https**. If you encounter a certificate error while accessing it locally, it might be because your browser has remembered that `dev.getsentry.net` previously used the https protocol (possibly while running `yarn dev-ui`) and is now redirecting all http requests to https. To resolve this, open the site in an **incognito window** of your browser. If you need to overwrite configuration options for your local environment, you can create `getsentry/conf/settings/devlocal.py` and put the @@ -132,16 +130,16 @@ configuration option overrides there. This module will be automatically imported by `dev.py` if it exists. To enable the ingest workers, follow the steps described here and run + ```shell getsentry devserver --workers --ingest ``` - ## Running siloed instances -By default `sentry devserver` will run a monolith mode application server. You can also run ``devserver`` with siloed application instances. Before you do, you need to create split silo databases. +By default `sentry devserver` will run a monolith mode application server. You can also run `devserver` with siloed application instances. Before you do, you need to create split silo databases. -The devserver command supports `--silo` option that lets you create siloed instances. Any workers, consumers, or celery-beat processes will be started with the same silo mode. +The devserver command supports `--silo` option that lets you create siloed instances. Any workers, consumers, or celery-beat processes will be started with the same silo mode. ```shell # Start control silo servers @@ -150,6 +148,7 @@ sentry devserver --silo=control --celery-beat --workers # Start region silo servers sentry devserver --silo=region --celery-beat --workers --ingest ``` + Siloed servers have the following port assignments: - 8000 - Webpack