john/room_control
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

greatly improved from implementing the "logging endgame" notebook

Browse Source
This commit is contained in:
John Lancaster
2024-04-29 23:39:58 -05:00
parent 866b4a1cfb
commit fe0b3057ed
4 changed files with 129 additions and 91 deletions
Download Patch File Download Diff File Expand all files Collapse all files

158
console.py
View File

@@ -3,6 +3,7 @@ import logging.config
import re
from abc import ABC
from dataclasses import asdict, dataclass
from typing import Optional
from appdaemon.logging import AppNameFormatter
from rich.console import Console
@@ -10,18 +11,6 @@ from rich.highlighter import RegexHighlighter
from rich.logging import RichHandler
from rich.theme import Theme
class RCHighlighter(RegexHighlighter):
highlights = [
r'(?P<light>(light|switch)\.\w+)',
r'(?P<time>\d+:\d+:\d+)',
r'(?P<z2m>zigbee2mqtt/)',
r'(?P<sensor>binary_sensor\.\w+)',
# r"'state': '(?P<on>on)|(?P<off>off)'"
r'(?P<true>True)|(?P<false>False)',
]
console = Console(
width=100,
theme=Theme(
@@ -45,17 +34,52 @@ console = Console(
)
class RCHighlighter(RegexHighlighter):
highlights = [
r'(?P<light>(light|switch)\.\w+)',
r'(?P<time>\d+:\d+:\d+)',
r'(?P<z2m>zigbee2mqtt/)',
r'(?P<sensor>binary_sensor\.\w+)',
# r"'state': '(?P<on>on)|(?P<off>off)'"
r'(?P<true>True)|(?P<false>False)',
]
RICH_HANDLER_CFG = {
'()': 'rich.logging.RichHandler',
'markup': True,
'show_path': False,
# 'show_time': False,
'omit_repeated_times': False,
'console': console,
'highlighter': RCHighlighter(),
}
class ContextSettingFilter(logging.Filter, ABC):
def filter(self, record: logging.LogRecord) -> logging.LogRecord:
for name, val in asdict(self).items():
setattr(record, name, val)
if val is not None:
setattr(record, name, val)
return record
@dataclass
class RoomControllerFilter(ContextSettingFilter):
room: str
component: str
class RoomFilter(logging.Filter):
"""Used to filter out messages that have a component field because they will have already been printed by their respective logger."""
def filter(self, record: logging.LogRecord) -> bool:
return getattr(record, 'component', None) is None
# @dataclass
# class RoomControllerFilter(ContextSettingFilter):
# room: str
# component: Optional[str] = None
# class RoomControllerFormatter(logging.Formatter):
# def format(self, record: logging.LogRecord):
# return super().format(record)
class UnMarkupFilter(logging.Filter):
@@ -66,71 +90,73 @@ class UnMarkupFilter(logging.Filter):
return record
def create_rich_logging_dict(parent_room: str, typ: str = None):
logger_name = f'AppDaemon.{parent_room}'
if typ is not None:
logger_name += f'.{typ}'
fmt = '[room]{room}[/] [component]{component}[/] {message}'
else:
fmt = '[room]{room}[/] {message}'
LOG_CFG = {
def room_logging_config(name: str):
return {
'version': 1,
'disable_existing_loggers': False,
'filters': {
logger_name: {
'()': 'console.RoomControllerFilter',
'room': parent_room,
'component': typ,
},
'room': {'()': 'console.RoomFilter'},
'unmarkup': {'()': 'console.UnMarkupFilter'},
},
'formatters': {
'rich': {'style': '{', 'format': fmt, 'datefmt': '%H:%M:%S.%f'},
'err': {
'rich_room': {
'style': '{',
'format': '{asctime}.{msecs:03.0f} {levelname:8} {room:>10} {component:<9} {message}',
'format': '[room]{room}[/] {message}',
'datefmt': '%H:%M:%S.%f',
},
'file': {
'style': '{',
'format': '{asctime}.{msecs:03.0f} {levelname:8} {name}: {message}',
'datefmt': '%Y-%m-%d %H:%M:%S',
# 'datefmt': '%H:%M:%S.%f',
},
},
'handlers': {
logger_name: {
'filters': [logger_name],
'formatter': 'rich',
'()': 'rich.logging.RichHandler',
'markup': True,
'show_path': False,
# 'show_time': False,
'omit_repeated_times': False,
'console': console,
'highlighter': RCHighlighter(),
},
'stderr': {
'filters': [logger_name, 'unmarkup'],
'formatter': 'err',
'class': 'logging.StreamHandler',
'stream': 'ext://sys.stderr',
},
'rich_room': {'formatter': 'rich_room', 'filters': ['room'], **RICH_HANDLER_CFG},
'file': {
'filters': [logger_name, 'unmarkup'],
'filters': ['unmarkup'],
'formatter': 'file',
'class': 'logging.handlers.RotatingFileHandler',
'filename': f'/logs/{parent_room}.log',
'formatter': 'err',
# 'class': 'logging.FileHandler',
'filename': f'/logs/{name}.log',
'mode': 'w',
'maxBytes': 10**6,
'maxBytes': 1000000,
'backupCount': 3,
},
},
'loggers': {
logger_name: {
f'AppDaemon.{name}': {
'level': 'INFO',
'propagate': False,
'handlers': [
logger_name,
'file',
# 'stderr'
],
'handlers': ['rich_room', 'file'],
},
},
}
def component_logging_config(parent_room: str, component: str):
logger_name = f'AppDaemon.{parent_room}.{component}'
LOG_CFG = {
'version': 1,
'disable_existing_loggers': False,
'formatters': {
'rich_component': {
'style': '{',
'format': '[room]{room}[/] [component]{component}[/] {message}',
'datefmt': '%H:%M:%S.%f',
},
},
'handlers': {
'rich_component': {
'formatter': 'rich_component',
**RICH_HANDLER_CFG,
},
},
'loggers': {
logger_name: {
# 'level': 'INFO',
'propagate': True,
'handlers': ['rich_component'],
}
},
}
@@ -139,9 +165,9 @@ def create_rich_logging_dict(parent_room: str, typ: str = None):
def setup_component_logging(self) -> logging.Logger:
"""Creates a logger for a subcomponent with a RichHandler"""
typ = type(self).__name__
component = type(self).__name__
parent = self.args['app']
cfg_dict = create_rich_logging_dict(parent_room=parent, typ=typ)
cfg_dict = component_logging_config(parent_room=parent, component=component)
logger_name = next(iter(cfg_dict['loggers']))
try:
@@ -149,4 +175,6 @@ def setup_component_logging(self) -> logging.Logger:
except Exception:
console.print_exception()
else:
return logging.getLogger(logger_name)
logger = logging.getLogger(logger_name)
logger = logging.LoggerAdapter(logger, {'room': parent, 'component': component})
return logger