Improved logging

This commit is contained in:
2022-10-02 13:13:23 +02:00
parent 12cd5c9045
commit e2749f6a81
24 changed files with 118 additions and 94 deletions

View File

@@ -1,6 +1,6 @@
from typing import Optional, Type, Callable
from cpl_core.configuration import ConfigurationABC, ConfigurationModelABC
from cpl_core.configuration import ConfigurationABC
from cpl_core.console import Console
from cpl_core.dependency_injection import ServiceProviderABC
from cpl_core.logging import LoggerABC
@@ -11,14 +11,10 @@ from cpl_translation import TranslatePipe, TranslationServiceABC, TranslationSet
from bot_core.configuration.bot_logging_settings import BotLoggingSettings
from bot_core.configuration.bot_settings import BotSettings
from bot_core.configuration.server_settings import ServerSettings
from bot_core.logging.command_logger import CommandLogger
from bot_core.logging.event_logger import EventLogger
from modules.base.configuration.base_server_settings import BaseServerSettings
from bot_core.logging.database_logger import DatabaseLogger
from modules.base.configuration.base_settings import BaseSettings
from modules.boot_log.configuration.boot_log_server_settings import BootLogServerSettings
from modules.boot_log.configuration.boot_log_settings import BootLogSettings
from modules.permission.configuration.permission_server_settings import PermissionServerSettings
from modules.permission.configuration.permission_settings import PermissionSettings
@@ -28,8 +24,6 @@ class Application(DiscordBotApplicationABC):
DiscordBotApplicationABC.__init__(self, config, services)
self._services = services
self._cmd_logger: Optional[LoggerABC] = None
self._event_logger: Optional[LoggerABC] = None
# cpl-core
self._logger: LoggerABC = services.get_service(LoggerABC)
@@ -40,25 +34,8 @@ class Application(DiscordBotApplicationABC):
self._translation: TranslationServiceABC = services.get_service(TranslationServiceABC)
self._translate: TranslatePipe = services.get_service(TranslatePipe)
def _configure_settings_with_sub_settings(self, settings: Type, list_atr: Callable, atr: Callable):
settings: Optional[settings] = self._configuration.get_configuration(settings)
if settings is None:
return
for sub_settings in list_atr(settings):
self._logger.trace(__name__, f'Saved config: {type(sub_settings).__name__}_{atr(sub_settings)}')
self._configuration.add_configuration(f'{type(sub_settings).__name__}_{atr(sub_settings)}', sub_settings)
async def configure(self):
self._translation.load_by_settings(self._configuration.get_configuration(TranslationSettings))
self._configure_settings_with_sub_settings(BotSettings, lambda x: x.servers, lambda x: x.id)
self._configure_settings_with_sub_settings(BaseSettings, lambda x: x.servers, lambda x: x.id)
self._configure_settings_with_sub_settings(BootLogSettings, lambda x: x.servers, lambda x: x.id)
self._configure_settings_with_sub_settings(PermissionSettings, lambda x: x.servers, lambda x: x.id)
self._configure_settings_with_sub_settings(BotLoggingSettings, lambda x: x.files, lambda x: x.key)
# custom loggers need to be loaded AFTER config is loaded correctly
self._cmd_logger: LoggerABC = self._services.get_service(CommandLogger)
self._event_logger: LoggerABC = self._services.get_service(EventLogger)
async def main(self):
try:

View File

