fork/django-q2
1
0
Fork 0
mirror of https://github.com/django-q2/django-q2.git synced 2026-09-24 13:08:12 +08:00
Code Issues Packages Projects Releases Wiki Activity

fixed typos etc

Browse Source
This commit is contained in:
Ilan Steemers
2015-06-24 12:49:38 +02:00
parent e80e33daa0
commit a6e91b0bcf
2 changed files with 16 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -6
View File
@@ -26,8 +26,8 @@ Start a cluster with `./manage.py qcluster`
You can monitor basic information about all the connected clusters by running `./manage.py qmonitor`
###Admin integration
Django Q registers itself with the admin page to show failed and succesful tasks.
From there task results can be read or deleted. If neccesary, failed tasks can be reintroduced to the queue.
Django Q registers itself with the admin page to show failed and successful tasks.
From there task results can be read or deleted. If necessary, failed tasks can be reintroduced to the queue.
### Signed Tasks
Tasks are first pickled to Json and then signed using Django's own signing module before being sent to a Redis list. This ensures that task packages on the Redis server can only be excuted and read by clusters and django servers who share the same secret key.
@@ -35,20 +35,21 @@ Tasks are first pickled to Json and then signed using Django's own signing modul
Optionally, packages can be compressed before transport by setting `Q_COMPRESSED = True `
### Pusher
The pusher process continously checks the Redis list for new task packages and pushes them on the Task Queue.
The pusher process continuously checks the Redis list for new task packages and pushes them on the Task Queue.
### Worker
A worker process checks the package signing, unpacks the task, executes it and saves the return value. Irrespective of the failure or success of any of these steps, the package is then pushed onto the Result Queue.
By default Django Q spawns a worker for each detected CPU on the host system.
This can be overridden by setting `Q_WORKERS = n`. With *n* being the numbe of desired worker processes.
This can be overridden by setting `Q_WORKERS = n`. With *n* being the number of desired worker processes.
### Monitor
The result monitor checks the Result Queue for processed packages and saves both failed and succesful packages to the Django database.
The result monitor checks the Result Queue for processed packages and saves both failed and successful packages to the Django database.
By default only the last 100 succesful packages are kept in the database.
By default only the last 100 successful packages are kept in the database.
This can be increased or decreased at will by settings `Q_SAVE_LIMIT = n`. With *n* being the desired number of records.
Set `Q_SAVE_LIMIT = 0` to save all results to the database.
`Q_SAVE_LIMIT = None` will make the monitor refrain from savig success
Failed packages are always saved.
### Sentinel
README.rst
+9 -8
View File
@@ -49,8 +49,8 @@ Admin integration
~~~~~~~~~~~~~~~~~
Django Q registers itself with the admin page to show failed and
succesful tasks. From there task results can be read or deleted. If
neccesary, failed tasks can be reintroduced to the queue.
successful tasks. From there task results can be read or deleted. If
necessary, failed tasks can be reintroduced to the queue.
Signed Tasks
~~~~~~~~~~~~
@@ -66,7 +66,7 @@ Optionally, packages can be compressed before transport by setting
Pusher
~~~~~~
The pusher process continously checks the Redis list for new task
The pusher process continuously checks the Redis list for new task
packages and pushes them on the Task Queue.
Worker
@@ -78,19 +78,20 @@ any of these steps, the package is then pushed onto the Result Queue.
By default Django Q spawns a worker for each detected CPU on the host
system. This can be overridden by setting ``Q_WORKERS = n``. With *n*
being the numbe of desired worker processes.
being the number of desired worker processes.
Monitor
~~~~~~~
The result monitor checks the Result Queue for processed packages and
saves both failed and succesful packages to the Django database.
saves both failed and successful packages to the Django database.
By default only the last 100 succesful packages are kept in the
By default only the last 100 successful packages are kept in the
database. This can be increased or decreased at will by settings
``Q_SAVE_LIMIT = n``. With *n* being the desired number of records. Set
``Q_SAVE_LIMIT = 0`` to save all results to the database. Failed
packages are always saved.
``Q_SAVE_LIMIT = 0`` to save all results to the database.
``Q_SAVE_LIMIT = None`` will make the monitor refrain from savig success
Failed packages are always saved.
Sentinel
~~~~~~~~