BitSig 0.1.2

A modern way to auto log system errors

---

Features

• Deduplicated Logging: Prevents duplicate log entries within each log file, keeping your logs concise and clean.
• Per-Level Log Files: Saves log entries to separate files by level (Debug.txt, Info.txt, Warning.txt, Error.txt, Critical.txt) for easy tracking and analysis.
• Automatic Log Cleanup: Periodically purges log entries older than your retention window (default: 24 hours), with full customization.
• Thread-Safe: All logging and cleanup operations are safe for multi-threaded environments.
• Console Output: Only errors and critical logs are printed to the console by default, with consistent formatting.
• Flexible Integration: Just call configureBitSig(logsDir) and start logging—no need to rewrite your codebase.

---

Installation

pip install BitSig

---

Quick Start

from BitSig import configureBitSig
from pathlib import Path
import logging

# Initialize BitSig (set your desired logs directory)
logsDir = Path("logs")
configureBitSig(logsDir)

# Use standard logging
def loggingErrorTest(self):
    try:
        # Simulate an error for testing
        raise ValueError("This is a test error for logging.")
    except Exception as e:
        logger.error(f"An error occurred", exc_info=True)

---

How It Works

• Deduplication: BitSig compares each new log entry (except the timestamp/level prefix) to recent entries in its level’s file and writes only unique messages.
• Cleanup: Log files are automatically cleaned in the background, keeping only entries within your retention window (default: 24 hours, configurable with LOG_RETENTION_HOURS in your .env or environment).
• Retention: Customize how long logs are kept by setting the LOG_RETENTION_HOURS environment variable.

---

Configuration

• Log Directory: Pass any Path to configureBitSig(). Directory will be created if missing.

• Log Retention: Set the number of hours to keep log entries:

  LOG_RETENTION_HOURS=48
  

  (in your .env or system environment)

• Threaded Cleanup: BitSig launches a daemon thread to clean logs every hour. No user intervention needed.

---

Advanced Usage

• Multiple Loggers: All loggers in your app will use the same log directory and handlers by default.

---

Notes

• BitSig is compatible with Python 3.8+ and all standard logging calls.
• Log file deduplication works at the message-body level for maximum efficiency.
• BitSig is optimized for long-running, high-traffic, or mission-critical systems.

---

Code Examples

You can find code examples on my GitHub repository.

---

License

This project is licensed under the Apache License, Version 2.0. Copyright 2025 Tristan McBride Sr.

---

Acknowledgements

Project by:

• Tristan McBride Sr.
• Sybil