Custom log handlers do not receive the original log message (hashtag1080)

[vikramsubramanian]

Reading Record.msg in a custom logging.Handler implementation returns a formatted message instead of the original text. Since I need to use a different format for different handlers this is quite problematic. This is also different from the Python logging.

Expected value: "That's it, beautiful and simple logging!"

Actual value: "2024-02-13 13:30:54.357 | DEBUG | __main__:run_it:31 - That's it, beautiful and simple logging!" )

[mayil-ai[bot]]

Possible Solution

• Review the CustomHandler class to ensure it does not modify Record.msg inappropriately.
• Ensure that the format method of the CustomHandler class returns the original Record.msg without additional formatting if that is the desired behavior.
• If the CustomHandler is intended to apply specific formatting, adjust the format method to conditionally format messages based on the handler's requirements.
• If the CustomHandler is using Loguru's Handler class, check if the emit method is using record["message"] directly for raw messages or if it is applying unnecessary formatting.
• If the CustomHandler is meant to handle Loguru's Message objects, ensure that the emit method checks for is_raw and uses record["message"] as is when is_raw is True.
• If the CustomHandler is meant to serialize the log record, ensure that the serialize method or option is correctly implemented and does not alter the original message.
• If the CustomHandler is using Loguru's Handler class, ensure that the self._serialize attribute is set to False if serialization is not desired.
• If the CustomHandler is using Loguru's Handler class and the issue is with colorization, ensure that self._colorize is set appropriately and that the Colorizer class is used correctly.
• If the CustomHandler is using Loguru's Handler class and the issue is with dynamic formatting, ensure that self._is_formatter_dynamic is set to False if dynamic formatting is not desired.
• If the CustomHandler is using Loguru's Handler class and the issue is with exception formatting, ensure that formatter_record["exception"] is set correctly in the emit method.
• If the CustomHandler is using Loguru's Handler class and the issue is with message stripping, ensure that colored_message.stripped is used correctly in the emit method when is_raw is True.
• If the CustomHandler is using Loguru's Handler class and the issue is with precomputed formats, ensure that self._memoize_dynamic_format and self._precolorized_formats are used correctly in the emit method.
• If the CustomHandler is using Loguru's Handler class and the issue is with queue handling, ensure that self._enqueue is set correctly and that self._queue.put is used correctly in the emit method.
• If the CustomHandler is using Loguru's Handler class and the issue is with sink writing, ensure that self._sink.write is used correctly in the emit method.
• If the CustomHandler is using Loguru's Handler class and the issue is with stopping the handler, ensure that self._stopped is checked correctly in the emit method.

Code snippets to check

loguru → _logger.py

This snippet contains the logic for formatting the log message, which is relevant to the issue of the custom handler receiving a formatted message instead of the original. https://github.com/Mayil-SB-Internal-Prod/loguru-II/blob/dcf42d962567723c0195bb8b2bb6fd764ecf41ae/loguru/_logger.py#L1981-L2033

loguru → _handler.py

This snippet is part of the handler's emit method, which is responsible for the final formatting of the log message before it is passed to the handler. It is relevant because it shows how the formatted message is created. https://github.com/Mayil-SB-Internal-Prod/loguru-II/blob/dcf42d962567723c0195bb8b2bb6fd764ecf41ae/loguru/_handler.py#L152-L206 This snippet defines the emit method signature, which is the entry point for a log record into a handler. It is relevant to understand how the record is passed to the emit method. https://github.com/Mayil-SB-Internal-Prod/loguru-II/blob/dcf42d962567723c0195bb8b2bb6fd764ecf41ae/loguru/_handler.py#L127-L127 This snippet is part of the emit method and shows conditions that could affect the log record before it is formatted, which is relevant to the issue. https://github.com/Mayil-SB-Internal-Prod/loguru-II/blob/dcf42d962567723c0195bb8b2bb6fd764ecf41ae/loguru/_handler.py#L129-L150