aboutsummaryrefslogtreecommitdiffstats
path: root/settings_file.html
diff options
context:
space:
mode:
Diffstat (limited to 'settings_file.html')
-rwxr-xr-xsettings_file.html81
1 files changed, 77 insertions, 4 deletions
diff --git a/settings_file.html b/settings_file.html
index 2e17122..e488531 100755
--- a/settings_file.html
+++ b/settings_file.html
@@ -64,7 +64,7 @@
64 64
65 65
66 <div class="version"> 66 <div class="version">
67 0.3.2 67 0.3.3
68 </div> 68 </div>
69 69
70 70
@@ -88,11 +88,28 @@
88 <ul class="current"> 88 <ul class="current">
89<li class="toctree-l1 current"><a class="reference internal" href="using.html">Using EventMQ</a><ul class="current"> 89<li class="toctree-l1 current"><a class="reference internal" href="using.html">Using EventMQ</a><ul class="current">
90<li class="toctree-l2 current"><a class="current reference internal" href="#">Server Settings (eventmq.conf)</a><ul> 90<li class="toctree-l2 current"><a class="current reference internal" href="#">Server Settings (eventmq.conf)</a><ul>
91<li class="toctree-l3"><a class="reference internal" href="#router">Router</a></li> 91<li class="toctree-l3"><a class="reference internal" href="#global">Global</a><ul>
92<li class="toctree-l3"><a class="reference internal" href="#scheduler">Scheduler</a></li> 92<li class="toctree-l4"><a class="reference internal" href="#super-debug">super_debug</a></li>
93</ul>
94</li>
95<li class="toctree-l3"><a class="reference internal" href="#router">Router</a><ul>
96<li class="toctree-l4"><a class="reference internal" href="#frontend-addr">frontend_addr</a></li>
97<li class="toctree-l4"><a class="reference internal" href="#backend-addr">backend_addr</a></li>
98</ul>
99</li>
100<li class="toctree-l3"><a class="reference internal" href="#scheduler">Scheduler</a><ul>
101<li class="toctree-l4"><a class="reference internal" href="#scheduler-addr">scheduler_addr</a></li>
102<li class="toctree-l4"><a class="reference internal" href="#rq-host">rq_host</a></li>
103<li class="toctree-l4"><a class="reference internal" href="#rq-port">rq_port</a></li>
104<li class="toctree-l4"><a class="reference internal" href="#rq-db">rq_db</a></li>
105<li class="toctree-l4"><a class="reference internal" href="#rq-password">rq_password</a></li>
106</ul>
107</li>
93<li class="toctree-l3"><a class="reference internal" href="#job-manager">Job Manager</a><ul> 108<li class="toctree-l3"><a class="reference internal" href="#job-manager">Job Manager</a><ul>
94<li class="toctree-l4"><a class="reference internal" href="#concurrent-jobs">concurrent_jobs</a></li> 109<li class="toctree-l4"><a class="reference internal" href="#concurrent-jobs">concurrent_jobs</a></li>
95<li class="toctree-l4"><a class="reference internal" href="#queues">queues</a></li> 110<li class="toctree-l4"><a class="reference internal" href="#queues">queues</a></li>
111<li class="toctree-l4"><a class="reference internal" href="#setup-callabe-setup-path">setup_callabe/setup_path</a></li>
112<li class="toctree-l4"><a class="reference internal" href="#max-job-count">max_job_count</a></li>
96</ul> 113</ul>
97</li> 114</li>
98</ul> 115</ul>
@@ -151,11 +168,55 @@
151 <div class="section" id="server-settings-eventmq-conf"> 168 <div class="section" id="server-settings-eventmq-conf">
152<h1>Server Settings (eventmq.conf)<a class="headerlink" href="#server-settings-eventmq-conf" title="Permalink to this headline">¶</a></h1> 169<h1>Server Settings (eventmq.conf)<a class="headerlink" href="#server-settings-eventmq-conf" title="Permalink to this headline">¶</a></h1>
153<p>EventMQ uses a standard INI style config file found at <code class="docutils literal"><span class="pre">/etc/eventmq.conf</span></code>.</p> 170<p>EventMQ uses a standard INI style config file found at <code class="docutils literal"><span class="pre">/etc/eventmq.conf</span></code>.</p>
171<div class="section" id="global">
172<h2>Global<a class="headerlink" href="#global" title="Permalink to this headline">¶</a></h2>
173<div class="section" id="super-debug">
174<h3>super_debug<a class="headerlink" href="#super-debug" title="Permalink to this headline">¶</a></h3>
175<p>Default: False</p>
176<p>Enable most verbose level of debug statements</p>
177</div>
178</div>
154<div class="section" id="router"> 179<div class="section" id="router">
155<h2>Router<a class="headerlink" href="#router" title="Permalink to this headline">¶</a></h2> 180<h2>Router<a class="headerlink" href="#router" title="Permalink to this headline">¶</a></h2>
181<div class="section" id="frontend-addr">
182<h3>frontend_addr<a class="headerlink" href="#frontend-addr" title="Permalink to this headline">¶</a></h3>
183<p>Default: &#8216;<a class="reference external" href="tcp://127.0.0.1:47291">tcp://127.0.0.1:47291</a>&#8216;</p>
184<p>The address used to listen for client and scheduler connections</p>
185</div>
186<div class="section" id="backend-addr">
187<h3>backend_addr<a class="headerlink" href="#backend-addr" title="Permalink to this headline">¶</a></h3>
188<p>Default: &#8216;<a class="reference external" href="tcp://127.0.0.1:47291">tcp://127.0.0.1:47291</a>&#8216;</p>
189<p>The address used to listen for connections from workers</p>
190</div>
156</div> 191</div>
157<div class="section" id="scheduler"> 192<div class="section" id="scheduler">
158<h2>Scheduler<a class="headerlink" href="#scheduler" title="Permalink to this headline">¶</a></h2> 193<h2>Scheduler<a class="headerlink" href="#scheduler" title="Permalink to this headline">¶</a></h2>
194<div class="section" id="scheduler-addr">
195<h3>scheduler_addr<a class="headerlink" href="#scheduler-addr" title="Permalink to this headline">¶</a></h3>
196<p>Default: &#8216;<a class="reference external" href="tcp://127.0.0.1:47291">tcp://127.0.0.1:47291</a>&#8216;</p>
197<p>The address the scheduler will use to connect to the broker</p>
198</div>
199<div class="section" id="rq-host">
200<h3>rq_host<a class="headerlink" href="#rq-host" title="Permalink to this headline">¶</a></h3>
201<p>Default: &#8216;localhost&#8217;</p>
202<p>The hostname of the redis server used to persist scheduled jobs. This is
203expected to support redis&#8217; save operation which saves the contents to disk.</p>
204</div>
205<div class="section" id="rq-port">
206<h3>rq_port<a class="headerlink" href="#rq-port" title="Permalink to this headline">¶</a></h3>
207<p>Default: 6379</p>
208<p>Port of redis server to connect to.</p>
209</div>
210<div class="section" id="rq-db">
211<h3>rq_db<a class="headerlink" href="#rq-db" title="Permalink to this headline">¶</a></h3>
212<p>Default: 0</p>
213<p>Which redis database to use</p>
214</div>
215<div class="section" id="rq-password">
216<h3>rq_password<a class="headerlink" href="#rq-password" title="Permalink to this headline">¶</a></h3>
217<p>Default: &#8216;&#8217;</p>
218<p>Password to use when connecting to redis</p>
219</div>
159</div> 220</div>
160<div class="section" id="job-manager"> 221<div class="section" id="job-manager">
161<h2>Job Manager<a class="headerlink" href="#job-manager" title="Permalink to this headline">¶</a></h2> 222<h2>Job Manager<a class="headerlink" href="#job-manager" title="Permalink to this headline">¶</a></h2>
@@ -176,7 +237,7 @@ running. Grouping similar jobs in named queues will help you tune this number.</
176<div class="section" id="queues"> 237<div class="section" id="queues">
177<h3>queues<a class="headerlink" href="#queues" title="Permalink to this headline">¶</a></h3> 238<h3>queues<a class="headerlink" href="#queues" title="Permalink to this headline">¶</a></h3>
178<p>Default: [[10, &#8220;default&#8221;]]</p> 239<p>Default: [[10, &#8220;default&#8221;]]</p>
179<p>Comma seperated list of queues to process jobs for with thier weights. This list 240<p>Comma seperated list of queues to process jobs for with their weights. This list
180must be valid JSON otherwise an error will be thrown. 241must be valid JSON otherwise an error will be thrown.
181Example: <code class="docutils literal"><span class="pre">queues=[[10,</span> <span class="pre">&quot;data_process&quot;],</span> <span class="pre">[15,</span> <span class="pre">&quot;email&quot;]]</span></code>. With these 242Example: <code class="docutils literal"><span class="pre">queues=[[10,</span> <span class="pre">&quot;data_process&quot;],</span> <span class="pre">[15,</span> <span class="pre">&quot;email&quot;]]</span></code>. With these
182weights and the <code class="docutils literal"><span class="pre">CONCURRENT_JOBS</span></code> setting, you should be able to tune managers 243weights and the <code class="docutils literal"><span class="pre">CONCURRENT_JOBS</span></code> setting, you should be able to tune managers
@@ -192,6 +253,18 @@ default queue so that anything that is not explicitly assigned will still be
192run.</p> 253run.</p>
193</div> 254</div>
194</div> 255</div>
256<div class="section" id="setup-callabe-setup-path">
257<h3>setup_callabe/setup_path<a class="headerlink" href="#setup-callabe-setup-path" title="Permalink to this headline">¶</a></h3>
258<p>Default: &#8216;&#8217; (Signifies no task will be attempted)</p>
259<p>Strings containing path and callable to be run when a worker is spawned
260if applicable to that type of worker. Currently the only supported worker is a
261MultiProcessWorker, and is useful for pulling any global state into memory.</p>
262</div>
263<div class="section" id="max-job-count">
264<h3>max_job_count<a class="headerlink" href="#max-job-count" title="Permalink to this headline">¶</a></h3>
265<p>Default: 1024</p>
266<p>After a worker runs this amount of jobs, it will gracefully exit and be replaced</p>
267</div>
195</div> 268</div>
196</div> 269</div>
197 270