Configuration Methods¶

from logly import logger

# Colors are automatic when color=True (default)
logger.configure(color=True)

# Each level gets its default color
logger.trace("Trace message")      # Cyan
logger.debug("Debug info")         # Blue
logger.info("Information")         # White
logger.success("Success!")         # Green
logger.warning("Warning!")         # Yellow
logger.error("Error occurred")     # Red
logger.critical("Critical!")       # Bright Red
logger.fail("Operation failed")    # Magenta (NEW)

from logly import logger

logger.configure(level="INFO", color=True, json=False)
logger.add("console")

logger.info("Colored text output", user="alice")

logger.configure(level="INFO", json=True, pretty_json=False)
logger.add("console")

logger.info("JSON output", user="alice", ip="192.168.1.1")

logger.configure(level="DEBUG", json=True, pretty_json=True)
logger.add("console")

logger.debug("Pretty JSON", step=1, phase="init")

from logly import logger

# Custom ANSI colors for each level
custom_colors = {
    "INFO": "32",      # Green
    "WARNING": "93",   # Bright Yellow
    "ERROR": "91",     # Bright Red
    "CRITICAL": "95"   # Bright Magenta
}

logger.configure(
    level="INFO",
    color=True,
    level_colors=custom_colors
)
logger.add("console")

logger.info("This is green")
logger.warning("This is bright yellow")
logger.error("This is bright red")
logger.critical("This is bright magenta")

from logly import logger

# Custom colors using user-friendly names
custom_colors = {
    "INFO": "GREEN",
    "WARNING": "YELLOW",
    "ERROR": "RED",
    "CRITICAL": "BRIGHT_MAGENTA"
}

logger.configure(
    level="INFO",
    color=True,
    level_colors=custom_colors
)
logger.add("console")

logger.info("This is green")
logger.warning("This is yellow")
logger.error("This is red")
logger.critical("This is bright magenta")

from rich.console import Console
from logly import logger

# Create a Rich console for coloring
console = Console()

def rich_color_callback(level, text):
    """Custom color callback using Rich library."""
    # Apply Rich markup based on level
    if level == "DEBUG":
        markup = f"[blue]{text}[/blue]"
    elif level == "INFO":
        markup = f"[green]{text}[/green]"
    elif level in ("WARN", "WARNING"):
        markup = f"[yellow]{text}[/yellow]"
    elif level == "ERROR":
        markup = f"[red]{text}[/red]"
    else:
        markup = text

    # Convert Rich markup to ANSI codes
    with console.capture() as capture:
        console.print(markup, end="")

    return capture.get()

logger.configure(
    level="DEBUG",
    color_callback=rich_color_callback
)
logger.add("console")

logger.debug("This is styled with Rich (blue)")
logger.info("This is styled with Rich (green)")
logger.warning("This is styled with Rich (yellow)")
logger.error("This is styled with Rich (red)")

from logly import logger

def ansi_color_callback(level, text):
    """Custom color callback using direct ANSI codes."""
    colors = {
        "DEBUG": "\033[34m",    # Blue
        "INFO": "\033[32m",     # Green
        "WARN": "\033[33m",     # Yellow
        "WARNING": "\033[33m",  # Yellow (alias)
        "ERROR": "\033[31m",    # Red
    }
    reset = "\033[0m"
    color_code = colors.get(level, "")
    return f"{color_code}{text}{reset}"

logger.configure(
    level="DEBUG",
    color_callback=ansi_color_callback
)
logger.add("console")

logger.debug("This is blue")
logger.info("This is green")
logger.warning("This is yellow")
logger.error("This is red")

from logly import logger

# Show timestamps (default)
logger.configure(level="INFO", show_time=True)
logger.add("console")
logger.info("Message with timestamp")

# Hide timestamps
logger.configure(level="INFO", show_time=False)
logger.add("console")
logger.info("Message without timestamp")

from logly import logger

# Show module and function info (default)
logger.configure(level="INFO", show_module=True, show_function=True)
logger.add("console")
logger.info("Message with module and function")

# Hide module and function info
logger.configure(level="INFO", show_module=False, show_function=False)
logger.add("console")
logger.info("Message without module and function")

