Skip to main content

LoggingHandler to write directly into compressed archives and automatically limit disk usage

Project description

CompressedLogger

https://img.shields.io/pypi/v/compressedlogger.svg

This is a logging handler to be used with the standard python logging module. The handler compresses the *.log logfiles directly into a *.gz archive without writing an uncompressed file. You can choose the maximum size of a single *.gz file and the overall maximum size of all compressed logs. This allows you to limit the diskspace usage of your logs directly in the handler. You can also set a header string which will be written at the beginning of every new log file.

Behaviour:

  • Once the file size of the current log reaches the maximum size it gets rotated

  • Once the file sizes of all written logs together exceed the overall maximum size, the oldest logs will be deleted

  • If a header was given, it will be written at the beginning of every log file

The size limits are not completely strict. Each gzip file will be slightly larger than the maximum size since a gzip file needs to be flushed before closing it, which always adds some more bytes. E.g., when the limit is set to 1 MB, the actual filesize of a compressed log will be around 1.1 MB.

Usage:

There are five parameters:

  • log_path (str): path to the folder where the logs should be stored

  • filename (str): the base name of the logfile mylog

  • single_max_size (int): the maximum size of a single *.gz file in megabytes

  • overall_size (int): the maximum size of all *.gz files in megabytes

  • header (str): optional header that is written at the beginning of every logfile

compressed_handler = CompressedLogger(log_path="logs/",
                                      filename="foolog.log",
                                      header="----- version: 1.0.32 -----",
                                      single_max_size=1,
                                      overall_size=5)

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.2.4 (2020-07-15)

  • updated project information and readme

0.2.0 (2020-07-15)

  • some improvements concerning the log paths and log file names

0.1.0 (2020-07-14)

  • First release on PyPI.

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

compressedlogger-0.2.4.tar.gz (9.2 kB view details)

Uploaded Source

Built Distribution

compressedlogger-0.2.4-py2.py3-none-any.whl (5.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file compressedlogger-0.2.4.tar.gz.

File metadata

  • Download URL: compressedlogger-0.2.4.tar.gz
  • Upload date:
  • Size: 9.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.2

File hashes

Hashes for compressedlogger-0.2.4.tar.gz
Algorithm Hash digest
SHA256 c4a22a1eb49bb2b2c81bd15b10897129cb13e38d5b27afef3f52ba90d58d6f30
MD5 53d7bf441f9ef313aa2572bc6f067bac
BLAKE2b-256 82855513fad36702a02c33d347c1de44299195b2249526694487d8a467ac9261

See more details on using hashes here.

File details

Details for the file compressedlogger-0.2.4-py2.py3-none-any.whl.

File metadata

  • Download URL: compressedlogger-0.2.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 5.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.2

File hashes

Hashes for compressedlogger-0.2.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5154827ce0a53f3e3f26512d1c8d9d1a675061c507368317b0a1e73058643543
MD5 13e421c2200c898f510066d98b69f2eb
BLAKE2b-256 74511521a47f0268eb75badf7b08b27334c8429c54f270f80d59c27a9d53886b

See more details on using hashes here.

Supported by

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