1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
|
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>jobmanager – Job Manager — EventMQ 0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="EventMQ 0 documentation" href="index.html"/>
<link rel="up" title="API Documentation" href="api.html"/>
<link rel="next" title="poller – Poller" href="poller.html"/>
<link rel="prev" title="exceptions – Exceptions" href="exceptions.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> EventMQ
</a>
<div class="version">
0.3.6
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="using.html">Using EventMQ</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="client.html"><code class="docutils literal"><span class="pre">client</span></code> – Client Utilities</a></li>
<li class="toctree-l2"><a class="reference internal" href="exceptions.html"><code class="docutils literal"><span class="pre">exceptions</span></code> – Exceptions</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#"><code class="docutils literal"><span class="pre">jobmanager</span></code> – Job Manager</a></li>
<li class="toctree-l2"><a class="reference internal" href="poller.html"><code class="docutils literal"><span class="pre">poller</span></code> – Poller</a></li>
<li class="toctree-l2"><a class="reference internal" href="receiver.html"><code class="docutils literal"><span class="pre">receiver</span></code> – Receiver</a></li>
<li class="toctree-l2"><a class="reference internal" href="router.html"><code class="docutils literal"><span class="pre">router</span></code> – Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="sender.html"><code class="docutils literal"><span class="pre">sender</span></code> – Sender</a></li>
<li class="toctree-l2"><a class="reference internal" href="utils/index.html"><code class="docutils literal"><span class="pre">utils</span></code> – Utilities</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to EventMQ</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">EventMQ</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li><a href="api.html">API Documentation</a> »</li>
<li><code class="docutils literal"><span class="pre">jobmanager</span></code> – Job Manager</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/jobmanager.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<span class="target" id="module-eventmq.jobmanager"></span><div class="section" id="jobmanager-job-manager">
<h1><code class="xref py py-mod docutils literal"><span class="pre">jobmanager</span></code> – Job Manager<a class="headerlink" href="#jobmanager-job-manager" title="Permalink to this headline">¶</a></h1>
<p>Ensures things about jobs and spawns the actual tasks</p>
<dl class="class">
<dt id="eventmq.jobmanager.JobManager">
<em class="property">class </em><code class="descclassname">eventmq.jobmanager.</code><code class="descname">JobManager</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager" title="Permalink to this definition">¶</a></dt>
<dd><p>The exposed portion of the worker. The job manager’s main responsibility is
to manage the resources on the server it’s running.</p>
<p>This job manager uses multiprocessing Queues</p>
<dl class="method">
<dt id="eventmq.jobmanager.JobManager.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.__init__" title="Permalink to this definition">¶</a></dt>
<dd><div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">All args are optional unless otherwise noted.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – unique name of this instance. By default a uuid will be
generated.</li>
<li><strong>queues</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.7)"><em>tuple</em></a>) – List of queue names to listen on.</li>
<li><strong>skip_signal</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)"><em>bool</em></a>) – Don’t register the signal handlers. Useful for
testing.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="eventmq.jobmanager.JobManager.check_worker_health">
<code class="descname">check_worker_health</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.check_worker_health" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks for any dead processes in the pool and recreates them if
necessary</p>
</dd></dl>
<dl class="attribute">
<dt id="eventmq.jobmanager.JobManager.concurrent_jobs">
<code class="descname">concurrent_jobs</code><em class="property"> = None</em><a class="headerlink" href="#eventmq.jobmanager.JobManager.concurrent_jobs" title="Permalink to this definition">¶</a></dt>
<dd><p>keep track of workers</p>
</dd></dl>
<dl class="method">
<dt id="eventmq.jobmanager.JobManager.handle_response">
<code class="descname">handle_response</code><span class="sig-paren">(</span><em>resp</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.handle_response" title="Permalink to this definition">¶</a></dt>
<dd><p>Handles a response from a worker process to the jobmanager</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>resp</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – Must contain a key ‘callback’ with the desired callback</td>
</tr>
</tbody>
</table>
<p>function as a string, i.e. ‘worker_done’ which is then called</p>
<p>Sample Input
resp = {</p>
<blockquote>
<div>‘callback’: ‘worker_done’, (str)
‘msgid’: ‘some_uuid’, (str)
‘return’: ‘return value’, (dict)
‘pid’: ‘pid_of_worker_process’ (int)</div></blockquote>
<p>}</p>
<p>return_value must be a dictionary that can be json serialized and
formatted like:</p>
<dl class="docutils">
<dt>{</dt>
<dd>“value”: ‘return value of job goes here’</dd>
</dl>
<p>}</p>
<p>if the ‘return’ value of resp is ‘DEATH’, the worker died so we clean
that up as well</p>
</dd></dl>
<dl class="method">
<dt id="eventmq.jobmanager.JobManager.jobmanager_main">
<code class="descname">jobmanager_main</code><span class="sig-paren">(</span><em>broker_addr=None</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.jobmanager_main" title="Permalink to this definition">¶</a></dt>
<dd><p>Kick off jobmanager with logging and settings import</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>broker_addr</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – The address of the broker to connect to.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="eventmq.jobmanager.JobManager.jobs_in_flight">
<code class="descname">jobs_in_flight</code><em class="property"> = None</em><a class="headerlink" href="#eventmq.jobmanager.JobManager.jobs_in_flight" title="Permalink to this definition">¶</a></dt>
<dd><p>Stats and monitoring information
Jobs in flight tracks all jobs currently executing.
Key: msgid, Value: The message with all the details of the job</p>
</dd></dl>
<dl class="attribute">
<dt id="eventmq.jobmanager.JobManager.name">
<code class="descname">name</code><em class="property"> = None</em><a class="headerlink" href="#eventmq.jobmanager.JobManager.name" title="Permalink to this definition">¶</a></dt>
<dd><p>Define the name of this JobManager instance. Useful to know when
referring to the logs.</p>
</dd></dl>
<dl class="method">
<dt id="eventmq.jobmanager.JobManager.on_heartbeat">
<code class="descname">on_heartbeat</code><span class="sig-paren">(</span><em>msgid</em>, <em>message</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.on_heartbeat" title="Permalink to this definition">¶</a></dt>
<dd><p>a placeholder for a noop command. The actual ‘logic’ for HEARTBEAT is
in <code class="xref py py-meth docutils literal"><span class="pre">self.process_message()</span></code> as every message is counted as a
HEARTBEAT</p>
</dd></dl>
<dl class="method">
<dt id="eventmq.jobmanager.JobManager.on_request">
<code class="descname">on_request</code><span class="sig-paren">(</span><em>msgid</em>, <em>msg</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.on_request" title="Permalink to this definition">¶</a></dt>
<dd><p>Handles a REQUEST command</p>
<p>Messages are formatted like this:
[subcmd(str), {</p>
<blockquote>
<div>...options...</div></blockquote>
<p>}]</p>
<dl class="docutils">
<dt>Subcommands:</dt>
<dd><dl class="first last docutils">
<dt>run - run some callable. Options:</dt>
<dd><dl class="first docutils">
<dt>{</dt>
<dd><p class="first">‘callable’: func or method name (eg. walk),
‘path’: module path (eg. os.path),
‘args’: (optional) list of args,
‘kwargs’: (optional) dict of kwargs,
‘class_args’: (optional) list of args for class</p>
<blockquote>
<div>instantiation,</div></blockquote>
<p class="last">‘class_kwargs’: (optional) dict of kwargs for class,</p>
</dd>
</dl>
<p class="last">}</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="attribute">
<dt id="eventmq.jobmanager.JobManager.outgoing">
<code class="descname">outgoing</code><em class="property"> = None</em><a class="headerlink" href="#eventmq.jobmanager.JobManager.outgoing" title="Permalink to this definition">¶</a></dt>
<dd><p>JobManager starts out by INFORMing the router of it’s existence,
then telling the router that it is READY. The reply will be the unit
of work.</p>
</dd></dl>
<dl class="attribute">
<dt id="eventmq.jobmanager.JobManager.pid_distribution">
<code class="descname">pid_distribution</code><em class="property"> = None</em><a class="headerlink" href="#eventmq.jobmanager.JobManager.pid_distribution" title="Permalink to this definition">¶</a></dt>
<dd><p>Keep track of what pids are servicing our requests
Key: pid, Value: # of jobs completed on the process with that pid</p>
</dd></dl>
<dl class="method">
<dt id="eventmq.jobmanager.JobManager.premature_death">
<code class="descname">premature_death</code><span class="sig-paren">(</span><em>reply</em>, <em>msgid</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.premature_death" title="Permalink to this definition">¶</a></dt>
<dd><p>Worker died before running any jobs</p>
</dd></dl>
<dl class="attribute">
<dt id="eventmq.jobmanager.JobManager.queues">
<code class="descname">queues</code><em class="property"> = None</em><a class="headerlink" href="#eventmq.jobmanager.JobManager.queues" title="Permalink to this definition">¶</a></dt>
<dd><p>List of queues that this job manager is listening on</p>
</dd></dl>
<dl class="method">
<dt id="eventmq.jobmanager.JobManager.send_ready">
<code class="descname">send_ready</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.send_ready" title="Permalink to this definition">¶</a></dt>
<dd><p>send the READY command upstream to indicate that JobManager is ready
for another REQUEST message.</p>
</dd></dl>
<dl class="method">
<dt id="eventmq.jobmanager.JobManager.send_reply">
<code class="descname">send_reply</code><span class="sig-paren">(</span><em>reply</em>, <em>msgid</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.send_reply" title="Permalink to this definition">¶</a></dt>
<dd><p>Sends an REPLY response</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>reply</strong> – Message to send as the reply</li>
<li><strong>msgid</strong> – The unique id that we are acknowledging</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="eventmq.jobmanager.JobManager.total_ready_sent">
<code class="descname">total_ready_sent</code><em class="property"> = None</em><a class="headerlink" href="#eventmq.jobmanager.JobManager.total_ready_sent" title="Permalink to this definition">¶</a></dt>
<dd><p>Running total number of READY messages sent to the broker</p>
</dd></dl>
<dl class="attribute">
<dt id="eventmq.jobmanager.JobManager.total_requests">
<code class="descname">total_requests</code><em class="property"> = None</em><a class="headerlink" href="#eventmq.jobmanager.JobManager.total_requests" title="Permalink to this definition">¶</a></dt>
<dd><p>Running total number of REQUEST messages received on the broker</p>
</dd></dl>
<dl class="method">
<dt id="eventmq.jobmanager.JobManager.worker_death">
<code class="descname">worker_death</code><span class="sig-paren">(</span><em>reply</em>, <em>msgid</em>, <em>death</em>, <em>pid</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.worker_death" title="Permalink to this definition">¶</a></dt>
<dd><p>Worker died of natural causes, ensure its death and
remove from tracking, will be replaced on next heartbeat</p>
</dd></dl>
<dl class="method">
<dt id="eventmq.jobmanager.JobManager.worker_done">
<code class="descname">worker_done</code><span class="sig-paren">(</span><em>reply</em>, <em>msgid</em>, <em>death</em>, <em>pid</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.worker_done" title="Permalink to this definition">¶</a></dt>
<dd><p>Worker finished a job, notify broker of an additional slot opening</p>
</dd></dl>
<dl class="method">
<dt id="eventmq.jobmanager.JobManager.worker_done_with_reply">
<code class="descname">worker_done_with_reply</code><span class="sig-paren">(</span><em>reply</em>, <em>msgid</em>, <em>death</em>, <em>pid</em><span class="sig-paren">)</span><a class="headerlink" href="#eventmq.jobmanager.JobManager.worker_done_with_reply" title="Permalink to this definition">¶</a></dt>
<dd><p>Worker finished a job and requested the return value</p>
</dd></dl>
</dd></dl>
</div>
</div>
<div class="articleComments">
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="poller.html" class="btn btn-neutral float-right" title="poller – Poller" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="exceptions.html" class="btn btn-neutral" title="exceptions – Exceptions" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017, EventMQ Contributors.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
|