# Show only module, hide function
logger.configure(level="INFO", show_module=True, show_function=False)
logger.add("console")
logger.info("Message with module only")

from logly import logger

# Show filename and line number info
logger.configure(level="INFO", show_filename=True, show_lineno=True)
logger.add("console")
logger.info("Message with filename and lineno")

# Hide filename and line number info (default)
logger.configure(level="INFO", show_filename=False, show_lineno=False)
logger.add("console")
logger.info("Message without filename and lineno")

# Show only filename, hide line number
logger.configure(level="INFO", show_filename=True, show_lineno=False)
logger.add("console")
logger.info("Message with filename only")

from rich.console import Console
from logly import logger

# Create a Rich console for coloring
console = Console()

def rich_color_callback(level, text):
    """Custom color callback using Rich library for advanced styling."""
    # Apply Rich markup based on level with advanced styling
    if level == "DEBUG":
        markup = f"[dim blue]{text}[/dim blue]"
    elif level == "INFO":
        markup = f"[bold green]{text}[/bold green]"
    elif level in ("WARN", "WARNING"):
        markup = f"[bold yellow on red]{text}[/bold yellow on red]"
    elif level == "ERROR":
        markup = f"[bold red blink]{text}[/bold red blink]"
    else:
        markup = text

    # Convert Rich markup to ANSI codes
    with console.capture() as capture:
        console.print(markup, end="")

    return capture.get()

logger.configure(
    level="INFO",
    color_callback=rich_color_callback
)
logger.add("console")

logger.info("This uses Rich for advanced styling")
logger.warning("Rich styling: bold yellow on red background")
logger.error("Rich styling: bold red with blinking")

# Production configuration
logger.configure(
    level="INFO",           # Info and above
    color=False,            # No colors for log aggregators
    json=True,              # Structured JSON
    pretty_json=False       # Compact for storage
)
logger.add("console")
logger.add("logs/app.log", rotation="daily", retention=30)

# Add console output
handler_id = logger.add("console")
logger.info("Console logging enabled")

# Simple file logging
logger.add("logs/app.log")
logger.info("Logging to file")

# Rotate daily at midnight, keep last 7 files
logger.add(
    "logs/app.log",
    rotation="daily",
    retention=7
)

# Files: app.log, app.2025-01-14.log, app.2025-01-13.log, ...

# Rotate when file reaches 10MB, keep last 5 files
logger.add(
    "logs/app.log",
    size_limit="10MB",
    retention=5
)

# Various size formats (all case-insensitive):
logger.add("logs/small.log", size_limit="100")      # 100 bytes
logger.add("logs/tiny.log", size_limit="500B")      # 500 bytes
logger.add("logs/kb.log", size_limit="5kb")         # 5 kilobytes (lowercase)
logger.add("logs/mb.log", size_limit="10M")         # 10 megabytes (short form)
logger.add("logs/gb.log", size_limit="1gb")         # 1 gigabyte (lowercase)
logger.add("logs/huge.log", size_limit="2TB")       # 2 terabytes

# Rotate daily OR when size reaches 500MB
logger.add(
    "logs/app.log",
    rotation="daily",
    size_limit="500MB",
    retention=10
)

# Only ERROR and above to error log
logger.add(
    "logs/errors.log",
    filter_min_level="ERROR"
)

# Only logs from specific module
logger.add(
    "logs/auth.log",
    filter_module="myapp.auth"
)

# Only logs from specific function
logger.add(
    "logs/critical.log",
    filter_min_level="CRITICAL",
    filter_function="process_payment"
)

# JSON console output
logger.add("console", json=True)

# JSON file output
logger.add("logs/app.jsonl", json=True)

# JSON with rotation
logger.add("logs/events.jsonl", json=True, rotation="daily", retention=30)

# Custom format with timestamp and level
logger.add(
    "console",
    format="{time} [{level}] {message}"
)

# JSON format for structured logging
logger.add(
    "logs/structured.log",
    format='{{"timestamp": "{time}", "level": "{level}", "message": "{message}", "extra": {extra}}}',
    date_enabled=True
)

# Simple format for debugging
logger.add(
    "logs/debug.log",
    format="{level}: {message} {extra}",
    filter_min_level="DEBUG"
)