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
|
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You 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.
"""
Mix-ins and functions for logging, supporting multiple backends (such as SQL) and consistent
formatting.
"""
import logging
from logging import handlers as logging_handlers
# NullHandler doesn't exist in < 27. this workaround is from
# http://docs.python.org/release/2.6/library/logging.html#configuring-logging-for-a-library
try:
from logging import NullHandler # pylint: disable=unused-import
except ImportError:
class NullHandler(logging.Handler):
def emit(self, record):
pass
from datetime import datetime
TASK_LOGGER_NAME = 'aria.executions.task'
_base_logger = logging.getLogger('aria')
class LoggerMixin(object):
"""
Provides logging functionality to a class.
:ivar logger_name: logger name; default to the class name
:ivar logger_level: logger level; defaults to ``logging.DEBUG``
:ivar base_logger: child loggers are created from this; defaults to the root logger
"""
logger_name = None
logger_level = logging.DEBUG
def __init__(self, *args, **kwargs):
self.logger_name = self.logger_name or self.__class__.__name__
self.logger = logging.getLogger('{0}.{1}'.format(_base_logger.name, self.logger_name))
# Set the logger handler of any object derived from LoggerMixing to NullHandler.
# This is since the absence of a handler shows up while using the CLI in the form of:
# `No handlers could be found for logger "..."`.
self.logger.addHandler(NullHandler())
self.logger.setLevel(self.logger_level)
super(LoggerMixin, self).__init__(*args, **kwargs)
@classmethod
def with_logger(
cls,
logger_name=None,
logger_level=logging.DEBUG,
base_logger=logging.getLogger(),
**kwargs):
"""
Set the logger used by the consuming class.
"""
cls.logger_name = logger_name
cls.logger_level = logger_level
cls.base_logger = base_logger
return cls(**kwargs)
def __getstate__(self):
obj_dict = vars(self).copy()
del obj_dict['logger']
return obj_dict
def __setstate__(self, obj_dict):
vars(self).update(
logger=logging.getLogger('{0}.{1}'.format(_base_logger.name, obj_dict['logger_name'])),
**obj_dict)
def create_logger(logger=_base_logger, handlers=(), **configs):
"""
:param logger: logger name; defaults to ARIA logger
:type logger: logging.Logger
:param handlers: logger handlers
:type handlers: []
:param configs: logger configurations
:type configs: []
:return: logger
"""
logger.handlers = []
for handler in handlers:
logger.addHandler(handler)
logger.setLevel(configs.get('level', logging.DEBUG))
logger.debug('Logger {0} configured'.format(logger.name))
return logger
def create_console_log_handler(level=logging.DEBUG, formatter=None):
"""
:param level:
:param formatter:
"""
console = logging.StreamHandler()
console.setLevel(level)
console.formatter = formatter or _DefaultConsoleFormat()
return console
def create_sqla_log_handler(model, log_cls, execution_id, level=logging.DEBUG):
# This is needed since the engine and session are entirely new we need to reflect the db
# schema of the logging model into the engine and session.
return _SQLAlchemyHandler(model=model, log_cls=log_cls, execution_id=execution_id, level=level)
class _DefaultConsoleFormat(logging.Formatter):
"""
Info level log format: ``%(message)s``.
Every other log level is formatted: ``%(levelname)s: %(message)s``.
"""
def format(self, record):
try:
if hasattr(record, 'prefix'):
self._fmt = '<%(asctime)s: [%(levelname)s] @%(prefix)s> %(message)s'
else:
self._fmt = '<%(asctime)s: [%(levelname)s]> %(message)s'
except AttributeError:
return record.message
return logging.Formatter.format(self, record)
def create_file_log_handler(
file_path,
level=logging.DEBUG,
max_bytes=5 * 1000 * 1024,
backup_count=10,
formatter=None):
"""
Create a :class:`logging.handlers.RotatingFileHandler`.
"""
rotating_file = logging_handlers.RotatingFileHandler(
filename=file_path,
maxBytes=max_bytes,
backupCount=backup_count,
delay=True,
)
rotating_file.setLevel(level)
rotating_file.formatter = formatter or _default_file_formatter
return rotating_file
class _SQLAlchemyHandler(logging.Handler):
def __init__(self, model, log_cls, execution_id, **kwargs):
logging.Handler.__init__(self, **kwargs)
self._model = model
self._cls = log_cls
self._execution_id = execution_id
def emit(self, record):
created_at = datetime.strptime(logging.Formatter('%(asctime)s').formatTime(record),
'%Y-%m-%d %H:%M:%S,%f')
log = self._cls(
execution_fk=self._execution_id,
task_fk=record.task_id,
level=record.levelname,
msg=str(record.msg),
created_at=created_at,
# Not mandatory.
traceback=getattr(record, 'traceback', None)
)
self._model.log.put(log)
_default_file_formatter = logging.Formatter(
'%(asctime)s [%(name)s:%(levelname)s] %(message)s <%(pathname)s:%(lineno)d>')
|
