Package: python-slack-logger
Python Slack LoggerA custom message logger to Slack for Python 3.
This project was built usingslackclientand the latestBlock Kit UI.This is the Slack alternative todiscord-loggerpackage for Discord.InstallInstall via pip:pip install python-slack-loggerBasic Usagefromslack_loggerimportSlackLoggertoken="your slack app token"options={"service_name":"Backend API","service_environment":"Production","display_hostname":True,"default_level":"info",}logger=SlackLogger(token=token,**options)channel="#my_channel"response=logger.send(channel=channel,title="Health Check",description="All services are running normally!",)Configure various optionsThere are numerous configurations available to customise the message.options={# Service name would be the name of the service sending the message to your Slack channel# This would usually be the name of the application sending the notification# If unset, the default value would be "Service""service_name":"Backend API",# Usually services would run in staging and production environments# This field is to specify the environment from which the application is reponding for easy identification# If unset, this block would not appear in the message"service_environment":"Production",# An option to specify whether or not to display the hostname in the messages# The hostname is set by default, but it could be disabled by specifically setting this to `False`"display_hostname":True,# The default importance level of the message# The left bar color of the message would change depending on this# Available options are# - default: #1F2225# - error: #DB2828# - warn: #FBBD08# - info: #2185D0# - verbose: #6417C9# - debug: #2185D0# - success: #21BA45# If the `error` field is set during the construction of the message, the `level` is automatically set to `error`# If nothing is specified, `default` color would be used"default_level":"info",}Emojis inbuilt! 😀An appropriate emoji is automatically added before the title depending on thelevel.Following is the map betweenleveland the emoji added.default =:mega:📣error =:x:❌warn =:warning:⚠️info =:bell:🔔verbose =:loud_sound:🔊debug =:microscope:🔬success =:rocket:🚀ExamplesSet Service Name and Environment for easy identificationYou can configure the log message with service name and environment for easy identification.
TheHostfield which is the hostname of the server is automatically added for every message.You can even send any meta information like the data in the variables, module names, metrics etc with themetadatafield while constructing the message.
These data should be passed as a dictionary.fromslack_loggerimportSlackLoggertoken="your slack app token"options={"service_name":"Backend API","service_environment":"Production","default_level":"info",}logger=SlackLogger(token=token,**options)channel="#my_channel"response=logger.send(channel=channel,title="Health Check",description="Issue in establishing DB connections!",error="Traceback (most recent call last):\nValueError: Database connect accepts only string as a parameter!",metadata={"module":"DBConnector","host":123.332},)Send messages without HostnameIn case you do not want the hostname to be displayed in the message, disable it by setting"display_hostname": Falsein theoptionsas follows.fromslack_loggerimportSlackLoggertoken="your slack app token"options={"service_name":"Backend API","service_environment":"Production","display_hostname":False,"default_level":"info",}logger=SlackLogger(token=token,**options)channel="#my_channel"response=logger.send(channel=channel,title="Health Check",description="All services are running normally!",)Send messages with different log-levelsThe log-level indicates the importance of the message.
It changes the color of the Slack message in particular.
Currently supported levels are,errorwarninfoverbosedebugsuccessThe log-level can be set during construction of the message like through the parameterlevel.If the parameter isn't provided, it'll be set to the one given indefault_level.
Any invalid input would be ignored and the log-level would be automatically be set todefault.Any complicated nested dictionary can be passed to themetadatafield and the message gets forrmatted accordingly for easy reading.fromslack_loggerimportSlackLoggertoken="your slack app token"options={"service_name":"Backend API","service_environment":"Production","default_level":"info",}logger=SlackLogger(token=token,**options)channel="#my_channel"response=logger.send(channel=channel,title="Celery Task Manager",description="Successfully completed training job for model v1.3.3!",level="success",metadata={"Metrics":{"Accuracy":78.9,"Inference time":"0.8 sec","Model size":"32 MB",},"Deployment status":"progress",},)Send complete error tracebackTheerrorfield can contain any error message.
It will be automatically be formatted in the final message.
For example, you can send a complete traceback of an error message to debug faster!importtracebackfromslack_loggerimportSlackLoggerdefget_traceback(e):tb=("Traceback (most recent call last):\n"+"".join(traceback.format_list(traceback.extract_tb(e.__traceback__)))+type(e).__name__+": "+str(e))returntbtoken="your slack app token"options={"service_name":"Backend API","service_environment":"Production","default_level":"info",}err=KeyError("'email' field cannot be None")logger=SlackLogger(token=token,**options)channel="#my_channel"response=logger.send(channel=channel,title="Runtime Exception",description=err.__str__(),error=get_traceback(err),metadata={"email":None,"module":"auth","method":"POST"},)