logging-slackhandler 2.4.0

SlackHandler

SlackHandler instances dispatch logging events to Slack Incoming Webhook.

Here is the list of its parameters:

webhook_url:

Slack Incoming Webhook URL.

username:

(optional) message sender username.

channel:

(optional) Slack channel to post to.

icon_emoji:

(optional) customize emoji for message sender.

timeout:

(optional) specifies a timeout in seconds for blocking operations.

pool_size:

(optional) specifies number of workers processing records queue.

The following example shows how to send records to a Slack Incoming Webhooks:

import logging
from SlackLogger import SlackHandler

logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)

slack_handler = SlackHandler('YOUR_WEBHOOK_URL')
logger.addHandler(slack_handler)

for level in ['debug', 'info', 'warning', 'error', 'critical']:
    getattr(logger, level)('This is a `%s` message', level)

SlackFormatter

SlackFormatter instances format log record and return a dictionary that can be sent as a Slack message attachment.

Here is the list of its parameters:

attr:

(optional) custom attachment parameters to record attributes dictionary.

lvl_color:

(optional) custom record levels to colors dictionary.

You can customize the appearance of Slack message with attr parameter, to bind a Slack attachment property to a record attribute. Empty strings will not be displayed in message.

Also, lvl_color parameter let you customize color-coding messages, binding a record levelname to an hex color code or Slack special codes (good, warning, danger).

from SlackLogger import SlackFormatter

attr={'pretext': '*Look at me!*', 'title': ''}
lvl_color={'INFO': 'good'}

slack_handler.setFormatter(SlackFormatter(attr=attr, lvl_color=lvl_color))

logger.info('Hi there!')

SlackFilter

SlackFilter instances can be use to determine if the specified record is to be sent to Slack Incoming Webhook.

Here is the list of its parameters:

allow:

filtering rule for log record.

You can use SlackFilter to allow only some records to be sent. When SlackFilter is defined, records will not be sent to Slack unless you explicitly ask it for by adding extra argument, as in following example:

from SlackLogger import SlackFilter

logger.addFilter(SlackFilter())

logger.debug('This is a debug message')
logger.info('Hi there!', extra={'slack': True})

To have the opposite behavior (sent record by default), just set allow parameter to True when creating SlackFilter:

from SlackLogger import SlackFilter

logger.addFilter(SlackFilter(allow=True))

logger.debug('This is a debug message', extra={'slack': False})
logger.info('Hi there!')