Skip to main content

A timezone-configurable logging package based on loguru with Shanghai timezone as default

Project description

LogFtz - Timezone-Configurable Logging Package

A Python logging package based on loguru with configurable timezone support. Defaults to Shanghai timezone (Asia/Shanghai) but allows users to set any timezone.

Features

  • 🕐 Configurable timezone support (defaults to Asia/Shanghai)
  • 📊 Configurable minimum log level (defaults to INFO)
  • 📁 Configurable log file rotation (defaults to 1 day)
  • 🗂️ Configurable log file retention (defaults to 3 days)
  • 🚀 Built on high-performance loguru library

Installation

pip install logftz

Usage

Basic Usage

from logftz import logger

logger.info("This is an info message")
logger.warning("This is a warning message")
logger.error("This is an error message")
logger.debug("This is a debug message")

Set Log Level

from logftz import logger

# Set minimum log level to DEBUG (show all logs)
logger.set_level('DEBUG')

# Set minimum log level to WARNING (hide INFO and DEBUG)
logger.set_level('WARNING')

Set Timezone

from logftz import logger

logger.set_timezone('UTC')
logger.set_timezone('America/New_York')
logger.set_timezone('Asia/Shanghai')

Set Rotation (File Size or Time)

from logftz import logger

# Rotate by file size
logger.set_rotation("100 MB")
logger.set_rotation("500 KB")

# Rotate by time
logger.set_rotation("1 day")
logger.set_rotation("12 hours")

Set Retention (Days to Keep)

from logftz import logger

# Keep last 7 days of log files
logger.set_retention(7)

# Keep last 30 days
logger.set_retention(30)

Log Output Example

12-25 14:30:15|INFO|This is an info message
12-25 14:30:16|WARNING|This is a warning message
12-25 14:30:17|ERROR|This is an error message

Default Configuration

  • Timezone: Asia/Shanghai
  • Log Level: INFO
  • Rotation: 1 day
  • Retention: 3 days
  • File Path: logs/YYYY-MM-DD.log
  • Format: MM-DD HH:mm:ss|LEVEL|MESSAGE

API Reference

Methods

  • logger.set_level(level: str): Set minimum log level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
  • logger.set_timezone(timezone: str): Set timezone for logging
  • logger.set_rotation(rotation: str): Set log file rotation (e.g., "100 MB", "1 day", "12 hours")
  • logger.set_retention(retention: int): Set number of days to keep log files

License

MIT License

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

logftz-4.1.0.tar.gz (5.8 kB view details)

Uploaded Source

File details

Details for the file logftz-4.1.0.tar.gz.

File metadata

  • Download URL: logftz-4.1.0.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.5

File hashes

Hashes for logftz-4.1.0.tar.gz
Algorithm Hash digest
SHA256 75c85d5cc93547134aa13261498d57fb4d2a6be9c6ef23acb39c43163bc440e1
MD5 7f3f93210723ea070f458601d3b997bf
BLAKE2b-256 5650074f4268f5b0a1add541d339dbdbc44cdea3eeddbfc63474e8347b35f5a5

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