srelogging 0.0.3

Common logging functions for SRE python scripts.

SRE Logging

Common logging setup package for SRE python programs.

If you have a Python program that's gonna be anywhere near production, or is in any way 'mission critical', it should use this package so that it can plug into our DataDog log analysis very easily.

Installation

pip install srelogging

Usage

In your program, as soon as the application starts, you'll want to call srelogging.configure_logging():

import srelogging

# ...

srelogging.configure_logging()

Additionally, if you want to specify any custom logging config (in Python logging dictConfig format) then you can specify a file path in the arguments to configure_logging():

srelogging.configure_logging("logging_config.yml")

# contents of logging_config.yml
version: 1
formatters:
  default:
    class: srelogging.UTCFormatter
    format: "%(asctime)s.%(msecs)03dZ [%(levelname)s] <%(module)s.py:%(lineno)d> %(message)s"
    datefmt: "%Y-%m-%d %H:%M:%S"
handlers:
  console:
    class: logging.StreamHandler
    level: DEBUG
    formatter: default
    stream: ext://sys.stdout
root:
  level: WARNING
  handlers: [console]