risclog.logging 1.0__py3-none-any.whl

risclog/logging/__init__.py

@@ -0,0 +1,414 @@
+import asyncio
+import inspect
+import logging
+import os
+import smtplib
+import sys
+import traceback
+from concurrent.futures import ThreadPoolExecutor
+from email.mime.multipart import MIMEMultipart
+from email.mime.text import MIMEText
+from functools import partial, wraps
+from pathlib import Path
+from typing import Coroutine
+
+import structlog
+from structlog.types import Processor
+
+
+def rename_event_to_message(_, __, event_dict):
+    if 'event' in event_dict:
+        event_dict['message'] = event_dict.pop('event')
+    keys_at_end = ['referer']
+    sorted_keys = sorted(
+        event_dict.keys(), key=lambda x: (x in keys_at_end, x)
+    )
+    sorted_dict = {k: event_dict[k] for k in sorted_keys}
+    return sorted_dict
+
+
+class RiscLoggerSingletonMeta(type):
+    _instances = {}
+
+    def __call__(cls, *args, **kwargs):
+        if cls not in cls._instances:
+            cls._instances[cls] = super(RiscLoggerSingletonMeta, cls).__call__(
+                *args, **kwargs
+            )
+
+        return cls._instances[cls]
+
+
+class RiscLogger(metaclass=RiscLoggerSingletonMeta):
+    def __init__(self, name: str = None) -> None:
+        self.logger = structlog.stdlib.get_logger(name)
+        self.logger_name = name
+
+    def __new__(cls, *args, **kwargs):
+        cls._configure_logger()
+        instance = super().__new__(cls)
+
+        return instance
+
+    @classmethod
+    def _configure_logger(cls):
+        LEVELS = {
+            'CRITICAL': 50,
+            'FATAL': 50,
+            'ERROR': 40,
+            'WARNING': 30,
+            'WARN': 30,
+            'INFO': 20,
+            'DEBUG': 10,
+        }
+
+        log_level = LEVELS.get(os.getenv('LOG_LEVEL'), 20)
+
+        timestamper = structlog.processors.TimeStamper(fmt='%Y-%m-%d %H:%M:%S')
+        shared_processors: list[Processor] = [
+            structlog.contextvars.merge_contextvars,
+            structlog.stdlib.add_logger_name,
+            structlog.stdlib.add_log_level,
+            structlog.stdlib.PositionalArgumentsFormatter(),
+            structlog.stdlib.ExtraAdder(),
+            timestamper,
+            structlog.processors.StackInfoRenderer(),
+            rename_event_to_message,
+        ]
+
+        structlog.configure(
+            logger_factory=structlog.stdlib.LoggerFactory(),
+            processors=shared_processors
+            + [
+                structlog.stdlib.ProcessorFormatter.wrap_for_formatter,
+            ],
+            wrapper_class=structlog.stdlib.BoundLogger,
+            cache_logger_on_first_use=True,
+        )
+
+        log_renderer: structlog.types.Processor
+        log_renderer = structlog.dev.ConsoleRenderer()
+        formatter = structlog.stdlib.ProcessorFormatter(
+            foreign_pre_chain=shared_processors,
+            processors=[
+                structlog.stdlib.ProcessorFormatter.remove_processors_meta,
+                log_renderer,
+            ],
+        )
+        # set logger Level from asyncio package to WARNING
+        logging.getLogger('asyncio').setLevel(logging.WARNING)
+        handler = logging.StreamHandler()
+        handler.setFormatter(formatter)
+        root_logger = logging.getLogger()
+        root_logger.addHandler(handler)
+        root_logger.setLevel(log_level)
+
+        for _log in ['uvicorn', 'uvicorn.error']:
+            logging.getLogger(_log).handlers.clear()
+            logging.getLogger(_log).propagate = True
+
+        logging.getLogger('uvicorn.access').handlers.clear()
+        logging.getLogger('uvicorn.access').propagate = False
+
+        def handle_exception(exc_type, exc_value, exc_traceback):
+            if issubclass(exc_type, KeyboardInterrupt):
+                sys.__excepthook__(exc_type, exc_value, exc_traceback)
+                return False
+
+        sys.excepthook = handle_exception
+
+    async def _async_log(
+        self,
+        level: str,
+        msg: str,
+        sender: str,
+        function_id: int,
+        *args,
+        **kwargs,
+    ) -> Coroutine:
+        await asyncio.sleep(0)
+        func = getattr(self.logger, level.lower())
+        sender = kwargs.get('sender') if kwargs.get('sender') else sender
+        kwargs = {**{'__id': function_id, '__sender': sender}, **kwargs}
+        func(msg, *args, **kwargs)
+
+    def _log(
+        self,
+        level: str,
+        msg: str,
+        function_id: int,
+        sender: str = 'inline',
+        *args,
+        **kwargs,
+    ) -> Coroutine:
+        try:
+            loop = asyncio.get_running_loop()
+        except RuntimeError:
+            loop = None
+
+        if loop and loop.is_running():
+            return self._async_log(
+                level=level,
+                msg=msg,
+                sender=sender,
+                function_id=function_id,
+                *args,
+                **kwargs,
+            )
+        else:
+            return asyncio.run(
+                self._async_log(
+                    level=level,
+                    msg=msg,
+                    sender=sender,
+                    function_id=function_id,
+                    *args,
+                    **kwargs,
+                )
+            )
+
+    @staticmethod
+    def set_caller_id(func):
+        def wrapper(*args, **kwargs):
+            if 'function_id' not in kwargs:
+                caller_frame = inspect.stack()[1]
+                caller_name = caller_frame.function
+                function_id = id(caller_name)
+                kwargs['function_id'] = function_id
+
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    @set_caller_id
+    def debug(
+        self, msg: str = None, function_id: int = None, *args, **kwargs
+    ) -> Coroutine:
+        return self._log(
+            'debug', msg, function_id=function_id, *args, **kwargs
+        )
+
+    @set_caller_id
+    def info(
+        self, msg: str = None, function_id: int = None, *args, **kwargs
+    ) -> Coroutine:
+        return self._log('info', msg, function_id=function_id, *args, **kwargs)
+
+    @set_caller_id
+    def warning(
+        self, msg: str = None, function_id: int = None, *args, **kwargs
+    ) -> Coroutine:
+        return self._log(
+            'warning', msg, function_id=function_id, *args, **kwargs
+        )
+
+    @set_caller_id
+    def fatal(
+        self, msg: str = None, function_id: int = None, *args, **kwargs
+    ) -> Coroutine:
+        return self._log(
+            'fatal', msg, function_id=function_id, *args, **kwargs
+        )
+
+    @set_caller_id
+    def critical(
+        self, msg: str = None, function_id: int = None, *args, **kwargs
+    ) -> Coroutine:
+        return self._log(
+            'critical', msg, function_id=function_id, *args, **kwargs
+        )
+
+    @set_caller_id
+    def exception(
+        self, msg: str = None, function_id: int = None, *args, **kwargs
+    ) -> Coroutine:
+        return self._log(
+            'error', msg, function_id=function_id, *args, **kwargs
+        )
+
+    @set_caller_id
+    def error(
+        self, msg: str = None, function_id: int = None, *args, **kwargs
+    ) -> Coroutine:
+        return self._log(
+            'error', msg, function_id=function_id, *args, **kwargs
+        )
+
+    @classmethod
+    def decorator(cls, method=None, send_email=False):
+        if method is None:
+            return lambda m: cls.decorator(m, send_email)
+
+        function_id = id(method)
+        if not cls._instances:
+            logger = cls(name=__name__)
+        else:
+            logger = cls._instances[cls]
+
+        if inspect.iscoroutinefunction(method):
+
+            @wraps(method)
+            async def async_wrapper(*args, **kwargs):
+                try:
+                    script = Path(inspect.getfile(method)).name
+                    structlog.contextvars.bind_contextvars(
+                        _function=method.__name__,
+                        _script=script,
+                    )
+
+                    frame = inspect.currentframe()
+                    _, _, _, frame_values = inspect.getargvalues(frame)
+                    args_dict = {f'arg_{i}': arg for i, arg in enumerate(args)}
+                    params = {**args_dict, **frame_values.get('kwargs')}
+
+                    if params:
+                        await logger.info(
+                            f'Method called: "{method.__name__}" with: "{params}"',
+                            function_id=function_id,
+                            sender='async_logging_decorator',
+                        )
+                    else:
+                        await logger.info(
+                            f'Method "{method.__name__}" called with no arguments.',
+                            sender='async_logging_decorator',
+                            function_id=function_id,
+                        )
+
+                    value = await method(*args, **kwargs)
+                    await logger.info(
+                        f'Method "{method.__name__}" returned: "{value}"',
+                        sender='async_logging_decorator',
+                        function_id=function_id,
+                    )
+                    return value
+                except Exception as exc:
+                    message = f'Exception occurred in method: {method.__name__}, exception: {exc}'
+                    if send_email:
+                        with ThreadPoolExecutor() as executor:
+                            message = f'{message}\n\n\n{exception_to_string(excp=exc)}'
+                            executor.submit(
+                                partial(
+                                    smtp_email_send,
+                                    message=message,
+                                    logger_name=logger.logger_name,
+                                )
+                            )
+                    await logger.exception(
+                        message,
+                        sender='async_logging_decorator',
+                        function_id=function_id,
+                    )
+                    raise exc
+                finally:
+                    structlog.contextvars.unbind_contextvars(
+                        '_function', '_script'
+                    )
+
+            return async_wrapper
+        else:
+
+            @wraps(method)
+            def sync_wrapper(*args, **kwargs):
+                try:
+                    script = Path(inspect.getfile(method)).name
+                    structlog.contextvars.bind_contextvars(
+                        _function=method.__name__,
+                        _script=script,
+                    )
+
+                    frame = inspect.currentframe()
+                    _, _, _, frame_values = inspect.getargvalues(frame)
+                    args_dict = {f'arg_{i}': arg for i, arg in enumerate(args)}
+                    params = {**args_dict, **frame_values.get('kwargs')}
+
+                    if params:
+                        logger.info(
+                            f'Method called: "{method.__name__}" with: "{params}"',
+                            function_id=function_id,
+                            sender='logging_decorator',
+                        )
+                    else:
+                        logger.info(
+                            f'Method "{method.__name__}" called with no arguments.',
+                            sender='logging_decorator',
+                            function_id=function_id,
+                        )
+
+                    value = method(*args, **kwargs)
+                    logger.info(
+                        f'Method "{method.__name__}" returned: "{value}"',
+                        sender='logging_decorator',
+                        function_id=function_id,
+                    )
+                    return value
+                except Exception as exc:
+                    message = f'Exception occurred in method: {method.__name__}, exception: {exc}'
+                    if send_email:
+                        with ThreadPoolExecutor() as executor:
+                            message = f'{message}\n\n\n{exception_to_string(excp=exc)}'
+                            executor.submit(
+                                partial(
+                                    smtp_email_send,
+                                    message=message,
+                                    logger_name=logger.logger_name,
+                                )
+                            )
+                    logger.exception(
+                        message,
+                        sender='logging_decorator',
+                        function_id=function_id,
+                    )
+                    raise exc
+                finally:
+                    structlog.contextvars.unbind_contextvars(
+                        '_function', '_script'
+                    )
+
+            return sync_wrapper
+
+
+def get_logger(name: str = None):
+    if not name:
+        frm = inspect.stack()[1]
+        mod = inspect.getmodule(frm[0])
+        name = mod.__name__
+    return RiscLogger(name=name)
+
+
+def exception_to_string(excp):
+    stack = traceback.extract_stack()[:-3] + traceback.extract_tb(
+        excp.__traceback__
+    )
+    pretty = traceback.format_list(stack)
+    return ''.join(pretty) + '\n  {} {}'.format(excp.__class__, excp)
+
+
+def smtp_email_send(message: str, logger_name: str) -> None:
+    smtp_user = os.getenv('logging_email_smtp_user')
+    smtp_password = os.getenv('logging_email_smtp_password')
+    email_to = os.getenv('logging_email_to')
+    smtp_server = os.getenv('logging_email_smtp_server')
+
+    if smtp_user and smtp_password and email_to and smtp_server:
+        # Email server setup
+        smtp_user = smtp_user
+        smtp_password = smtp_password
+
+        # Create the email message
+        email_message = MIMEMultipart()
+        email_message['From'] = smtp_user
+        email_message['To'] = email_to
+        email_message['Subject'] = f'Error in {logger_name}'
+        email_message.attach(MIMEText(message, 'plain'))
+
+        # Send the email
+        with smtplib.SMTP(host=smtp_server, port=465) as smtp:
+            smtp.ehlo()
+            smtp.starttls()
+            smtp.login(smtp_user, smtp_password)
+            smtp.send_message(email_message)
+    else:
+        logger = get_logger(name=logger_name)
+        logger.error(
+            'Emails cannot be sent because one or more environment variables are not set!'
+        )

