python logging rotating gzipping handler

gziplogging.py

#
# A quick tip on how to set up rotating logging handler with
# automatic gzipping of rotated files. Tested on python 3.7
#
#
# Testing tip:
#   python gziplogging.py
#   touch example.log --date='2005/01/01'
#   python gziplogging.py
#   ls -lah *.log*
#


import gzip
import os
import shutil
import logging
import logging.handlers


logging.basicConfig(level=logging.INFO)


def gzip_namer(name):
    return name + ".gz"


def gzip_rotator(src, dest):
    if os.path.exists(src):
        with open(src, "rb") as f_in:
            with gzip.open(dest, "wb") as f_out:
                shutil.copyfileobj(f_in, f_out)

        os.remove(src)


common_formatter = logging.Formatter("%(asctime)s:%(levelname)s:%(name)s:%(message)s")
gzipping_handler = logging.handlers.TimedRotatingFileHandler(
    "example.log", when="midnight"
)
gzipping_handler.namer = gzip_namer
gzipping_handler.rotator = gzip_rotator
gzipping_handler.setFormatter(common_formatter)
logging.getLogger().addHandler(gzipping_handler)

logging.info("hello world!")