-
Notifications
You must be signed in to change notification settings - Fork 6
/
logger.py
349 lines (292 loc) · 10.8 KB
/
logger.py
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
# Log Parser for RTI Connext.
#
# Copyright 2016 Real-Time Innovations, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Logger.
The module contains the class to log the messages.
"""
class Logger(object):
"""Class to log the messages.
Attributes:
COLORS: colors to use in the logs
KIND_TO_COLOR: logs messages to color
state (dict): information about the parse process
verbosity (int): verbosity level of the log
inline (bool): show warnings/erros in network logs
ignorePackets (bool): ignore network events
showColors (bool): show colors in the log
formatDevice (:obj:`FormatDevice`): format device to print the logs
highlight (:obj:`compiled re`): show in bold regex matched logs
onlyIf (:obj:`compiled re`): show only regex matched logs
"""
def __init__(self, state):
"""Constructor of the class."""
self._COLORS = {
'RED': '\033[91m',
'GREEN': '\033[92m',
'YELLOW': '\033[93m',
'BLUE': '\033[94m',
'MAGENTA': '\033[95m',
'BOLD': '\033[1m',
'FAINT': '\033[2m',
'ITALIC': '\033[3m',
'UNDERLINE': '\033[4m',
'END': '\033[0m',
}
self._KIND_TO_COLOR = {
'WARNING': 'YELLOW|ITALIC',
'ERROR': 'RED|BOLD',
'IMPORTANT': 'BOLD'
}
self._state = state
self._verbosity = 0
self._inline = True
self._ignorePackets = False
self._showColors = False
self._formatDevice = self._state['format_device']
self._highlight = None
self._onlyIf = None
@property
def verbosity(self):
"""Get the verbosity level.
Returns:
int: verbosity level of the log
"""
return self._verbosity
@verbosity.setter
def verbosity(self, value):
"""Set the verbosity level.
Args:
value (int): verbosity level
"""
self._verbosity = value
@property
def inline(self):
"""Get if show warnigns and errors in network logs.
Returns:
bool: True if warnings are shown
"""
return self._inline
@inline.setter
def inline(self, value):
"""Enable/disable show warnings and errors in network logs.
Args:
value (bool): show inline warnings and errors
"""
self._inline = value
@property
def ignorePackets(self):
"""Get if the network logs are shown in the log.
Returns:
bool: True if the network logs are ignored
"""
return self._ignorePackets
@ignorePackets.setter
def ignorePackets(self, value):
"""Enable/disable the network logs are shown in the log.
Args:
value (bool): ignore network logs
"""
self._ignorePackets = value
@property
def colors(self):
"""Get if coloured logs are activated.
Returns:
bool: True if coloured logs are activated
"""
return self._showColors
@colors.setter
def colors(self, value):
"""Enable/disable coloured logs.
Args:
value (bool): show colors
"""
self._showColors = value
@property
def highlight(self):
"""Get the regex to show in bold regex matched logs.
Returns:
:obj:`compiled re`: the set regex to match logs
"""
return self._highlight
@highlight.setter
def highlight(self, value):
"""Add a regex to show in bold regex matched logs.
Args:
value (:obj:`compiled re`): regex to match logs
"""
self._highlight = value
@property
def onlyIf(self):
"""Show only log messages that match the regex.
Returns:
:obj:`compiled re`: the set regex to match logs
"""
return self._onlyIf
@onlyIf.setter
def onlyIf(self, value):
"""Show only log messages that match the regex.
Args:
value (:obj:`compiled re`): regex to match logs
"""
self._onlyIf = value
def _log(self, content, level):
"""Log the given message.
Args:
content (dict): the content argument is a dictionary with at
least 'description' item.
The optional items are:
+ kind: the kind or remark for the message.
+ timestamp: the timestamp of the message.
+ input_line: the current input line.
+ output_line: the current output line.
+ inout: [packets-only] 'in' if it's input packet,
'out' otherwise.
+ remote: [packets-only] the remote address of
the sender/receiver.
+ entity: [packets-only] the local entity sending/receiving.
level (int): verbosity level of the log message
"""
if self._verbosity < level:
return
# Add the clock if available
if 'clocks' in self._state and self._state['clocks'][1]:
content['timestamp'] = \
" %s " % self._state['clocks'][1].isoformat()
# Add the current line
content['input_line'] = self._state['input_line']
# This message count
content['output_line'] = self._state['output_line'] + 1
# Apply the filter
if self.onlyIf and not Logger._dict_regex_search(content, self.onlyIf):
return
# Highlight the message if match
if self.highlight and Logger._dict_regex_search(
content, self.highlight):
content['kind'] = content.get('kind', "") + "|IMPORTANT"
# Apply color if specified
if self._showColors:
color = ""
for kind in filter(None, content.get('kind', '').split("|")):
for subkind in self._KIND_TO_COLOR[kind].split("|"):
color += self._COLORS[subkind]
if color:
content['description'] = color + content['description'] + \
self._COLORS['END']
# Write the message
self._formatDevice.write_message(content, self._state)
def recv(self, addr, entity, text, level=0):
"""Log a received packet.
Args:
addr (str): source address of the package
entity (str): source entity of the package
text (str): description
level (int,optional): verbosity level of the log message
"""
if self._ignorePackets:
return
content = {'description': text, 'remote': addr, 'entity': entity,
'inout': 'in'}
self._log(content, level)
def send(self, addr, entity, text, level=0):
"""Log a sent packet.
Args:
addr (str): destination address of the package
entity (str): destination entity of the package
text (str): description
level (int,optional): verbosity level of the log message
"""
if self._ignorePackets:
return
content = {'description': text, 'remote': addr, 'entity': entity,
'inout': 'out'}
self._log(content, level)
def process(self, addr, entity, text, level=0):
"""Log a processed packet.
Args:
addr (str): source address of the package
entity (str): source entity of the package
text (str): description
level (int,optional): verbosity level of the log message
"""
if self._ignorePackets:
return
content = {'description': text, 'remote': addr, 'entity': entity}
self._log(content, level)
def cfg(self, text, level=0):
"""Log a configuration message.
Args:
text (str): description
level (int,optional): verbosity level of the log message
"""
if self._verbosity < level:
return
self._state['config'].add(text)
def event(self, text, level=0):
"""Log an application event.
Args:
text (str): description
level (int,optional): verbosity level of the log message
"""
content = {'description': text}
self._log(content, level)
def warning(self, text, level=0):
"""Log a warning message.
Args:
text (str): description
level (int,optional): verbosity level of the log message
"""
if self._verbosity < level:
return
self._state['warnings'].add(text)
if self._inline:
content = {'description': "Warning: " + text, 'kind': 'WARNING'}
self._log(content, level)
def error(self, text, level=0):
"""Log an error.
Args:
text (str): description
level (int,optional): verbosity level of the log message
"""
if self._verbosity < level:
return
self._state['errors'].add(text)
if self._inline:
content = {'description': "Error: " + text, 'kind': 'ERROR'}
self._log(content, level)
@staticmethod
def _dict_regex_search(content, regex):
"""Apply the regex over all the fields of the content.
Args:
content (dict): the content argument is a dictionary with at
least 'description' item.
The optional items are:
+ kind: the kind or remark for the message.
+ timestamp: the timestamp of the message.
+ input_line: the current input line.
+ output_line: the current output line.
+ inout: [packets-only] 'in' if it's input packet,
'out' otherwise.
+ remote: [packets-only] the remote address of
the sender/receiver.
+ entity: [packets-only] the local entity sending/receiving.
regex (:obj:`compiled re`): regex to apply
Returns:
bool: True if the regex match with at least one field of content
"""
match = False
for field in content:
if isinstance(content[field], str):
match = match if match else regex.search(content[field])
return match