risclog/logging/conftest.py

@@ -0,0 +1,13 @@
+import pytest
+from risclog.logging import get_logger
+
+
+@pytest.fixture(scope='function')
+def setup_logger(monkeypatch):
+    monkeypatch.setenv('logging_email_smtp_user', 'user@example.com')
+    monkeypatch.setenv('logging_email_smtp_password', 'password')
+    monkeypatch.setenv('logging_email_to', 'recipient@example.com')
+    monkeypatch.setenv('logging_email_smtp_server', 'smtp.example.com')
+
+    logger = get_logger('test_logger')
+    return logger

risclog/logging/tests/test_logger.py

@@ -0,0 +1,284 @@
+import logging
+import sys
+from unittest.mock import patch
+
+import pytest
+from risclog.logging import RiscLogger, get_logger, rename_event_to_message
+
+
+def test_logger_singleton(setup_logger):
+    logger1 = get_logger('test_logger')
+    logger2 = get_logger(__name__)
+
+    assert logger1 is logger2, 'RiscLogger should be a singleton instance'
+
+
+def test_debug_log(setup_logger, caplog):
+    logger = setup_logger
+
+    with caplog.at_level(logging.DEBUG):
+        logger.debug('This is a debug message')
+
+    assert 'This is a debug message' in caplog.text
+    assert 'test_logger' in caplog.text
+    assert 'DEBUG' in caplog.text
+
+
+def test_info_log(setup_logger, caplog):
+    logger = setup_logger
+
+    with caplog.at_level(logging.INFO):
+        logger.info('This is an info message')
+
+    assert 'This is an info message' in caplog.text
+    assert 'test_logger' in caplog.text
+    assert 'INFO' in caplog.text
+
+
+def test_warning_log(setup_logger, caplog):
+    logger = setup_logger
+
+    with caplog.at_level(logging.WARNING):
+        logger.warning('This is a warning message')
+
+    assert 'This is a warning message' in caplog.text
+    assert 'test_logger' in caplog.text
+    assert 'WARNING' in caplog.text
+
+
+def test_error_log(setup_logger, caplog):
+    logger = setup_logger
+
+    with caplog.at_level(logging.ERROR):
+        logger.error('This is an error message')
+
+    assert 'This is an error message' in caplog.text
+    assert 'test_logger' in caplog.text
+    assert 'ERROR' in caplog.text
+
+
+def test_critical_log(setup_logger, caplog):
+    logger = setup_logger
+
+    with caplog.at_level(logging.CRITICAL):
+        logger.critical('This is a critical message')
+
+    assert 'This is a critical message' in caplog.text
+    assert 'test_logger' in caplog.text
+    assert 'CRITICAL' in caplog.text
+
+
+def test_fatal_log(setup_logger, caplog):
+    logger = setup_logger
+
+    with caplog.at_level(logging.FATAL):
+        logger.fatal('This is a fatal message')
+
+    assert 'This is a fatal message' in caplog.text
+    assert 'test_logger' in caplog.text
+    assert 'CRITICAL' in caplog.text
+
+
+def test_exception_log(setup_logger, caplog):
+    logger = setup_logger
+
+    with caplog.at_level(logging.INFO):
+        logger.exception('This is a exception message')
+
+    assert 'This is a exception message' in caplog.text
+    assert 'test_logger' in caplog.text
+    assert 'ERROR' in caplog.text
+
+
+@pytest.mark.asyncio
+async def test_async_logging_decorator(setup_logger, caplog):
+    logger = setup_logger
+
+    @logger.decorator
+    async def async_test_func(arg_0, arg_1):
+        return f'Result: {arg_0 + arg_1}'
+
+    with caplog.at_level(logging.INFO):
+        result = await async_test_func(1, 2)
+
+    assert result == 'Result: 3'
+
+    log_records = [
+        record for record in caplog.records if record.levelname == 'INFO'
+    ]
+    assert len(log_records) >= 2
+
+    first_log = log_records[0].msg
+    second_log = log_records[1].msg
+
+    assert (
+        'Method called: "async_test_func" with: "{\'arg_0\': 1, \'arg_1\': 2}"'
+        in first_log['message']
+    )
+    assert (
+        'Method "async_test_func" returned: "Result: 3"'
+        in second_log['message']
+    )
+
+
+def test_sync_logging_decorator(setup_logger, caplog):
+    logger = setup_logger
+
+    @logger.decorator()
+    def sync_test_func(arg1, arg2):
+        return f'Result: {arg1 + arg2}'
+
+    with caplog.at_level(logging.INFO):
+        result = sync_test_func(3, 4)
+
+    assert result == 'Result: 7'
+
+    log_records = [
+        record for record in caplog.records if record.levelname == 'INFO'
+    ]
+    assert len(log_records) >= 2
+
+    first_log = log_records[0].msg
+    second_log = log_records[1].msg
+
+    assert (
+        'Method called: "sync_test_func" with: "{\'arg_0\': 3, \'arg_1\': 4}"'
+        in first_log['message']
+    )
+    assert (
+        'Method "sync_test_func" returned: "Result: 7"'
+        in second_log['message']
+    )
+
+
+@patch('risclog.logging.smtp_email_send')
+def test_exception_logging_with_email(mock_smtp_send, setup_logger, caplog):
+    logger = setup_logger
+
+    @logger.decorator(send_email=True)
+    def faulty_func():
+        raise ValueError('This is an error')
+
+    with caplog.at_level(logging.ERROR):
+        with pytest.raises(ValueError, match='This is an error'):
+            faulty_func()
+
+    assert 'Exception occurred in method: faulty_func' in caplog.text
+    assert 'This is an error' in caplog.text
+
+    assert (
+        mock_smtp_send.called
+    ), 'smtp_email_send should be called when an exception occurs with send_email=True'
+    mock_smtp_send.assert_called_once()
+
+    args, kwargs = mock_smtp_send.call_args
+
+    assert (
+        len(args) == 0
+    ), 'smtp_email_send should not be called with positional arguments'
+    assert (
+        len(kwargs) == 2
+    ), 'smtp_email_send should be called with two keyword arguments'
+
+    expected_message = 'Exception occurred in method: faulty_func'
+    expected_logger_name = 'test_logger'
+    assert (
+        expected_message in kwargs['message']
+    ), f"First keyword argument should be '{expected_message}'"
+    assert (
+        kwargs['logger_name'] == expected_logger_name
+    ), f"Second keyword argument should be '{expected_logger_name}'"
+
+
+@patch('risclog.logging.smtp_email_send')
+@pytest.mark.asyncio
+async def test_async_exception_logging_with_email(
+    mock_smtp_send, setup_logger, caplog
+):
+    logger = setup_logger
+
+    @logger.decorator(send_email=True)
+    async def faulty_async_func():
+        raise ValueError('This is an async error')
+
+    with caplog.at_level(logging.ERROR):
+        with pytest.raises(ValueError, match='This is an async error'):
+            await faulty_async_func()
+
+    assert 'Exception occurred in method: faulty_async_func' in caplog.text
+    assert 'This is an async error' in caplog.text
+
+    assert (
+        mock_smtp_send.called
+    ), 'smtp_email_send should be called when an exception occurs in async function with send_email=True'
+    mock_smtp_send.assert_called_once()
+    args, kwargs = mock_smtp_send.call_args
+
+    assert (
+        len(args) == 0
+    ), 'smtp_email_send should not be called with positional arguments'
+    assert (
+        len(kwargs) == 2
+    ), 'smtp_email_send should be called with two keyword arguments'
+
+    assert (
+        'This is an async error' in kwargs['message']
+    ), 'The error message should be in the email content'
+    assert (
+        'test_logger' in kwargs['logger_name']
+    ), 'Logger name should be passed to the smtp_email_send function'
+
+
+def test_rename_event_to_message():
+    event_dict = {
+        'event': 'This is an event message',
+        'level': 'info',
+        'referer': 'https://example.com',
+        'user': 'test_user',
+    }
+    expected_dict = {
+        'level': 'info',
+        'user': 'test_user',
+        'message': 'This is an event message',
+        'referer': 'https://example.com',
+    }
+    result_dict = rename_event_to_message(None, None, event_dict)
+
+    assert (
+        result_dict == expected_dict
+    ), f'Expected {expected_dict} but got {result_dict}'
+
+
+def test_no_event_key():
+    event_dict = {
+        'level': 'info',
+        'user': 'test_user',
+        'referer': 'https://example.com',
+    }
+    expected_dict = {
+        'level': 'info',
+        'user': 'test_user',
+        'referer': 'https://example.com',
+    }
+    result_dict = rename_event_to_message(None, None, event_dict)
+
+    assert (
+        result_dict == expected_dict
+    ), f'Expected {expected_dict} but got {result_dict}'
+
+
+def test_empty_dict():
+    event_dict = {}
+    expected_dict = {}
+    result_dict = rename_event_to_message(None, None, event_dict)
+
+    assert (
+        result_dict == expected_dict
+    ), f'Expected {expected_dict} but got {result_dict}'
+
+
+def test_handle_keyboard_interrupt(setup_logger):
+    with patch('sys.__excepthook__') as mock_excepthook:
+        RiscLogger._configure_logger()
+        sys.excepthook(KeyboardInterrupt, None, None)
+        mock_excepthook.assert_called_once_with(KeyboardInterrupt, None, None)

