How to inspect sinks? (hashtag1024)

[vikramsubramanian]

hashtag in which situation do I need this

The loguru configuration of our project start to be complex, and programmatically configured. I arrive to the point where I need to inspect the configuration of all the sinks at a given point in the code, to see if the configuration values do produce the logging configuration I wish.

hashtag example needs

• I want to get my hands on the list of currently active sink objects.
• I want to see the detailed configuration of a sink, including it's format or format function, it's destination or sink function, it's patches.
• Eventually see debug logging of the internals of loguru log flow, is there a logger I can unmute? )

[mayil-ai[bot]]

To inspect the configuration of all the sinks in Loguru, you can follow these steps:

• Get the list of currently active sink objects:

  • Loguru does not provide a built-in method to retrieve all active sinks directly. However, you can maintain a list of sinks when you add them using logger.add() and use this list to inspect the sinks.

• See the detailed configuration of a sink:

  • The configuration details of a sink are not directly exposed by Loguru. When you add a sink, you can store the configuration parameters in a structure (like a dictionary) that you maintain. This way, you can refer back to the stored configurations to inspect the details.

• Debug logging of the internals of Loguru log flow:

  • Loguru does not provide internal debug logging capabilities. If you need to debug the log flow, you would have to modify the Loguru source code to add logging statements that capture the information you are interested in.

Here is a pseudo-code example of how you might track and inspect sink configurations:

# Global list to keep track of sinks and their configurations
sinks_list = []

# Function to add a sink and store its configuration
def add_sink(sink, **kwargs):
    sink_id = logger.add(sink, **kwargs)
    sink_config = {
        'id': sink_id,
        'sink': sink,
        'config': kwargs
    }
    sinks_list.append(sink_config)
    return sink_id

# Function to inspect all active sinks
def inspect_sinks():
    for sink_config in sinks_list:
        print(f"Sink ID: {sink_config['id']}")
        print(f"Sink: {sink_config['sink']}")
        print(f"Configuration: {sink_config['config']}")

# Example usage
add_sink(sys.stdout, format="{time} - {level} - {message}")
add_sink("file.log", rotation="1 week", level="INFO")

# Later in the code, you can inspect the sinks
inspect_sinks()

Remember that this is a workaround and not a built-in feature of Loguru. You will need to ensure that your add_sink function is used in place of logger.add() throughout your codebase to maintain an accurate list of sinks and their configurations.