Skip to content

python-guide.md

Latest commit

 

History

History
78 lines (53 loc) · 3.36 KB

python-guide.md

File metadata and controls

78 lines (53 loc) · 3.36 KB
Raw

Quick-start

Installing the Python Script

It is recommended to use Python 3.6 and above with pip to install slack-sdk package. If you're unsure how to check what version of Python you're on, you can check it using the following:

Note: You may need to use python3 before your commands to ensure you use the correct Python path. e.g. python3 --version

python --version 

-- or --

python3 --version

Then proceed to install the Slack Development Kit for Python

pip install slack_sdk

Note: Depending on your Zabbix installation, whether you enable a home folder for Zabbix or not during the installation, because pip always install to non-root user environment. But if Zabbix home folder is not enabled during Zabbix installation, then it is recommended to use Python virtual environments and then copy the pip packages in that venv to /usr/local/lib/python3.6/dist-packages for Debian system

sudo apt install python3-venv
python -m venv projectAenv
mkdir -p /usr/local/lib/python3.6/dist-packages
cp -r /pathtofile/projectAenv/lib/python3.6/site-packages/* /usr/local/lib/python3.6/dist-packages

Copy slack_script.py to /usr/lib/zabbix/alertscripts. This depends on your Zabbix Server Configuration, the configuration usually can be found at /etc/zabbix/zabbix_server.conf.

Copy the Slack Token in your Slack app and paste it in client = WebClient(token=("TOKEN_HERE")) where it said TOKEN_HERE. If you don't have one already yet, checkout this URL.

The Token will looks like this xoxX-XXXXXXXXXXXXX-XXXXXXXXXXXXX-XXXXXXXXXXXXXXXXXXXXXX

Create New Media Type

Go to your Zabbix server and follow this step to create media type: Administration -> Media types -> Create media type

Enter the field then click Update new media

Create New Action

Go to your Zabbix server and follow this step to create action: Configuration -> Actions -> Trigger actions -> Create action

You can either enter the default subject and message then click Add or just leave it empty, and use the custom message from the operations tab new action new operations

The type of subject and message determine the behavior of the script for example this script works with this subject template

{HOST.NAME}*{TRIGGER.SEVERITY}*{ITEM.VALUE1}*{EVENT.ID}*{TRIGGER.STATUS}*{TRIGGER.ID}*{TRIGGER.HOSTGROUP.NAME}

# Example
EC2,Warning,30,7872822,PROBLEM,876688,group4

This section of the script is a function that will extract the required value and assign it to its corresponding variable. For example, argv1 is for keyword value and these keywords are separated by a special character that you designated in this case an asterisk "*"

def get_info(argv1):
    return message.replace(",","*").split("*")[argv1]

Add new Media To The User

Go to your Zabbix server and filling the necessary information for new user group: Administration -> Users -> Media -> Edit -> Type -> Update

add media

Example

The message will look like this example