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
|
#
# A library to manage ARCFIRE experiments
#
# Copyright (C) 2017-2018 Nextworks S.r.l.
# Copyright (C) 2017-2018 imec
#
# Sander Vrijders <sander.vrijders@ugent.be>
# Dimitri Staessens <dimitri.staessens@ugent.be>
# Vincenzo Maffione <v.maffione@nextworks.it>
# Marco Capitani <m.capitani@nextworks.it>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., http://www.fsf.org/about/contact/.
#
import logging
import logging.handlers
import multiprocessing
import sys
import time
DEBUG = logging.DEBUG
INFO = logging.INFO
WARNING = logging.WARNING
ERROR = logging.ERROR
CRITICAL = logging.CRITICAL
loggers_set = set()
mq = multiprocessing.Queue()
logging_listener = None
try:
from logging.handlers import QueueHandler
except ImportError:
# We are in python2 code
class QueueHandler(logging.Handler):
"""
This handler sends events to a queue. Typically, it would be used
together with a multiprocessing Queue to centralise logging to file
in one process (in a multi-process application), so as to avoid file
write contention between processes.
This code is new in Python 3.2, but this class can be copy pasted into
user code for use with earlier Python versions.
"""
# Copy-pasted as per above docstring from logging
def __init__(self, queue):
logging.Handler.__init__(self)
self.queue = queue
def enqueue(self, record):
self.queue.put_nowait(record)
def prepare(self, record):
self.format(record)
record.msg = record.message
record.args = None
record.exc_info = None
return record
def emit(self, record):
try:
self.enqueue(self.prepare(record))
except Exception:
self.handleError(record)
try:
from logging.handlers import QueueListener
except ImportError:
# We are in python2 code
import threading
try:
import Queue
except ImportError:
# Make it pythonX with 3.0 <= X <3.2
import queue as Queue
class QueueListener(object):
"""
This class implements an internal threaded listener which watches for
LogRecords being added to a queue, removes them and passes them to a
list of handlers for processing.
"""
# Also copy-pasted
_sentinel = None
def __init__(self, queue, respect_handler_level=False, *handlers):
self.queue = queue
self.handlers = handlers
self._stop = threading.Event()
self._thread = None
self.respect_handler_level = respect_handler_level
def dequeue(self, block):
return self.queue.get(block)
def start(self):
self._thread = t = threading.Thread(target=self._monitor)
t.setDaemon(True)
t.start()
def prepare(self , record):
return record
def handle(self, record):
record = self.prepare(record)
for handler in self.handlers:
if not self.respect_handler_level:
process = True
else:
process = record.levelno >= handler.level
if process:
handler.handle(record)
def _monitor(self):
q = self.queue
has_task_done = hasattr(q, 'task_done')
while not self._stop.isSet():
try:
record = self.dequeue(True)
if record is self._sentinel:
break
self.handle(record)
if has_task_done:
q.task_done()
except Queue.Empty:
pass
# There might still be records in the queue.
while True:
try:
record = self.dequeue(False)
if record is self._sentinel:
break
self.handle(record)
if has_task_done:
q.task_done()
except Queue.Empty:
break
def enqueue_sentinel(self):
self.queue.put_nowait(self._sentinel)
def stop(self):
self._stop.set()
self.enqueue_sentinel()
self._thread.join()
self._thread = None
class RumbaFormatter(logging.Formatter):
"""
The `logging.Formatter` subclass used by Rumba
"""
level_name_table = {
'CRITICAL': 'CRT',
'ERROR': 'ERR',
'WARNING': 'WRN',
'INFO': 'INF',
'DEBUG': 'DBG',
# handlers beyond the first will get the
# modified levelname
'CRT': 'CRT',
'ERR': 'ERR',
'WRN': 'WRN',
'INF': 'INF',
'DBG': 'DBG'
}
def __init__(self):
super(RumbaFormatter, self).__init__(
fmt='%(asctime)s | %(levelname)3.3s | '
'%(name)11.11s | %(message)s',
datefmt='%H:%M:%S')
def format(self, record):
record.name = record.name.split('.')[-1]
record.levelname = self.level_name_table[record.levelname]
return super(RumbaFormatter, self).format(record)
def setup():
"""Configures the logging framework with default values."""
global mq
queue_handler = QueueHandler(mq)
queue_handler.setLevel(logging.DEBUG)
logging.basicConfig(handlers=[queue_handler], level=logging.DEBUG)
logging.getLogger('').setLevel(logging.ERROR)
logging.getLogger('rumba').setLevel(logging.INFO)
# Used for the first call, in order to configure logging
def _get_logger_with_setup(name):
setup()
# Swap _get_logger implementation to the setup-less version.
global _get_logger
_get_logger = _get_logger_without_setup
return logging.getLogger(name)
# Then this one is used.
def _get_logger_without_setup(name):
return logging.getLogger(name)
_get_logger = _get_logger_with_setup
def get_logger(name):
"""
Returns the logger named `name`.
`name` should be the module name, for consistency.
If setup has not been called yet, it will call it first.
:param name: the name of the desired logger
:type name: `str`
:return: The logger
"""
return _get_logger(name)
def set_logging_level(level, name=None):
"""
Set the current logging level to `level` for the logger named `name`.
If `name` is not specified, sets the logging level for all rumba loggers.
:param level: the desired logging level, in string or int form.
:type level: `str` or `int`
:param name: The name of the logger to configure
:type name: `str`
.. note:: Accepted levels are:
- DEBUG == 10,
- INFO == 20,
- WARNING == 30,
- ERROR == 40,
- CRITICAL == 50,
- NOTSET == 0 (resets the logger: its level is set to
the default or its parents' level)
"""
if name is None:
if level == 'NOTSET' or level == 0:
set_logging_level(logging.INFO)
return
name = 'rumba'
if (level == 'NOTSET' or level == 0) and name == '':
set_logging_level(logging.ERROR, '')
return
logger = get_logger(name)
loggers_set.add(logger)
logger.setLevel(level)
def reset_logging_level():
"""
Resets the current logging level of all loggers to the default.
For the Rumba library the default is INFO.
"""
# Un-sets every logger previously set
for logger in loggers_set:
logger.setLevel(logging.NOTSET)
set_logging_level(logging.INFO)
set_logging_level(logging.ERROR, '')
def flush_log():
"""
Flush the log.
"""
time.sleep(0.1)
def flush_and_kill_logging():
"""
Flushes all queued log messages and stops the logging facility.
Since the logging is done by a daemon thread, log entries might be lost
if execution is interrupted abruptly. Call this method to make sure
this does not happen.
"""
global logging_listener
logging_listener.stop()
class LogOptions(object):
"""Class holding the logging configuration"""
def __init__(self):
global logging_listener
global mq
logging_listener = QueueListener(mq)
self.log_to_console()
logging_listener.start()
@staticmethod
def _get_handlers():
global logging_listener
return tuple(logging_listener.handlers)
@staticmethod
def _set_handlers(*handlers):
global logging_listener
logging_listener.handlers = handlers
def _add_handler(self, handler):
handler.setFormatter(RumbaFormatter())
handler.setLevel(DEBUG)
handlers = self._get_handlers() + (handler,)
self._set_handlers(*handlers)
return self
def log_to_file(self, path='rumba.log'):
"""
Set the logging framework to log to file on top of the other
logging facilities.
:param path: logging file filename
:type path: `str`
:return: this `.LogOptions` instance
"""
new_handler = logging.handlers.RotatingFileHandler(path)
return self._add_handler(new_handler)
def reset_logging(self):
"""
Disable all logging facilities
:return: this `.LogOptions` instance
"""
self._set_handlers(*tuple())
return self
def log_to_console(self):
"""
Set the logging framework to log to stdout on top of the
other configured logging facilities
:return: this `.LogOptions` instance
"""
new_handler = logging.StreamHandler(sys.stdout)
return self._add_handler(new_handler)
options = LogOptions() # module instance used for configuration
|