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
|
from __future__ import annotations
import logging
import multiprocessing.synchronize as ms
import os
import pickle
import queue
import time
from multiprocessing import Event
from multiprocessing.queues import Queue
from typing import TYPE_CHECKING, Literal, Optional, Tuple, Union, cast
import typeguard
from parsl.log_utils import set_file_logger
from parsl.monitoring.errors import MonitoringHubStartError
from parsl.monitoring.radios.multiprocessing import MultiprocessingQueueRadioSender
from parsl.monitoring.router import router_starter
from parsl.monitoring.types import TaggedMonitoringMessage
from parsl.multiprocessing import ForkProcess, SizedQueue
from parsl.process_loggers import wrap_with_logs
from parsl.utils import RepresentationMixin, setproctitle
_db_manager_excepts: Optional[Exception]
try:
from parsl.monitoring.db_manager import dbm_starter
except Exception as e:
_db_manager_excepts = e
else:
_db_manager_excepts = None
logger = logging.getLogger(__name__)
@typeguard.typechecked
class MonitoringHub(RepresentationMixin):
def __init__(self,
hub_address: str,
hub_port: Optional[int] = None,
hub_port_range: Tuple[int, int] = (55050, 56000),
workflow_name: Optional[str] = None,
workflow_version: Optional[str] = None,
logging_endpoint: Optional[str] = None,
monitoring_debug: bool = False,
resource_monitoring_enabled: bool = True,
resource_monitoring_interval: float = 30): # in seconds
"""
Parameters
----------
hub_address : str
The ip address at which the workers will be able to reach the Hub.
hub_port : int
The UDP port to which workers will be able to deliver messages to
the monitoring router.
Note that despite the similar name, this is not related to
hub_port_range.
Default: None
hub_port_range : tuple(int, int)
The port range for a ZMQ channel from an executor process
(for example, the interchange in the High Throughput Executor)
to deliver monitoring messages to the monitoring router.
Note that despite the similar name, this is not related to hub_port.
Default: (55050, 56000)
workflow_name : str
The name for the workflow. Default to the name of the parsl script
workflow_version : str
The version of the workflow. Default to the beginning datetime of the parsl script
logging_endpoint : str
The database connection url for monitoring to log the information.
These URLs follow RFC-1738, and can include username, password, hostname, database name.
Default: sqlite, in the configured run_dir.
monitoring_debug : Bool
Enable monitoring debug logging. Default: False
resource_monitoring_enabled : boolean
Set this field to True to enable logging of information from the worker side.
This will include environment information such as start time, hostname and block id,
along with periodic resource usage of each task. Default: True
resource_monitoring_interval : float
The time interval, in seconds, at which the monitoring records the resource usage of each task.
If set to 0, only start and end information will be logged, and no periodic monitoring will
be made.
Default: 30 seconds
"""
if _db_manager_excepts:
raise _db_manager_excepts
self.hub_address = hub_address
self.hub_port = hub_port
self.hub_port_range = hub_port_range
self.logging_endpoint = logging_endpoint
self.monitoring_debug = monitoring_debug
self.workflow_name = workflow_name
self.workflow_version = workflow_version
self.resource_monitoring_enabled = resource_monitoring_enabled
self.resource_monitoring_interval = resource_monitoring_interval
def start(self, dfk_run_dir: str, config_run_dir: Union[str, os.PathLike]) -> None:
logger.debug("Starting MonitoringHub")
if self.logging_endpoint is None:
self.logging_endpoint = f"sqlite:///{os.fspath(config_run_dir)}/monitoring.db"
os.makedirs(dfk_run_dir, exist_ok=True)
self.monitoring_hub_active = True
# This annotation is incompatible with typeguard 4.x instrumentation
# of local variables: Queue is not subscriptable at runtime, as far
# as typeguard is concerned. The more general Queue annotation works,
# but does not restrict the contents of the Queue. Using TYPE_CHECKING
# here allows the stricter definition to be seen by mypy, and the
# simpler definition to be seen by typeguard. Hopefully at some point
# in the future, Queue will allow runtime subscripts.
if TYPE_CHECKING:
comm_q: Queue[Union[Tuple[int, int], str]]
else:
comm_q: Queue
comm_q = SizedQueue(maxsize=10)
self.exception_q: Queue[Tuple[str, str]]
self.exception_q = SizedQueue(maxsize=10)
self.resource_msgs: Queue[Union[TaggedMonitoringMessage, Literal["STOP"]]]
self.resource_msgs = SizedQueue()
self.router_exit_event: ms.Event
self.router_exit_event = Event()
self.router_proc = ForkProcess(target=router_starter,
kwargs={"comm_q": comm_q,
"exception_q": self.exception_q,
"resource_msgs": self.resource_msgs,
"exit_event": self.router_exit_event,
"hub_address": self.hub_address,
"udp_port": self.hub_port,
"zmq_port_range": self.hub_port_range,
"run_dir": dfk_run_dir,
"logging_level": logging.DEBUG if self.monitoring_debug else logging.INFO,
},
name="Monitoring-Router-Process",
daemon=True,
)
self.router_proc.start()
self.dbm_proc = ForkProcess(target=dbm_starter,
args=(self.exception_q, self.resource_msgs,),
kwargs={"run_dir": dfk_run_dir,
"logging_level": logging.DEBUG if self.monitoring_debug else logging.INFO,
"db_url": self.logging_endpoint,
},
name="Monitoring-DBM-Process",
daemon=True,
)
self.dbm_proc.start()
logger.info("Started the router process %s and DBM process %s", self.router_proc.pid, self.dbm_proc.pid)
self.filesystem_proc = ForkProcess(target=filesystem_receiver,
args=(self.resource_msgs, dfk_run_dir),
name="Monitoring-Filesystem-Process",
daemon=True
)
self.filesystem_proc.start()
logger.info("Started filesystem radio receiver process %s", self.filesystem_proc.pid)
self.radio = MultiprocessingQueueRadioSender(self.resource_msgs)
try:
comm_q_result = comm_q.get(block=True, timeout=120)
comm_q.close()
comm_q.join_thread()
except queue.Empty:
logger.error("Hub has not completed initialization in 120s. Aborting")
raise MonitoringHubStartError()
if isinstance(comm_q_result, str):
logger.error("MonitoringRouter sent an error message: %s", comm_q_result)
raise RuntimeError(f"MonitoringRouter failed to start: {comm_q_result}")
udp_port, zmq_port = comm_q_result
self.monitoring_hub_url = "udp://{}:{}".format(self.hub_address, udp_port)
logger.info("Monitoring Hub initialized")
self.hub_zmq_port = zmq_port
def send(self, message: TaggedMonitoringMessage) -> None:
logger.debug("Sending message type %s", message[0])
self.radio.send(message)
def close(self) -> None:
logger.info("Terminating Monitoring Hub")
exception_msgs = []
while True:
try:
exception_msgs.append(self.exception_q.get(block=False))
logger.error("There was a queued exception (Either router or DBM process got exception much earlier?)")
except queue.Empty:
break
if self.monitoring_hub_active:
self.monitoring_hub_active = False
if exception_msgs:
for exception_msg in exception_msgs:
logger.error(
"%s process delivered an exception: %s. Terminating all monitoring processes immediately.",
exception_msg[0],
exception_msg[1]
)
self.router_proc.terminate()
self.dbm_proc.terminate()
self.filesystem_proc.terminate()
logger.info("Setting router termination event")
self.router_exit_event.set()
logger.info("Waiting for router to terminate")
self.router_proc.join()
self.router_proc.close()
logger.debug("Finished waiting for router termination")
if len(exception_msgs) == 0:
logger.debug("Sending STOP to DBM")
self.resource_msgs.put("STOP")
else:
logger.debug("Not sending STOP to DBM, because there were DBM exceptions")
logger.debug("Waiting for DB termination")
self.dbm_proc.join()
self.dbm_proc.close()
logger.debug("Finished waiting for DBM termination")
# should this be message based? it probably doesn't need to be if
# we believe we've received all messages
logger.info("Terminating filesystem radio receiver process")
self.filesystem_proc.terminate()
self.filesystem_proc.join()
self.filesystem_proc.close()
logger.info("Closing monitoring multiprocessing queues")
self.exception_q.close()
self.exception_q.join_thread()
self.resource_msgs.close()
self.resource_msgs.join_thread()
logger.info("Closed monitoring multiprocessing queues")
@wrap_with_logs
def filesystem_receiver(q: Queue[TaggedMonitoringMessage], run_dir: str) -> None:
logger = set_file_logger(f"{run_dir}/monitoring_filesystem_radio.log",
name="monitoring_filesystem_radio",
level=logging.INFO)
logger.info("Starting filesystem radio receiver")
setproctitle("parsl: monitoring filesystem receiver")
base_path = f"{run_dir}/monitor-fs-radio/"
tmp_dir = f"{base_path}/tmp/"
new_dir = f"{base_path}/new/"
logger.debug("Creating new and tmp paths under %s", base_path)
target_radio = MultiprocessingQueueRadioSender(q)
os.makedirs(tmp_dir, exist_ok=True)
os.makedirs(new_dir, exist_ok=True)
while True: # this loop will end on process termination
logger.debug("Start filesystem radio receiver loop")
# iterate over files in new_dir
for filename in os.listdir(new_dir):
try:
logger.info("Processing filesystem radio file %s", filename)
full_path_filename = f"{new_dir}/{filename}"
with open(full_path_filename, "rb") as f:
message = pickle.load(f)
logger.debug("Message received is: %s", message)
assert isinstance(message, tuple)
target_radio.send(cast(TaggedMonitoringMessage, message))
os.remove(full_path_filename)
except Exception:
logger.exception("Exception processing %s - probably will be retried next iteration", filename)
time.sleep(1) # whats a good time for this poll?
|
