-
Notifications
You must be signed in to change notification settings - Fork 5
/
loggers.py
299 lines (248 loc) · 10.8 KB
/
loggers.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
"""Module for logger settings."""
__all__ = (
"get_logger",
"LOGGING_CONFIG",
"setup_logging",
"SUCCESS",
"TRACE",
)
import copy
import datetime
import functools
import logging
import logging.config
import logging.handlers
import typing
import click
from apps.CORE.custom_types import StrOrNone
from apps.CORE.helpers import get_utc_timezone
from settings import Settings
LOG_FORMAT_AWS = "%(name)s | %(filename)s:%(lineno)s | %(funcName)s | %(levelname)s | %(message)s | (%(asctime)s)"
LOG_FORMAT_EXTENDED = "{levelname} | {name} | {filename}:{lineno} | {funcName} | {message} | ({asctime})"
LOG_FORMAT = "{levelname} | {message} | ({asctime})"
LOG_DATE_TIME_FORMAT_ISO_8601 = "%Y-%m-%dT%H:%M:%S.%fZ" # ISO 8601
LOG_DATE_TIME_FORMAT_WITHOUT_MICROSECONDS = "%Y-%m-%dT%H:%M:%SZ" # ISO 8601 without microseconds
LOG_FILE_FORMAT = click.style(text='╰───📑File "', fg="bright_white", bold=True)
LOG_LINE_FORMAT = click.style(text='", line ', fg="bright_white", bold=True)
SUCCESS = 25
TRACE = 5
LOG_DEFAULT_HANDLER_CLASS = "logging.StreamHandler"
logging.addLevelName(SUCCESS, "SUCCESS")
logging.addLevelName(TRACE, "TRACE")
def _get_main_handler(*, is_third_party: bool = True) -> list[str]:
"""Returns handler name depends on Settings."""
result = ["default_handler"]
if Settings.LOG_USE_COLORS:
result = ["colorful_link_handler"] if Settings.LOG_USE_LINKS and not is_third_party else ["colorful_handler"]
return result
def _get_default_log_format() -> str:
"""Returns log format depends on Settings."""
return LOG_FORMAT_EXTENDED if Settings.LOG_FORMAT_EXTENDED else LOG_FORMAT
def _get_default_formatter() -> dict[str, typing.Any]:
"""Constructs default formatter settings."""
return {
"format": _get_default_log_format(),
"style": "{",
"datefmt": LOG_DATE_TIME_FORMAT_WITHOUT_MICROSECONDS,
"validate": True,
"use_colors": Settings.LOG_USE_COLORS,
}
LOGGING_CONFIG: dict[str, typing.Any] = {
"version": 1,
"disable_existing_loggers": False,
"formatters": {
"colorful_link_formatter": {
"()": "loggers.ColorfulFormatter",
"fmt": _get_default_log_format(),
"style": "{",
"datefmt": LOG_DATE_TIME_FORMAT_ISO_8601,
"validate": True,
"link_format": Settings.LOG_USE_LINKS,
},
"default": _get_default_formatter(),
"access": _get_default_formatter(),
"colorful_formatter": {
"()": "loggers.ColorfulFormatter",
"fmt": _get_default_log_format(),
"style": "{",
"datefmt": LOG_DATE_TIME_FORMAT_ISO_8601,
"link_format": False,
},
},
"handlers": {
"default_handler": {"class": LOG_DEFAULT_HANDLER_CLASS, "level": TRACE, "formatter": "default"},
"colorful_handler": {"class": LOG_DEFAULT_HANDLER_CLASS, "level": TRACE, "formatter": "colorful_formatter"},
"colorful_link_handler": {
"class": LOG_DEFAULT_HANDLER_CLASS,
"level": TRACE,
"formatter": "colorful_link_formatter",
},
},
"root": {"level": Settings.LOG_LEVEL, "handlers": _get_main_handler(is_third_party=False)},
"loggers": {
"asyncio": {"level": "WARNING", "handlers": _get_main_handler(), "propagate": False},
"gunicorn": {"level": "INFO", "handlers": _get_main_handler(), "propagate": False},
"gunicorn.error": {"level": "INFO", "handlers": _get_main_handler(), "propagate": False},
"gunicorn.access": {"level": "INFO", "handlers": _get_main_handler(), "propagate": False},
"uvicorn": {"level": "INFO", "handlers": _get_main_handler(), "propagate": False},
"uvicorn.error": {"level": "INFO", "handlers": _get_main_handler(), "propagate": False},
"uvicorn.access": {"level": "INFO", "handlers": _get_main_handler(), "propagate": False},
"casbin": {"level": "WARNING", "handlers": _get_main_handler(), "propagate": False},
"watchfiles": {"level": "WARNING", "handlers": _get_main_handler(), "propagate": False},
"app.debug": {"level": "DEBUG", "handlers": _get_main_handler(is_third_party=False), "propagate": False},
},
}
class ExtendedLogger(logging.Logger):
"""Custom logger class, with new log methods."""
def trace(self, msg: str, *args, **kwargs) -> None:
"""Add extra `trace` log method."""
if self.isEnabledFor(TRACE):
self._log(TRACE, msg, args, **kwargs, stacklevel=2)
def success(self, msg: str, *args, **kwargs) -> None:
"""Add extra `success` log method."""
if self.isEnabledFor(SUCCESS):
self._log(SUCCESS, msg, args, **kwargs, stacklevel=2)
logging.setLoggerClass(klass=ExtendedLogger)
def setup_logging() -> None:
"""Setup logging from dict configuration object. Setup AWS boto3 logging."""
logging.config.dictConfig(config=LOGGING_CONFIG)
# boto3.set_stream_logger(level=Settings.AWS_LOG_LEVEL, format_string=LOG_FORMAT_AWS)
def get_logger(name: str | None = "app.") -> ExtendedLogger:
"""Get logger instance by name.
Args:
name (str): Name of logger.
Returns:
logging.Logger: Instance of logging.Logger.
Examples:
>>>from loggers import get_logger
>>>logger = get_logger(name=__name__)
>>>logger.debug(msg="Debug message")
"""
return logging.getLogger(name=f"app.{name}")
logger = get_logger(name="root")
class Styler:
"""Style for logs."""
_default_kwargs: typing.ClassVar[list[dict[str, int | str | float | tuple | list | bool]]] = [
{"level": TRACE, "fg": "white"},
{"level": logging.DEBUG, "fg": (121, 85, 72)},
{"level": SUCCESS, "fg": "bright_green"},
{"level": logging.INFO, "fg": "bright_blue"},
{"level": logging.WARNING, "fg": "bright_yellow"},
{"level": logging.ERROR, "fg": "bright_red"},
{"level": logging.CRITICAL, "fg": (126, 87, 194), "bold": True, "underline": True},
]
def __init__(self) -> None:
"""Initialize the colors map with related log level."""
self.colors_map: dict[int, functools.partial] = {}
for kwargs in self.__class__._default_kwargs:
self.set_style(**kwargs) # type: ignore
def get_style(self, level: int) -> functools.partial | typing.Callable:
"""Get Style for logs.
Args:
level (int): Log level.
Returns:
Style for logs.
"""
return self.colors_map.get(level, lambda x: True)
def set_style(
self,
*,
level: int,
fg: tuple[int, int, int] | StrOrNone = None,
bg: tuple[int, int, int] | StrOrNone = None,
bold: bool | None = None,
dim: bool | None = None,
underline: bool | None = None,
overline: bool | None = None,
italic: bool | None = None,
blink: bool | None = None,
reverse: bool | None = None,
strikethrough: bool | None = None,
reset: bool = True,
) -> None:
"""This function sets style for Logs.
Args:
level (int): Log level.
fg (): set foreground color.
bg (): set background color.
bold (): Bold on the text.
dim (): Enable/Disable dim mode. (This is badly supported).
underline (): Enable/Disable underline.
overline (): Enable/Disable overline
italic (): Enable/Disable italic.
blink (): Enable/Disable blinking on the text.
reverse (): Enable/Disable inverse rendering (foreground becomes background and the other way round).
strikethrough (): Enable/Disable striking through text
reset (): by default, a reset-all code is added at the end of the string, which means that styles do not
carry over. This can be disabled to compose styles.
"""
self.colors_map[level] = functools.partial(
click.style,
fg=fg,
bg=bg,
bold=bold,
dim=dim,
underline=underline,
overline=overline,
italic=italic,
blink=blink,
reverse=reverse,
strikethrough=strikethrough,
reset=reset,
)
def _format_time(record: logging.LogRecord, datefmt: str = LOG_DATE_TIME_FORMAT_ISO_8601) -> str:
"""Format datetime to UTC datetime."""
date_time_utc = datetime.datetime.fromtimestamp(record.created, tz=get_utc_timezone())
return datetime.datetime.strftime(date_time_utc, datefmt or LOG_DATE_TIME_FORMAT_ISO_8601)
class ColorfulFormatter(logging.Formatter):
"""Styler for colorful format."""
def __init__(
self,
*,
fmt: str = LOG_FORMAT,
datefmt: str = LOG_DATE_TIME_FORMAT_ISO_8601,
style: typing.Literal["%", "$", "{"] = "{",
validate: bool = True,
# Custom setup
accent_color: str = "bright_cyan",
styler: Styler = None,
link_format: bool = True,
) -> None:
self.accent_color = accent_color
self._styler = styler or Styler()
if link_format:
fmt += f"\n{LOG_FILE_FORMAT}{{pathname}}{LOG_LINE_FORMAT}{{lineno}}"
super().__init__(fmt=fmt, datefmt=datefmt, style=style, validate=validate)
def formatTime( # noqa: N802
self,
record: logging.LogRecord,
datefmt: str | None = LOG_DATE_TIME_FORMAT_ISO_8601,
) -> str:
"""Custom format datetime to UTC datetime."""
return _format_time(record=record, datefmt=datefmt or LOG_DATE_TIME_FORMAT_ISO_8601)
def formatMessage(self, record: logging.LogRecord) -> str: # noqa: N802
"""Custom format message to new format.
Args:
record (str): Log record.
Returns:
formatted message.
"""
record_copy = copy.copy(record)
for key in record_copy.__dict__:
if key == "message":
record_copy.__dict__["message"] = self._styler.get_style(level=record_copy.levelno)(
text=record_copy.message,
)
elif key == "levelname":
separator = " " * (8 - len(record_copy.levelname))
record_copy.__dict__["levelname"] = (
self._styler.get_style(level=record_copy.levelno)(text=record_copy.levelname)
+ click.style(text=":", fg=self.accent_color)
+ separator
)
elif key == "levelno":
continue # set it after iterations (because using in other cases)
else:
record_copy.__dict__[key] = click.style(text=str(record.__dict__[key]), fg=self.accent_color)
record_copy.__dict__["levelno"] = click.style(text=str(record.__dict__["levelno"]), fg=self.accent_color)
return super().formatMessage(record=record_copy)