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
|
Workflow events
===============
Events are emitted when executing a workflow. The event fields are described in
the `ewoksutils <https://ewoksutils.readthedocs.io/>`_ documentation.
Use an Ewoks event handler
--------------------------
If you want to record workflow events you have to specify one or more event handlers when executing a workflow:
.. code:: python
from ewokscore import execute_graph
execinfo = {
"job_id": "1234",
"handlers": [
{
"class": "ewokscore.events.handlers.Sqlite3EwoksEventHandler",
"asynchronous": True,
"arguments": [{"name": "uri",
"value": "file:/tmp/ewoks_event.db"}],
}
],
}
results = execute_graph("/path/to/file.json", execinfo=execinfo)
The optional `asynchronous` argument should be used for handlers with slow connections. Setting this
argument to `True` will send events to the handlers in a separate thread.
Define an Ewoks event handler
-----------------------------
You can use any handler derived from `logging.Handler` as an Ewoks event handler. For example if you
have a `Connection` class with a constructor that accepts two arguments, you can define an ewoks
event handler as follows:
.. code:: python
# ./myproject/handlers.py
from ewokscore.logging_utils.handlers import ConnectionHandler
from ewokscore.handlers import send_events
from ewokscore.events import EwoksEventHandlerMixIn
class MyHandler(EwoksEventHandlerMixIn, ConnectionHandler):
def _connect(self, uri:str, param1:int, timeout=1) -> None:
self._connection = Connection(uri, param1)
self._fields = send_events.FIELDS
def _disconnect(self) -> None:
del self._connection
self._connection = None
def _send_serialized_record(self, srecord):
self._connection.send(srecord)
def _serialize_record(self, record):
return {
field: self.get_value(record, field, None) for field in self._fields
}
`ConnectionHandler` is an abstract python logging handler which can be used for convenience.
To use this example handler
.. code:: python
from ewokscore import execute_graph
execinfo = {
"job_id": "1234",
"handlers": [
{
"class": "myproject.handlers.MyHandler",
"arguments": [{"name": "uri",
"value": "file:/tmp/ewoks_event.db"},
{"name": "param1", "value": 10}],
}
],
}
results = execute_graph("/path/to/file.json", execinfo=execinfo)
|
