slack-logger-python 0.0.0

Slack logger utilizing python logging interface.

Slack Python Logging

Slack logger implementing the python logging interface to be used with the standard logging tools in python.

A handler and a formatter is provided, currently working with a webhook url only.

Messages are fully customizable using slacks block layout, see Creating rich message layouts and Reference: Layout blocks.

Ment as an logger post messages to slack.

Getting Started

1. Install with pip install slack-logger-python.
2. Now, you can use the slack_logger logger in your python code.

Basic Example with Plain Messages

from slack_logger import SlackFormatter, SlackHandler

logger = logging.getLogger(__name__)

formatter = SlackFormatter.plain() # plain message, no decorations
handler = SlackHandler.from_webhook(os.environ["SLACK_WEBHOOK"])
handler.setFormatter(formatter)
handler.setLevel(logging.WARN)

logger.addHandler(handler)

logger.info("I won't appear.")
logger.warning("I will show up.")
logger.error("Mee too.")

Visually Appealing Messages

You can use the SlackFormatter.minimal() and SlackFormatter.default() formatter for more visually appealing log messages. For now, those require a configuration to show e.g. the header. Everything else stays the same:

from slack_logger import Configuration, SlackFormatter, SlackHandler

logger = logging.getLogger(__name__)

config = Configuration(service="testrunner", environment="test", extra_fields={"foo": "bar"})
formatter = SlackFormatter.default(config)
handler = SlackHandler.from_webhook(os.environ["SLACK_WEBHOOK"])
handler.setFormatter(formatter)
handler.setLevel(logging.WARN)

logger.addHandler(handler)

logger.info("I won't appear.")
logger.warning("I will show up.")
logger.error("Mee too.")