risclog.logging-1.0-py3.9-nspkg.pth

@@ -0,0 +1 @@
+import sys, types, os;p = os.path.join(sys._getframe(1).f_locals['sitedir'], *('risclog',));importlib = __import__('importlib.util');__import__('importlib.machinery');m = sys.modules.setdefault('risclog', importlib.util.module_from_spec(importlib.machinery.PathFinder.find_spec('risclog', [os.path.dirname(p)])));m = m or sys.modules.setdefault('risclog', types.ModuleType('risclog'));mp = (m or []) and m.__dict__.setdefault('__path__',[]);(p not in mp) and mp.append(p)

risclog.logging-1.0.dist-info/AUTHORS.rst

@@ -0,0 +1,13 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* riscLOG Solution GmbH <info@risclog.de>
+
+Contributors
+------------
+
+None yet. Why not be the first?

risclog.logging-1.0.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024, riscLOG Solution GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

risclog.logging-1.0.dist-info/METADATA

@@ -0,0 +1,234 @@
+Metadata-Version: 2.1
+Name: risclog.logging
+Version: 1.0
+Summary: A logger based on structlog
+Home-page: https://github.com/risclog-solution/risclog.logging
+Author: riscLOG Solution GmbH
+Author-email: info@risclog.de
+License: MIT license
+Keywords: risclog.logging
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: German
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.6
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: structlog
+Provides-Extra: docs
+Requires-Dist: Sphinx ; extra == 'docs'
+Provides-Extra: test
+Requires-Dist: pytest-cache ; extra == 'test'
+Requires-Dist: pytest-cov ; extra == 'test'
+Requires-Dist: pytest-flake8 ; extra == 'test'
+Requires-Dist: pytest-rerunfailures ; extra == 'test'
+Requires-Dist: pytest-sugar ; extra == 'test'
+Requires-Dist: pytest ; extra == 'test'
+Requires-Dist: coverage ; extra == 'test'
+Requires-Dist: flake8 <4 ; extra == 'test'
+Requires-Dist: mock ; extra == 'test'
+Requires-Dist: requests ; extra == 'test'
+Requires-Dist: httpx ; extra == 'test'
+Requires-Dist: pytest-asyncio ; extra == 'test'
+
+===============
+risclog.logging
+===============
+
+.. image:: https://github.com/risclog-solution/risclog.logging/workflows/Test/badge.svg?branch=master
+     :target: https://github.com/risclog-solution/risclog.logging/actions?workflow=Test
+     :alt: CI Status
+
+
+.. image:: https://img.shields.io/pypi/v/risclog.logging.svg
+        :target: https://pypi.python.org/pypi/risclog.logging
+
+.. image:: https://img.shields.io/travis/risclog-solution/risclog.logging.svg
+        :target: https://travis-ci.com/risclog-solution/risclog.logging
+
+.. image:: https://readthedocs.org/projects/risclog.logging/badge/?version=latest
+        :target: https://risclog.logging.readthedocs.io/en/latest/?version=latest
+        :alt: Documentation Status
+
+The risclog.logging package provides a comprehensive solution for structured logging in Python applications. Risclog.logging uses structlog and logging to generate detailed and formatted log entries. The package supports both synchronous and asynchronous log messages and provides options for automatic e-mail notification of exception errors.
+
+
+* Free software: MIT license
+* Documentation: https://risclog.logging.readthedocs.io.
+
+
+Features
+========
+
+
+Creating a logger
+-----------------
+
+To create a logger, use the get_logger function. This function ensures that you get an instance of RiscLogger that is properly configured.
+
+.. code-block:: python
+
+    from risclog.logging import get_logger
+
+    # create logger
+    logger = get_logger(name='my_logger')
+
+
+Configuration of the logger
+---------------------------
+
+The logger configuration takes place automatically when the logger instance is created using get_logger. The _configure_logger method sets up structlog and logging to provide logs with timestamps, context variables and formatting. You can customize the configuration as required.
+
+The module is configured to automatically read the logging level from an environment variable. By default, the level is set to `INFO`. To adjust this, set the `LOG_LEVEL` environment variable:
+
+.. code-block:: bash
+
+    export LOG_LEVEL=DEBUG
+
+
+Use the following methods to log messages with different log levels:
+
+* Debug-message: logger.debug("This is a debug message")
+* Info-message: logger.info("This is an info message")
+* Warning-message: logger.warning("This is a warning message")
+* Error-message: logger.error("This is an error message")
+* Critical-message: logger.critical("This is a critical message")
+* Fatal-message: logger.fatal("This is a fatal message")
+* Exception-message: logger.exception("This is an exception message")
+
+
+Asynchronous and synchronous log messages
+-----------------------------------------
+
+The risclog.logging package supports both synchronous and asynchronous log messages. If you are working in an asynchronous environment, use the asynchronous versions of the log methods:
+
+* Asynchronous debug message: await logger.debug("Async debug message")
+* Asynchronous info message: await logger.info("Async info message")
+* And so on...
+
+
+Decorator for logging
+---------------------
+
+The decorator decorator can be used to provide methods with automatic logging and optional e-mail notification of exceptions
+
+.. code-block:: python
+
+    from risclog.logging import get_logger
+
+    logger = get_logger(name='my_logger')
+
+    @logger.decorator(send_email=True)
+    async def some_async_function(x, y):
+        return x + y
+
+.. code-block:: python
+
+    from risclog.logging import get_logger
+
+    logger = get_logger(name='my_logger')
+
+    @logger.decorator
+    def some_sync_function(x, y):
+        return x + y
+
+
+Error handling and e-mail notification
+--------------------------------------
+
+If you set the send_email parameter to True, an email notification is automatically sent in the event of an exception. The email is sent asynchronously via a ThreadPoolExecutor and contains the exception details.
+
+**To be able to send e-mails, the following environment variables must be set!**
+
+* 'logging_email_smtp_user'
+* 'logging_email_smtp_password'
+* 'logging_email_to'
+* 'logging_email_smtp_server'
+
+
+Example
+-------
+
+Here is a complete example showing how to use the risclog.logginng package in an application
+
+
+.. code-block:: python
+
+    import os
+    import asyncio
+    from risclog.logging import get_logger
+
+
+    os.environ["LOG_LEVEL"] = "DEBUG"
+
+    logger = get_logger("async_debug_example")
+
+
+    @logger.decorator(send_email=True)
+    async def fetch_data(url: str):
+        await logger.debug(f"Start retrieving data from  {url}")
+        await asyncio.sleep(2)  # Simulates a delay, such as a network request
+        await logger.debug(f"Successfully retrieved data from {url}")
+        return {"data": f"Sample data from {url}"}
+
+
+    @logger.decorator
+    async def main():
+        url = "https://example.com"
+        await logger.debug(f"Start main function with URL: {url}")
+        data = await fetch_data(url)
+        await logger.debug(f"Data received: {data}")
+
+
+    if __name__ == "__main__":
+        logger.info("Start main function")
+        asyncio.run(main())
+
+
+output:
+
+.. code-block:: bash
+
+    2024-08-05 11:38:51 [info     ] [async_debug_example] __id=4378622064 __sender=inline message=Start main function
+    2024-08-05 11:38:51 [info     ] [async_debug_example] __id=4384943584 __sender=async_logging_decorator _function=main _script=example.py message=Method "main" called with no arguments.
+    2024-08-05 11:38:51 [debug    ] [async_debug_example] __id=4378552584 __sender=inline _function=main _script=example.py message=Start main function with URL: https://example.com
+    2024-08-05 11:38:51 [info     ] [async_debug_example] __id=4384943744 __sender=async_logging_decorator _function=fetch_data _script=example.py message=Method called: "fetch_data" with: "{'arg_0': 'https://example.com'}"
+    2024-08-05 11:38:51 [debug    ] [async_debug_example] __id=4366292144 __sender=inline _function=fetch_data _script=example.py message=Start retrieving data from  https://example.com
+    2024-08-05 11:38:53 [debug    ] [async_debug_example] __id=4366292144 __sender=inline _function=fetch_data _script=example.py message=Successfully retrieved data from https://example.com
+    2024-08-05 11:38:53 [info     ] [async_debug_example] __id=4384943744 __sender=async_logging_decorator _function=fetch_data _script=example.py message=Method "fetch_data" returned: "{'data': 'Sample data from https://example.com'}"
+    2024-08-05 11:38:53 [debug    ] [async_debug_example] __id=4378552584 __sender=inline message=Data received: {'data': 'Sample data from https://example.com'}
+    2024-08-05 11:38:53 [info     ] [async_debug_example] __id=4384943584 __sender=async_logging_decorator message=Method "main" returned: "None"
+
+
+
+Run tests::
+
+    $ ./pytest
+
+
+Credits
+=======
+
+This package was created with Cookiecutter_ and the `risclog-solution/risclog-cookiecutter-pypackage`_ project template.
+
+.. _Cookiecutter: https://github.com/audreyr/cookiecutter
+.. _`risclog-solution/risclog-cookiecutter-pypackage`: https://github.com/risclog-solution/risclog-cookiecutter-pypackage
+
+
+This package uses AppEnv_ for running tests inside this package.
+
+.. _AppEnv: https://github.com/flyingcircusio/appenv
+
+
+==============================
+Change log for risclog.logging
+==============================
+
+
+1.0 (2024-08-06)
+================
+
+* initial release

