Posts log events to Slack via API
Project description
logging_slacker
Python log handler that posts to a Slack channel. Posts to the Slack API using Python Slack SDK.
Related Repos:
- Mathias Ose: slacker_log_handler
- log-to-slack
- python-slack-logger
Installation
pip install logging_slacker
Arguments
- slack_token (str): The Slack API token if not using
webhook_url
Generate a key at https://api.slack.com/ - channel (str): The Slack channel to post to if not using
webhook_url
- webhook_url (str): The Slack webhook URL if using
webhook_url
- is_webhook (bool): Whether to use webhook_url or not (Defaults to
True
) - is_debug (bool): Doesn't send Slack messages if True (Defaults to
False
) - stack_trace (bool): Whether to include the stacktrace in the Slack message (Defaults to
True
) - username (str): The username to use for the Slack message (Not usable if using
webhook_url
) - icon_url (str): The icon URL to use for the Slack message (Not usable if using
webhook_url
) - icon_emoji (str): The icon emoji to use for the Slack message (Not usable if using
webhook_url
) - msg_len (int): The maximum length of the Slack message (Defaults to
1300
) - traceback_len (int): The maximum length of the stack_trace (Defaults to
700
) - fail_silent (bool): Whether to fail silently if the Slack API returns an error (Defaults to
False
) Defaults toFalse
. If your API key is invalid or for some other reason the API call returns an error, this option will silently ignore the API error. If you enable this setting, make sure you have another log handler that will also handle the same log events, or they may be lost entirely.
Example Python logging handler
This is how you use log_to_slack as a regular Python logging handler. This example will send a error message to a slack channel.
import logging
import os
from log_to_slack import SlackLogHandler
from log_to_slack.formatters import NoStacktraceFormatter, DefaultFormatter
WEBHOOK_URL = os.getenv("WEBHOOK_URL")
logger = logging.getLogger("debug_application")
logger.setLevel(logging.DEBUG)
default_formatter = DefaultFormatter("%(levelprefix)s %(asctime)s (%(name)s) %(message)s")
no_stacktrace_formatter = NoStacktraceFormatter("%(levelprefix)s %(asctime)s (%(name)s) %(message)s")
default_handler = logging.StreamHandler()
default_handler.setFormatter(default_formatter)
logger.addHandler(default_handler)
slack_handler = SlackLogHandler(webhook_url=WEBHOOK_URL, stack_trace=True)
slack_handler.setFormatter(no_stacktrace_formatter)
slack_handler.setLevel(logging.ERROR)
logger.addHandler(slack_handler)
# Main code
logger.debug("Test DEBUG")
logger.info("Test INFO")
logger.warning("Test WARNING")
logger.error("Test ERROR")
logger.fatal("Test FATAL")
logger.critical("Test CRITICAL")
try:
raise Exception("Test exception")
except Exception as e:
logger.exception(e)
Slack message formatting
This example use a subclass that will send a formatted message to a Slack channel. Learn More
class CustomLogHandler(SlackLogHandler):
def build_msg(self, record):
message = "> New message :\n" + record.getMessage()
return message
License
Apache 2.0
See also: https://api.slack.com/terms-of-service
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
logging_slacker-0.1.0.tar.gz
(9.6 kB
view hashes)
Built Distribution
Close
Hashes for logging_slacker-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d94c5fa93f89e29b519f2aad2a5fc6def712fbc6fa7be3077e07e2d55a94f296 |
|
MD5 | bd112fd736531fa5ab57a4161a5639f0 |
|
BLAKE2b-256 | 44916b71e0a0c9e42d7f62df846dce5d005af963c98a087e37991a8917dcf7ce |