Skip to main content

A Python logging handler for Slack integration

Project description

https://img.shields.io/pypi/pyversions/slack-logger.svg?maxAge=2592000?style=flat-square

Python logging handler for Slack web hook integration with simple configuration.

Installation

pip install slack-logger

Example

Simple

import logging
from slack_logger import SlackHandler, SlackFormatter

sh = SlackHandler('YOUR_WEB_HOOK_URL') # url is like 'https://hooks.slack.com/...'
sh.setFormatter(SlackFormatter())
logging.basicConfig(handlers=[sh])
logging.warning('warn message')

Using logger

import logging
from slack_logger import SlackHandler, SlackFormatter

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

sh = SlackHandler(username='logger', icon_emoji=':robot_face:', url='YOUR_WEB_HOOK_URL')
sh.setLevel(logging.DEBUG)

f = SlackFormatter()
sh.setFormatter(f)
logger.addHandler(sh)

logger.debug('debug message')
logger.info('info message')
logger.warn('warn message')
logger.error('error message')
logger.critical('critical message')

Using filter

You can also filter some messages only

from slack_logger import SlackLogFilter

sf = SlackLogFilter()
sh.addFilter(sf)

logger.info('info message')  # Not posted to slack
logger.info('info message to slack', extra={'notify_slack': True})  # Posted to slack

Mentioning someone

Use mention option to send message with mentioning someone:

sh = SlackHandler('YOUR_WEB_HOOK_URL', mention='U012ABC34')

You can find a member ID (e.g., U012ABC34) from user’s profile view.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
slack_logger-0.3.1-py3-none-any.whl (4.5 kB) Copy SHA256 hash SHA256 Wheel py3

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page