Skip to main content

Ein vollständiger, produktionsreifer Logger mit erweiterten Features für Python-Anwendungen und Discord Bots.

Project description

🎨 SimpleColoredLogs

Professional Terminal Logger für Python mit Farben, strukturiertem Logging und vielen Features.

📦 Installation

pip install SimpleColoredLogs

Optional mit Farb-Support:

pip install SimpleColoredLogs[color]

🚀 Schnellstart

from logger import logger, Category

# Einfache Logs
logger.info(Category.API, "Server gestartet")
logger.success(Category.SYSTEM, "Konfiguration geladen")
logger.warn(Category.SECURITY, "Ungewöhnliche Aktivität")
logger.error(Category.DATABASE, "Verbindung fehlgeschlagen")

🎯 Features

  • ✅ 15+ Log-Levels (TRACE, DEBUG, INFO, SUCCESS, WARN, ERROR, CRITICAL, FATAL, etc.)
  • ✅ 50+ vordefinierte Kategorien (API, DATABASE, SECURITY, PAYMENT, etc.)
  • ✅ Farbige Terminal-Ausgabe
  • ✅ Strukturiertes Logging (JSON, Logfmt)
  • ✅ Async-Mode für High-Performance
  • ✅ Performance-Metriken
  • ✅ Context-Management
  • ✅ Exception-Handling mit Tracebacks
  • ✅ Log-Rotation & Kompression
  • ✅ Remote Logging (Syslog)
  • ✅ Sensitive Data Redaction
  • ✅ Distributed Tracing Support

📝 Verwendung

Basis-Logging

from logger import logger, Category, LogLevel

# Logger konfigurieren
logger.initialize(
    min_level=LogLevel.INFO,
    console=True,
    file_path="logs/app.log"
)

# Logs schreiben
logger.info(Category.API, "Request empfangen")
logger.success(Category.DATABASE, "Query erfolgreich")
logger.error(Category.SYSTEM, "Fehler aufgetreten")

Mit Shortcuts

from logger import logger, C

# Kürzer und übersichtlicher
logger.info(C.CORE.API, "API aufgerufen")
logger.error(C.SEC.FRAUD, "Betrugsversuch erkannt")
logger.success(C.BIZ.PAY, "Zahlung erfolgreich")

Mit Context

from logger import logger, Category

with logger.context("PaymentFlow"):
    logger.info(Category.PAYMENT, "Zahlung gestartet")
    logger.processing(Category.PAYMENT, "Verarbeite Transaktion")
    logger.success(Category.PAYMENT, "Zahlung abgeschlossen")

Mit strukturierten Daten

logger.info(
    Category.API,
    "Request verarbeitet",
    method="POST",
    endpoint="/api/users",
    status=201,
    duration_ms=45
)

Exception Handling

try:
    result = process_payment()
except Exception as e:
    logger.error(
        Category.PAYMENT,
        "Zahlung fehlgeschlagen",
        exception=e,  # Automatischer Traceback
        order_id=order_id
    )

Performance-Messung

# Mit Context Manager
with logger.measure(Category.DATABASE, "complex_query"):
    results = db.query("SELECT * FROM users")

# Als Decorator
@logger.timer(Category.API, "handle_request")
def handle_request():
    # ... code ...
    pass

🎨 Alle Log-Levels

logger.trace(Category.DEBUG, "Sehr detailliert")
logger.debug(Category.DEBUG, "Debug-Info")
logger.info(Category.SYSTEM, "Information")
logger.success(Category.SYSTEM, "Erfolgreich")
logger.loading(Category.SYSTEM, "Lädt...")
logger.processing(Category.SYSTEM, "Verarbeitet...")
logger.progress(Category.SYSTEM, "Fortschritt", percent=75)
logger.waiting(Category.NETWORK, "Wartet...")
logger.notice(Category.SYSTEM, "Wichtiger Hinweis")
logger.warn(Category.SECURITY, "Warnung")
logger.error(Category.API, "Fehler")
logger.critical(Category.SYSTEM, "Kritisch")
logger.fatal(Category.SYSTEM, "Fatal")
logger.security(Category.SECURITY, "Sicherheits-Event")

📁 Kategorien

Core System

API, DATABASE, SERVER, CACHE, AUTH, SYSTEM, CONFIG, RUNTIME

Network

NETWORK, HTTP, WEBSOCKET, GRPC, GRAPHQL, REST, DNS, CDN

Security

SECURITY, ENCRYPTION, FIREWALL, AUDIT, FRAUD, MFA

Business

BUSINESS, WORKFLOW, TRANSACTION, PAYMENT, ACCOUNTING, INVENTORY

Observability

METRICS, PERFORMANCE, HEALTH, MONITORING, TRACING

Alle 50+ Kategorien in der Dokumentation

🔧 Konfiguration

Via Code

from logger import logger, LogLevel
from pathlib import Path

logger.initialize(
    min_level=LogLevel.DEBUG,
    console=True,
    console_colorized=True,
    file_path=Path("logs/app.log"),
    file_max_size=10 * 1024 * 1024,  # 10MB
    async_mode=True,
    sampling_rate=1.0
)

