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
chore(devservices): Add additional devservices modes and commands (#14064)
## DESCRIBE YOUR PR
This PR adds some descriptions for new devservices commands added. It
also adds more modes that have been added, and a guide to debugging a
background process in the foreground.
- `symbolicator`: Bring up sentry dependencies and symbolicator
76
78
- `chartcuterie`: Bring up sentry dependencies and chartcuterie
79
+
- `taskbroker`: Bring up sentry dependencies, taskbroker, taskworker, and taskworker-scheduler
77
80
- `minimal`: Bring up minimal services for local development
78
-
- `profiling`: Bring up sentry dependencies and vroom
81
+
- `profiling`: Bring up sentry dependencies, vroom, and profiling consumers
82
+
- `crons`: Brings up sentry dependencies and monitor consumers
83
+
- `tracing`: Brings up sentry dependencies and everything necessary for transactions, spans, and metrics
84
+
- `ingest`: Brings up the most common sentry dependencies to support ingestion of errors and transactions
85
+
- `ingest-all`: Brings up sentry dependencies to support ingesting everything
79
86
- `full`: Bring up all services (symbolicator, taskbroker, snuba, vroom, etc)
80
87
81
88
```shell
82
89
devservices up --mode symbolicator
83
90
```
84
91
92
+
## Debugging a Background Process Interactively
93
+
94
+
There are a couple groups of processes that are running in the background. These include ingest consumers, post process forwarders, and taskworkers. You'll want to use the devservices foreground command to debug these interactively if you cannot do so with the devserver itself.
95
+
96
+
1. Bring up your development environment:
97
+
``` sh
98
+
devservices up --mode taskbroker
99
+
devservices serve
100
+
```
101
+
102
+
2. Add a breakpoint
103
+
104
+
``` python
105
+
def example () -> None
106
+
...
107
+
breakpoint() // After python 3.7
108
+
import pdb;pdb.set_trace() // Before python 3.7
109
+
...
110
+
```
111
+
112
+
3. Bring a process to the foreground for debugging
113
+
``` sh
114
+
devservices foreground taskbroker
115
+
```
116
+
117
+
118
+
85
119
## Running a dependency locally
86
120
87
121
You can run a dependency locally instead of as a container by toggling its runtime via the `devservices toggle` command.
0 commit comments