Skip to content

Commit bb2f077

Browse files
committed
Some basic queue documentation
1 parent ff22bcb commit bb2f077

2 files changed

Lines changed: 25 additions & 0 deletions

File tree

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Users Guide
1414

1515
install/index
1616
config/index
17+
queue/index
1718
cli/index
1819
client/index
1920
interfaces/index

docs/queue/index.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Utilizing the Queue
2+
===================
3+
4+
Sentry comes with a built-in queue to process tasks in a more asynchronous
5+
fashion. For example, with workers enabled, when an event comes in instead
6+
of writing it to the database immediately, it sends a job to the queue so
7+
that the request can be returned right away, and the background workers
8+
handle actually saving that data.
9+
10+
Run a Worker
11+
------------
12+
13+
Workers can be run by using the Sentry CLI. Specifically, you pass the 'worker'
14+
service to the start command::
15+
16+
sentry start worker
17+
18+
Enable the Queue
19+
----------------
20+
21+
Once you've brought up a worker, the next step is to enable the queue. This is
22+
done with a simple settings flag::
23+
24+
SENTRY_USE_QUEUE = True

0 commit comments

Comments
 (0)