Skip to main content

A customizable logger and traceback handler for Python applications

Project description

FlexiLogger

FlexiLogger is a customizable Python logging library that provides enhanced features for handling logs, including colorized console outputs, log file formatting, and detailed traceback management.

Features

  • Colorized console logging for better readability.
  • File-based logging with customizable formats.
  • Dynamic configuration via environment variables.
  • Enhanced traceback extraction and logging.
  • Customizable log level spaces for better alignment.

Installation

You can install FlexiLogger using pip:

pip install FlexiLogger

Usage

Basic Usage

To use FlexiLogger in your project:

from FlexiLogger import Logger

logger = Logger(__file__, log_file_path="app.log")
logger.info("This is an info message")
logger.error("This is an error message")

Advanced Traceback Handling

FlexiLogger provides a GetTraceback class for managing exceptions:

import os

os.environ['LOG_PATH'] = 'app.log'  # noqa
from FlexiLogger import Logger, GetTraceback

logger = Logger(__file__, log_file_open_format='w')
traceback_handler = GetTraceback(logger)

try:
    1 / 0
except Exception as e:
    traceback_handler.error("An error occurred", print_full_exception=True)

Environment Variables

FlexiLogger uses several environment variables to customize its behavior:

Variable Name Description Default Value
LOG_PATH Specifies the path to the log file. If not set, logging to a file is disabled. None
LOG_TRACEBACK_PATH Specifies the path where traceback will be saved. If not set, the file defined in the Logger will be used. None
LOGGER_CONSOLE_LOG_LEVEL Sets the console log level. Acceptable values: DEBUG, INFO, WARNING, ERROR, CRITICAL. DEBUG
LOGGER_FILE_LOG_LEVEL Sets the file log level. Acceptable values: DEBUG, INFO, WARNING, ERROR, CRITICAL. DEBUG
LOGGER_TIME_INFO Enables or disables timestamps in log messages. Values: true/1 or false/0. true

Example

Set the environment variables before running your script:

export LOG_PATH="app.log"
export LOGGER_CONSOLE_LOG_LEVEL="INFO"
export LOGGER_FILE_LOG_LEVEL="ERROR"
export LOGGER_TIME_INFO="false"

Project Structure

FlexiLogger/
├── __init__.py
├── logger.py
├── gettraceback.py
├── README.md

License

FlexiLogger is licensed under the MIT License. See the LICENSE file for details.


Contributions

Contributions are welcome! Feel free to open an issue or submit a pull request.

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

flexilogger-1.0.3.tar.gz (7.6 kB view details)

Uploaded Source

File details

Details for the file flexilogger-1.0.3.tar.gz.

File metadata

  • Download URL: flexilogger-1.0.3.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for flexilogger-1.0.3.tar.gz
Algorithm Hash digest
SHA256 7e624e2f086b856082d051979fecb4628fc1823a210394e5f6bb623f3bcfeeca
MD5 026a9806a5580438f3591602cdb4145f
BLAKE2b-256 b440f4dda0ba2fd9497c8f70171252d82c37c34b4fbb77eaa21f195cb6ef699c

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