diff options
| author | jason | 2016-05-24 20:19:12 -0600 |
|---|---|---|
| committer | jason | 2016-05-24 20:19:12 -0600 |
| commit | 8a8396c454206feb589a806db2ddf8a03d2d757e (patch) | |
| tree | f68b67d98bea14d0f15b0e11e3fe2c81a5376a9c /_sources | |
| parent | 8fc4bcc96063b29d0726feb7a72b28acf01b109c (diff) | |
| download | eventmq-8a8396c454206feb589a806db2ddf8a03d2d757e.tar.gz eventmq-8a8396c454206feb589a806db2ddf8a03d2d757e.zip | |
0.2.1 update
Diffstat (limited to '_sources')
| -rw-r--r-- | _sources/index.txt | 2 | ||||
| -rw-r--r-- | _sources/protocol.txt | 13 | ||||
| -rw-r--r-- | _sources/settings_file.txt | 51 | ||||
| -rw-r--r-- | _sources/using.txt | 8 |
4 files changed, 66 insertions, 8 deletions
diff --git a/_sources/index.txt b/_sources/index.txt index da6e513..25fc86f 100644 --- a/_sources/index.txt +++ b/_sources/index.txt | |||
| @@ -5,6 +5,7 @@ EventMQ Documentation | |||
| 5 | .. toctree:: | 5 | .. toctree:: |
| 6 | :maxdepth: 2 | 6 | :maxdepth: 2 |
| 7 | 7 | ||
| 8 | using | ||
| 8 | api | 9 | api |
| 9 | contributing | 10 | contributing |
| 10 | 11 | ||
| @@ -15,4 +16,3 @@ Indices and tables | |||
| 15 | * :ref:`genindex` | 16 | * :ref:`genindex` |
| 16 | * :ref:`modindex` | 17 | * :ref:`modindex` |
| 17 | * :ref:`search` | 18 | * :ref:`search` |
| 18 | |||
diff --git a/_sources/protocol.txt b/_sources/protocol.txt index 4c2aff0..c341403 100644 --- a/_sources/protocol.txt +++ b/_sources/protocol.txt | |||
| @@ -71,7 +71,7 @@ FRAME Value Description | |||
| 71 | 1 eMQP/1.0 Protocol version | 71 | 1 eMQP/1.0 Protocol version |
| 72 | 2 REQUEST command | 72 | 2 REQUEST command |
| 73 | 3 _MSGID_ A unique id for the msg | 73 | 3 _MSGID_ A unique id for the msg |
| 74 | 4 _QUEUE_NAME_ the name of the queue the worker belongs to | 74 | 4 _QUEUE_NAME_ the name of the queue the request should be sent to |
| 75 | 5 _HEADERS_ dictionary of headers. can be an empty set | 75 | 5 _HEADERS_ dictionary of headers. can be an empty set |
| 76 | 6 _MSG_ The message to send | 76 | 6 _MSG_ The message to send |
| 77 | ====== ============== =========== | 77 | ====== ============== =========== |
| @@ -85,7 +85,7 @@ FRAME Value Description | |||
| 85 | 1 eMQP/1.0 Protocol version | 85 | 1 eMQP/1.0 Protocol version |
| 86 | 2 PUBLISH command | 86 | 2 PUBLISH command |
| 87 | 3 _MSGID_ A unique id for the msg | 87 | 3 _MSGID_ A unique id for the msg |
| 88 | 4 _TOPIC_NAME_ the name of the queue the worker belongs to | 88 | 4 _TOPIC_NAME_ the name of the topic this message should be published across |
| 89 | 5 _HEADERS_ csv list of headers | 89 | 5 _HEADERS_ csv list of headers |
| 90 | 6 _MSG_ The message to send | 90 | 6 _MSG_ The message to send |
| 91 | ====== ============== =========== | 91 | ====== ============== =========== |
| @@ -99,7 +99,7 @@ FRAME Value Description | |||
| 99 | 1 eMQP/1.0 Protocol version | 99 | 1 eMQP/1.0 Protocol version |
| 100 | 2 SCHEDULE command | 100 | 2 SCHEDULE command |
| 101 | 3 _MSGID_ A unique id for the msg | 101 | 3 _MSGID_ A unique id for the msg |
| 102 | 4 _TOPIC_NAME_ name of queue that the job should run in | 102 | 4 _QUEUE_NAME_ name of queue that the job should run in |
| 103 | 5 _HEADERS_ csv list of headers for this message | 103 | 5 _HEADERS_ csv list of headers for this message |
| 104 | 6 _MSG_ The message to send | 104 | 6 _MSG_ The message to send |
| 105 | ====== ============== =========== | 105 | ====== ============== =========== |
| @@ -113,7 +113,7 @@ FRAME Value Description | |||
| 113 | 1 eMQP/1.0 Protocol version | 113 | 1 eMQP/1.0 Protocol version |
| 114 | 2 UNSCHEDULE command | 114 | 2 UNSCHEDULE command |
| 115 | 3 _MSGID_ A unique id for the msg | 115 | 3 _MSGID_ A unique id for the msg |
| 116 | 4 _TOPIC_NAME_ ignored for this command, broadcasted to all queues | 116 | 4 _QUEUE_NAME_ ignored for this command, broadcasted to all queues |
| 117 | 5 _HEADERS_ csv list of headers for this message | 117 | 5 _HEADERS_ csv list of headers for this message |
| 118 | 6 _MSG_ The message to send | 118 | 6 _MSG_ The message to send |
| 119 | ====== ============== =========== | 119 | ====== ============== =========== |
| @@ -129,7 +129,7 @@ FRAME Value Description | |||
| 129 | 1 eMQP/1.0 Protocol version | 129 | 1 eMQP/1.0 Protocol version |
| 130 | 2 INFORM command | 130 | 2 INFORM command |
| 131 | 3 _MSGID_ A unique id for the msg | 131 | 3 _MSGID_ A unique id for the msg |
| 132 | 4 _QUEUE_NAME_ csv seperated names of queue the worker belongs to | 132 | 4 Queues. Unused for scheduler |
| 133 | 5 scheduler type of peer connecting | 133 | 5 scheduler type of peer connecting |
| 134 | ====== ============== =========== | 134 | ====== ============== =========== |
| 135 | 135 | ||
| @@ -144,7 +144,7 @@ FRAME Value Description | |||
| 144 | 1 eMQP/1.0 Protocol version | 144 | 1 eMQP/1.0 Protocol version |
| 145 | 2 INFORM command | 145 | 2 INFORM command |
| 146 | 3 _MSGID_ A unique id for the msg | 146 | 3 _MSGID_ A unique id for the msg |
| 147 | 4 _QUEUE_NAME_ csv seperated names of queue the worker belongs to. | 147 | 4 _QUEUES_ csv seperated arrays containing an int and a string for weight and name. e.g. [40, 'email'] |
| 148 | 5 worker type of peer connecting | 148 | 5 worker type of peer connecting |
| 149 | ====== ============== =========== | 149 | ====== ============== =========== |
| 150 | 150 | ||
| @@ -203,7 +203,6 @@ Heartbeating | |||
| 203 | * If the worker detects that the broker disconnected it SHOULD restart the conversation. | 203 | * If the worker detects that the broker disconnected it SHOULD restart the conversation. |
| 204 | * If the broker detects that a worker has disconnected it should stop sending it a message of any type. | 204 | * If the broker detects that a worker has disconnected it should stop sending it a message of any type. |
| 205 | * If the scheduler detects that the broker disconnects it SHOULD restart the conversation. | 205 | * If the scheduler detects that the broker disconnects it SHOULD restart the conversation. |
| 206 | * If the broker detects that a scheduler has disconnected it should ??????????. | ||
| 207 | 206 | ||
| 208 | REQUEST Headers | 207 | REQUEST Headers |
| 209 | --------------- | 208 | --------------- |
diff --git a/_sources/settings_file.txt b/_sources/settings_file.txt new file mode 100644 index 0000000..b0bc36c --- /dev/null +++ b/_sources/settings_file.txt | |||
| @@ -0,0 +1,51 @@ | |||
| 1 | ######## | ||
| 2 | Settings | ||
| 3 | ######## | ||
| 4 | EventMQ uses a standard INI style config file found at ``/etc/eventmq.conf``. | ||
| 5 | |||
| 6 | ****** | ||
| 7 | Router | ||
| 8 | ****** | ||
| 9 | |||
| 10 | ********* | ||
| 11 | Scheduler | ||
| 12 | ********* | ||
| 13 | |||
| 14 | *********** | ||
| 15 | Job Manager | ||
| 16 | *********** | ||
| 17 | |||
| 18 | concurrent_jobs | ||
| 19 | =============== | ||
| 20 | Default: 4 | ||
| 21 | |||
| 22 | This is the number of concurrent jobs the indiviudal job manager should execute | ||
| 23 | at a time. If you are using the multiprocess or threading model this number | ||
| 24 | becomes important as you will want to control the load on your server. If the | ||
| 25 | load equals the number of cores on the server, processes will begin waiting for | ||
| 26 | cpu cycles and things will begin to slow down. | ||
| 27 | |||
| 28 | A safe number to choose if your jobs block a lot would be (2 * cores). If your | ||
| 29 | jobs are cpu intensive you will want to set this number to the number of cores | ||
| 30 | you have or (cores - 1) to leave cycles for the os and other processes. This is | ||
| 31 | something that will have to be tuned based on the jobs that are | ||
| 32 | running. Grouping similar jobs in named queues will help you tune this number. | ||
| 33 | |||
| 34 | queues | ||
| 35 | ====== | ||
| 36 | Default: (10, default) | ||
| 37 | |||
| 38 | Semi-colon seperated list of queues to process jobs for with thier | ||
| 39 | weights. Example: ``queues=(10, data_process); (15, email)``. With these | ||
| 40 | weights and the ``CONCURRENT_JOBS`` setting, you should be able to tune managers | ||
| 41 | running jobs locally pretty efficiently. If you have a larger box with a weight | ||
| 42 | of 50 on q1 and 8 concurrent jobs and a smaller box with a weight 30 and 4 | ||
| 43 | concurrent jobs, the q1 jobs will be sent to the large box until it is no longer | ||
| 44 | accepting jobs. At this point jobs will start to be sent to the next highest | ||
| 45 | number until the large box is ready to accept another q1 job. | ||
| 46 | |||
| 47 | .. note:: | ||
| 48 | |||
| 49 | It is recommended that you have some workers listening for jobs on your | ||
| 50 | default queue so that anything that is not explicitly assigned will still be | ||
| 51 | run. | ||
diff --git a/_sources/using.txt b/_sources/using.txt new file mode 100644 index 0000000..3c6a517 --- /dev/null +++ b/_sources/using.txt | |||
| @@ -0,0 +1,8 @@ | |||
| 1 | ############# | ||
| 2 | Using EventMQ | ||
| 3 | ############# | ||
| 4 | |||
| 5 | .. toctree:: | ||
| 6 | :maxdepth: 2 | ||
| 7 | |||
| 8 | settings_file | ||