Introduction to Augment Logger

Augment Logger is a highly versatile and feature-rich logging library designed to enhance and simplify the logging experience for developers. It offers a plethora of APIs to accommodate various logging needs efficiently. This guide will dive deep into various useful APIs with practical code snippets for each.

Getting Started

To begin using Augment Logger, you need to install it first:

pip install augment-logger

Basic Configuration

To set up a basic configuration, use the following code:

from augment_logger import Logger

logger = Logger(level='INFO')
logger.info("This is an info log")
logger.warning("This is a warning log")

Advanced Configuration

Augment Logger can be tailored to your specific needs with advanced configurations:

from augment_logger import Logger

config = {
    'level': 'DEBUG',
    'file': 'app.log',
    'format': '%(asctime)s - %(name)s - %(levelname)s - %(message)s',
}
logger = Logger(**config)
logger.debug("This is a debug log for detailed troubleshooting")

Contextual Logging

Contextual logging helps in adding more context to the logs:

logger.context(user="Alice", action="login")
logger.info("User action log with context")

Exception Handling

Automatically log exceptions with Augment Logger:

try:
    1 / 0
except ZeroDivisionError as e:
    logger.exception("Caught an exception", exc_info=e)

File and Console Handlers

Log messages can be directed to both a file and the console:

logger = Logger(file='app.log', console=True)
logger.info("Logging to both console and file")

App Example

Below is an example of a simple application utilizing Augment Logger:

from augment_logger import Logger
from flask import Flask, request

app = Flask(__name__)
logger = Logger(level='INFO', console=True)

@app.route('/login', methods=['POST'])
def login():
    data = request.get_json()
    user = data.get('user')
    logger.context(user=user, action='login attempt')
    logger.info("User attempted to login")
    # Simulate login logic
    return {"message": "Login attempt logged"}, 200

if __name__ == '__main__':
    app.run(debug=True)

Using Augment Logger, this application logs user login attempts directly to both the console and a log file.

By following this guide, you’ll be able to leverage Augment Logger’s capabilities to enhance your application’s logging mechanism, aiding in better troubleshooting and maintenance.

Hash: 446b6bc0dfa3ac050c487fdd79689cb1b05d619e9d9c7ab5c16626f7c8018f93