Via Umgebungsvariablen

export LOG_LEVEL=DEBUG
export LOG_FILE=logs/app.log
export LOG_FORMAT=JSON
export LOG_COLORIZE=true
# Lädt automatisch Umgebungsvariablen
logger.initialize(apply_env_vars=True)

🔌 Handler & Filter

File Handler mit Rotation

from logger import logger, FileHandler
from pathlib import Path

handler = FileHandler(
    filepath=Path("logs/app.log"),
    max_size=10 * 1024 * 1024,  # 10MB
    backup_count=5,
    compress=True
)
logger.add_handler(handler)

Remote Logging

from logger import logger, NetworkHandler

handler = NetworkHandler(
    host="logs.example.com",
    port=514,
    protocol="udp"
)
logger.add_handler(handler)

Sensitive Data Redaction

# Automatisches Entfernen von Passwörtern, API-Keys, etc.
logger.enable_redaction()

logger.info(Category.AUTH, "Login mit password=secret123")
# Output: "Login mit password=[REDACTED]"

📊 Spezielle Logger

Audit Logger

from logger import AuditLogger

audit = AuditLogger()

audit.log_access(
    user="john_doe",
    resource="/api/users",
    action="READ",
    result="SUCCESS"
)

audit.log_security_event(
    event="Failed login attempts",
    severity="HIGH",
    ip="192.168.1.100"
)

Performance Logger

from logger import PerformanceLogger

perf = PerformanceLogger()

perf.log_timing("api_response", 0.045)  # 45ms
perf.log_throughput("requests", count=1000, duration=60.0)

Structured Logger

from logger import StructuredLogger, Category

struct = StructuredLogger()

struct.log_event(
    event_type="order_placed",
    category=Category.BUSINESS,
    message="Bestellung aufgegeben",
    user_id=123,
    order_id=1001,
    amount=99.99
)

📈 Metriken

# Metriken abrufen
metrics = logger.get_metrics()

print(f"Total Logs: {metrics['total_logs']}")
print(f"Errors: {metrics['error_count']}")
print(f"Avg Process Time: {metrics['avg_process_time_ms']} ms")

# Metriken zurücksetzen
logger.reset_metrics()

🌍 Distributed Tracing

# Trace-IDs für Request-Tracking
logger.set_trace_id("req-12345")
logger.set_correlation_id("corr-67890")

logger.info(Category.API, "Request verarbeitet")
# Output enthält automatisch trace_id

logger.clear_tracing()

💡 Best Practices

✅ DO

# Aussagekräftige Kategorien
logger.info(Category.API, "Request empfangen", endpoint="/users")

# Strukturierte Metadaten
logger.error(Category.DATABASE, "Query failed", 
            query=sql, error=str(e))

# Context für zusammenhängende Logs
with logger.context("OrderProcessing"):
    logger.info(Category.BUSINESS, "Verarbeite Bestellung")

# Exception-Parameter nutzen
logger.error(Category.SYSTEM, "Fehler", exception=e)

❌ DON'T

# Zu generisch
logger.info("SYSTEM", "Irgendwas ist passiert")

# Fehlende Kontext-Infos
logger.error(Category.DATABASE, "Error")

# Exception als String (kein Traceback!)
logger.error(Category.SYSTEM, f"Error: {str(e)}")

📚 Beispiele

Siehe examples/ Verzeichnis für:

  • Basic Usage
  • Async Logging
  • Web App Integration
  • Performance Monitoring
  • Audit Trails

🛠️ Requirements

  • Python 3.8+
  • colorama (optional, für Windows)

📄 Lizenz

MIT License - siehe LICENSE

🤝 Contributing

Contributions sind willkommen! Siehe CONTRIBUTING.md

📧 Support

⭐ Support

Wenn dir SimpleColoredLogs gefällt, gib uns einen ⭐ auf GitHub!


Made with ❤️ by OPPRO.NET Network

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

simplecoloredlogs-1.3.0.tar.gz (17.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

simplecoloredlogs-1.3.0-py3-none-any.whl (17.8 kB view details)

Uploaded Python 3

File details

Details for the file simplecoloredlogs-1.3.0.tar.gz.

File metadata

  • Download URL: simplecoloredlogs-1.3.0.tar.gz
  • Upload date:
  • Size: 17.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for simplecoloredlogs-1.3.0.tar.gz
Algorithm Hash digest
SHA256 e5a9a8b725d0321d4e4e9d906b01fc56587a3a373297549573986d4a641feb54
MD5 590ad3a92c647e6f7c443ca7b7efefac
BLAKE2b-256 843677564b924175163fc32a3e2431a519ada16e70dfa77616f7bd0d0976638d

See more details on using hashes here.

File details

Details for the file simplecoloredlogs-1.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for simplecoloredlogs-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5f8fc0a3ebd518b407ebddf2f85d33b1717ffb416f2ec3f5c8790c26010bf85c
MD5 00fd826427e03888a502f1820e4913f4
BLAKE2b-256 29d36e3e37eb2da07d99837aa51e83c308217d4be0f7a6a8077265b6b5aa684e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page