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.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

slack_logger-0.3.1-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file slack_logger-0.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for slack_logger-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b1d55c5e6c79089bf938db39d4e33756cd0e63d1f8b1743c7a99cc0c3957757c
MD5 c8311aaaf8ea634b424aa971c92da872
BLAKE2b-256 763cb6cc4e51d8021a8c20b1b0213fa9eb9cc1fb48a42dcd7215cc01ce25c4ad

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page