risclog.logging-1.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+risclog.logging-1.0-py3.9-nspkg.pth,sha256=hcuO9Dx6k_WjALKvuGBr2x8pf_5TVBGuMEPDx89xWBE,472
+risclog/logging/__init__.py,sha256=mpToVrvyjXaKzRoaVbof6kGAVWycJaejOuu85lkbmS8,14185
+risclog/logging/conftest.py,sha256=A-pZNNNyRUyj-uXZ7hPvzEl-ssvW-wJFTSy3veSFB4A,454
+risclog/logging/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+risclog/logging/tests/test_logger.py,sha256=-frSVaqDgBmshmo5qtHL_9j47JfztLzDYnp2ujk2SbI,8050
+risclog.logging-1.0.dist-info/AUTHORS.rst,sha256=pVVRKSOAsIIpu2buAkIq8tk9Dy_sY6IhsUSIhHNtWYI,162
+risclog.logging-1.0.dist-info/LICENSE,sha256=oMdbT2VqsrzqxdQaxc2s4GTDfqoaZL5MBuxiVj-ouJA,1079
+risclog.logging-1.0.dist-info/METADATA,sha256=b-oIziAhO3yl_C9yBFZ7rrNVIBTkmlG6CoC1DS8xvRY,8652
+risclog.logging-1.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+risclog.logging-1.0.dist-info/namespace_packages.txt,sha256=3mNzAyFsNr3rScCOTOeT6a_uYKMR3jp5ucOiCZy5k8g,8
+risclog.logging-1.0.dist-info/top_level.txt,sha256=3mNzAyFsNr3rScCOTOeT6a_uYKMR3jp5ucOiCZy5k8g,8
+risclog.logging-1.0.dist-info/RECORD,,

risclog.logging-1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.42.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

risclog.logging-1.0.dist-info/namespace_packages.txt

@@ -0,0 +1 @@
+risclog

risclog.logging-1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+risclog