@@ -1,7 +1,7 @@
{
"LoggingSettings": {
"Path": "logs/",
"Filename": "dev.log",
"Filename": "bot.log",
"ConsoleLogLevel": "DEBUG",
"FileLogLevel": "TRACE"
},
@@ -12,9 +12,15 @@
"ConsoleLogLevel": "DEBUG",
"FileLogLevel": "TRACE"
},
"Event": {
"Database": {
"Path": "logs/",
"Filename": "event.log",
"Filename": "database.log",
"ConsoleLogLevel": "DEBUG",
"FileLogLevel": "TRACE"
},
"Message": {
"Path": "logs/",
"Filename": "message.log",
"ConsoleLogLevel": "DEBUG",
"FileLogLevel": "TRACE"
}

View File

@@ -10,10 +10,11 @@ from cpl_core.environment import ApplicationEnvironment
from cpl_core.logging import LoggerABC
from bot_core.abc.client_utils_service_abc import ClientUtilsServiceABC
from bot_core.abc.custom_file_logger_abc import CustomFileLoggerABC
from bot_core.abc.message_service_abc import MessageServiceABC
from bot_core.configuration.feature_flags_settings import FeatureFlagsSettings
from bot_core.logging.command_logger import CommandLogger
from bot_core.logging.event_logger import EventLogger
from bot_core.logging.database_logger import DatabaseLogger
from bot_core.logging.message_logger import MessageLogger
from bot_core.pipes.date_time_offset_pipe import DateTimeOffsetPipe
from bot_core.service.client_utils_service import ClientUtilsService
from bot_core.service.message_service import MessageService
@@ -45,16 +46,6 @@ class Startup(StartupABC):
self._config: Optional[ConfigurationABC] = None
def configure_configuration(self, configuration: ConfigurationABC, environment: ApplicationEnvironment) -> ConfigurationABC:
environment.set_working_directory(os.path.dirname(os.path.realpath(__file__)))
configuration.add_environment_variables('KDB_')
configuration.add_environment_variables('DISCORD_')
configuration.add_json_file(f'config/appsettings.json', optional=False)
configuration.add_json_file(f'config/appsettings.{environment.environment_name}.json', optional=True)
configuration.add_json_file(f'config/appsettings.{environment.host_name}.json', optional=True)
configuration.add_configuration('Startup_StartTime', str(self._start_time))
self._config = configuration
return configuration
@@ -62,7 +53,8 @@ class Startup(StartupABC):
services.add_logging()
# custom logging
services.add_singleton(LoggerABC, CommandLogger)
services.add_singleton(LoggerABC, EventLogger)
services.add_singleton(LoggerABC, DatabaseLogger)
services.add_singleton(LoggerABC, MessageLogger)
services.add_translation()
@@ -87,4 +79,9 @@ class Startup(StartupABC):
services.add_transient(UserJoinedServerRepositoryABC, UserJoinedServerRepositoryService)
services.add_transient(UserJoinedVoiceChannelRepositoryABC, UserJoinedVoiceChannelRepositoryService)
return services.build_service_provider()
provider = services.build_service_provider()
# instantiate custom logger
for c in CustomFileLoggerABC.__subclasses__():
i: LoggerABC = provider.get_service(c)
return provider

View File

@@ -1,10 +1,20 @@
import os
from datetime import datetime
from typing import Callable, Type, Optional
from cpl_core.application import StartupExtensionABC
from cpl_core.configuration import ConfigurationABC
from cpl_core.dependency_injection import ServiceCollectionABC
from cpl_core.environment import ApplicationEnvironmentABC
from cpl_core.logging import LoggerABC
from bot_core.configuration.bot_logging_settings import BotLoggingSettings
from bot_core.configuration.bot_settings import BotSettings
from bot_core.logging.command_logger import CommandLogger
from bot_core.logging.database_logger import DatabaseLogger
from modules.base.configuration.base_settings import BaseSettings
from modules.boot_log.configuration.boot_log_settings import BootLogSettings
from modules.permission.configuration.permission_settings import PermissionSettings
class StartupSettingsExtension(StartupExtensionABC):
@@ -23,6 +33,20 @@ class StartupSettingsExtension(StartupExtensionABC):
configuration.add_json_file(f'config/appsettings.{environment.host_name}.json', optional=True)
configuration.add_configuration('Startup_StartTime', str(self._start_time))
self._configure_settings_with_sub_settings(configuration, BotSettings, lambda x: x.servers, lambda x: x.id)
self._configure_settings_with_sub_settings(configuration, BaseSettings, lambda x: x.servers, lambda x: x.id)
self._configure_settings_with_sub_settings(configuration, BootLogSettings, lambda x: x.servers, lambda x: x.id)
self._configure_settings_with_sub_settings(configuration, PermissionSettings, lambda x: x.servers, lambda x: x.id)
self._configure_settings_with_sub_settings(configuration, BotLoggingSettings, lambda x: x.files, lambda x: x.key)
def configure_services(self, services: ServiceCollectionABC, env: ApplicationEnvironmentABC):
pass
@staticmethod
def _configure_settings_with_sub_settings(config: ConfigurationABC, settings: Type, list_atr: Callable, atr: Callable):
settings: Optional[settings] = config.get_configuration(settings)
if settings is None:
return
for sub_settings in list_atr(settings):
config.add_configuration(f'{type(sub_settings).__name__}_{atr(sub_settings)}', sub_settings)