Created
September 16, 2020 14:46
-
-
Save mpolinowski/adb16dc08fb29db6d3755dde06286799 to your computer and use it in GitHub Desktop.
Zabbix Webhook configuration
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <?xml version="1.0" encoding="UTF-8"?> | |
| <zabbix_export> | |
| <version>5.0</version> | |
| <date>2020-08-11T00:00:00Z</date> | |
| <media_types> | |
| <media_type> | |
| <name>Slack</name> | |
| <type>WEBHOOK</type> | |
| <parameters> | |
| <parameter> | |
| <name>alert_message</name> | |
| <value>{ALERT.MESSAGE}</value> | |
| </parameter> | |
| <parameter> | |
| <name>alert_subject</name> | |
| <value>{ALERT.SUBJECT}</value> | |
| </parameter> | |
| <parameter> | |
| <name>bot_token</name> | |
| <value><PLACE YOUR KEY HERE></value> | |
| </parameter> | |
| <parameter> | |
| <name>channel</name> | |
| <value>{ALERT.SENDTO}</value> | |
| </parameter> | |
| <parameter> | |
| <name>discovery_host_dns</name> | |
| <value>{DISCOVERY.DEVICE.DNS}</value> | |
| </parameter> | |
| <parameter> | |
| <name>discovery_host_ip</name> | |
| <value>{DISCOVERY.DEVICE.IPADDRESS}</value> | |
| </parameter> | |
| <parameter> | |
| <name>event_date</name> | |
| <value>{EVENT.DATE}</value> | |
| </parameter> | |
| <parameter> | |
| <name>event_id</name> | |
| <value>{EVENT.ID}</value> | |
| </parameter> | |
| <parameter> | |
| <name>event_nseverity</name> | |
| <value>{EVENT.NSEVERITY}</value> | |
| </parameter> | |
| <parameter> | |
| <name>event_opdata</name> | |
| <value>{EVENT.OPDATA}</value> | |
| </parameter> | |
| <parameter> | |
| <name>event_recovery_date</name> | |
| <value>{EVENT.RECOVERY.DATE}</value> | |
| </parameter> | |
| <parameter> | |
| <name>event_recovery_time</name> | |
| <value>{EVENT.RECOVERY.TIME}</value> | |
| </parameter> | |
| <parameter> | |
| <name>event_severity</name> | |
| <value>{EVENT.SEVERITY}</value> | |
| </parameter> | |
| <parameter> | |
| <name>event_source</name> | |
| <value>{EVENT.SOURCE}</value> | |
| </parameter> | |
| <parameter> | |
| <name>event_tags</name> | |
| <value>{EVENT.TAGS}</value> | |
| </parameter> | |
| <parameter> | |
| <name>event_time</name> | |
| <value>{EVENT.TIME}</value> | |
| </parameter> | |
| <parameter> | |
| <name>event_update_date</name> | |
| <value>{EVENT.UPDATE.DATE}</value> | |
| </parameter> | |
| <parameter> | |
| <name>event_update_status</name> | |
| <value>{EVENT.UPDATE.STATUS}</value> | |
| </parameter> | |
| <parameter> | |
| <name>event_update_time</name> | |
| <value>{EVENT.UPDATE.TIME}</value> | |
| </parameter> | |
| <parameter> | |
| <name>event_value</name> | |
| <value>{EVENT.VALUE}</value> | |
| </parameter> | |
| <parameter> | |
| <name>host_conn</name> | |
| <value>{HOST.CONN}</value> | |
| </parameter> | |
| <parameter> | |
| <name>host_name</name> | |
| <value>{HOST.HOST}</value> | |
| </parameter> | |
| <parameter> | |
| <name>slack_as_user</name> | |
| <value>true</value> | |
| </parameter> | |
| <parameter> | |
| <name>slack_mode</name> | |
| <value>alarm</value> | |
| </parameter> | |
| <parameter> | |
| <name>trigger_description</name> | |
| <value>{TRIGGER.DESCRIPTION}</value> | |
| </parameter> | |
| <parameter> | |
| <name>trigger_id</name> | |
| <value>{TRIGGER.ID}</value> | |
| </parameter> | |
| <parameter> | |
| <name>zabbix_url</name> | |
| <value>{$ZABBIX.URL}</value> | |
| </parameter> | |
| </parameters> | |
| <script>var SEVERITY_COLORS = [ | |
| '#97AAB3', '#7499FF', '#FFC859', | |
| '#FFA059', '#E97659', '#E45959' | |
| ]; | |
| | |
| var RESOLVE_COLOR = '#009900'; | |
| | |
| var SLACK_MODE_HANDLERS = { | |
| alarm: handlerAlarm, | |
| event: handlerEvent | |
| }; | |
| | |
| | |
| if (!String.prototype.format) { | |
| String.prototype.format = function() { | |
| var args = arguments; | |
| | |
| return this.replace(/{(\d+)}/g, function(match, number) { | |
| return number in args | |
| ? args[number] | |
| : match | |
| ; | |
| }); | |
| }; | |
| } | |
| | |
| function isEventProblem(params) { | |
| return params.event_value == 1 | |
| && params.event_update_status == 0 | |
| ; | |
| } | |
| | |
| function isEventUpdate(params) { | |
| return params.event_value == 1 | |
| && params.event_update_status == 1 | |
| ; | |
| } | |
| | |
| function isEventResolve(params) { | |
| return params.event_value == 0; | |
| } | |
| | |
| function getPermalink(channelId, messageTimestamp) { | |
| var req = new CurlHttpRequest(); | |
| | |
| req.AddHeader('Content-Type: application/x-www-form-urlencoded; charset=utf-8'); | |
| | |
| var resp = JSON.parse(req.Get( | |
| '{0}?token={1}&channel={2}&message_ts={3}'.format( | |
| Slack.getPermalink, | |
| params.bot_token, | |
| channelId, | |
| messageTimestamp | |
| ) | |
| )); | |
| | |
| if (req.Status != 200 && !resp.ok) { | |
| throw resp.error; | |
| } | |
| | |
| return resp.permalink; | |
| } | |
| | |
| function createProblemURL(zabbix_url, triggerid, eventid, event_source) { | |
| var problem_url = ''; | |
| if (event_source === '0') { | |
| problem_url = '{0}/tr_events.php?triggerid={1}&eventid={2}' | |
| .format( | |
| zabbix_url, | |
| triggerid, | |
| eventid | |
| ); | |
| } | |
| else { | |
| problem_url = zabbix_url; | |
| } | |
| | |
| return problem_url; | |
| } | |
| | |
| function getTagValue(event_tags, key) { | |
| var pattern = new RegExp('(' + key + ':.+)'); | |
| var tag_value = event_tags | |
| .split(',') | |
| .filter(function (v) { | |
| return v.match(pattern); | |
| }) | |
| .map(function (v) { | |
| return v.split(':')[1]; | |
| })[0] | |
| || 0; | |
| | |
| return tag_value; | |
| } | |
| | |
| function handlerAlarm(params) { | |
| var fields = { | |
| channel: params.channel, | |
| as_user: params.slack_as_user, | |
| }; | |
| | |
| if (isEventProblem(params)) { | |
| fields.attachments = [ | |
| createMessage( | |
| SEVERITY_COLORS[params.event_nseverity] || 0, | |
| params.event_date, | |
| params.event_time, | |
| createProblemURL(params.zabbix_url, params.trigger_id, params.event_id, params.event_source) | |
| ) | |
| ]; | |
| | |
| var resp = JSON.parse(req.Post(Slack.postMessage, JSON.stringify(fields))); | |
| | |
| if (req.Status != 200 && !resp.ok) { | |
| throw resp.error; | |
| } | |
| | |
| result.tags.__message_ts = resp.ts; | |
| result.tags.__channel_id = resp.channel; | |
| result.tags.__channel_name = params.channel; | |
| result.tags.__message_link = getPermalink(resp.channel, resp.ts); | |
| } | |
| else if (isEventUpdate(params)) { | |
| fields.thread_ts = getTagValue(params.event_tags, 'message_ts'); | |
| fields.attachments = [ | |
| createMessage( | |
| SEVERITY_COLORS[params.event_nseverity] || 0, | |
| params.event_update_date, | |
| params.event_update_time, | |
| createProblemURL(params.zabbix_url, params.trigger_id, params.event_id, params.event_source), | |
| true | |
| ) | |
| ]; | |
| | |
| resp = JSON.parse(req.Post(Slack.postMessage, JSON.stringify(fields))); | |
| if (req.Status != 200 && !resp.ok) { | |
| throw resp.error; | |
| } | |
| | |
| } | |
| else if (isEventResolve(params)) { | |
| fields.channel = getTagValue(params.event_tags, 'channel_id'); | |
| fields.text = ''; | |
| fields.ts = getTagValue(params.event_tags, 'message_ts'); | |
| fields.attachments = [ | |
| createMessage( | |
| RESOLVE_COLOR, | |
| params.event_date, | |
| params.event_time, | |
| createProblemURL(params.zabbix_url, params.trigger_id, params.event_id, params.event_source) | |
| ) | |
| ]; | |
| | |
| resp = JSON.parse(req.Post(Slack.chatUpdate, JSON.stringify(fields))); | |
| if (req.Status != 200 && !resp.ok) { | |
| throw resp.error; | |
| } | |
| } | |
| } | |
| | |
| function handlerEvent(params) { | |
| var fields = { | |
| channel: params.channel, | |
| as_user: params.slack_as_user | |
| }; | |
| | |
| if (isEventProblem(params)) { | |
| fields.attachments = [ | |
| createMessage( | |
| SEVERITY_COLORS[params.event_nseverity] || 0, | |
| params.event_date, | |
| params.event_time, | |
| createProblemURL(params.zabbix_url, params.trigger_id, params.event_id, params.event_source) | |
| ) | |
| ]; | |
| | |
| var resp = JSON.parse(req.Post(Slack.postMessage, JSON.stringify(fields))); | |
| | |
| if (req.Status != 200 && !resp.ok) { | |
| throw resp.error; | |
| } | |
| | |
| result.tags.__channel_name = params.channel; | |
| result.tags.__message_link = getPermalink(resp.channel, resp.ts); | |
| | |
| } | |
| else if (isEventUpdate(params)) { | |
| fields.attachments = [ | |
| createMessage( | |
| SEVERITY_COLORS[params.event_nseverity] || 0, | |
| params.event_update_date, | |
| params.event_update_time, | |
| createProblemURL(params.zabbix_url, params.trigger_id, params.event_id, params.event_source), | |
| false | |
| ) | |
| ]; | |
| | |
| resp = JSON.parse(req.Post(Slack.postMessage, JSON.stringify(fields))); | |
| | |
| if (req.Status != 200 && !resp.ok) { | |
| throw resp.error; | |
| } | |
| | |
| } | |
| else if (isEventResolve(params)) { | |
| fields.attachments = [ | |
| createMessage( | |
| RESOLVE_COLOR, | |
| params.event_recovery_date, | |
| params.event_recovery_time, | |
| createProblemURL(params.zabbix_url, params.trigger_id, params.event_id, params.event_source) | |
| ) | |
| ]; | |
| | |
| resp = JSON.parse(req.Post(Slack.postMessage, JSON.stringify(fields))); | |
| | |
| if (req.Status != 200 && !resp.ok) { | |
| throw resp.error; | |
| } | |
| } | |
| } | |
| | |
| function createMessage( | |
| event_severity_color, | |
| event_date, | |
| event_time, | |
| problem_url, | |
| isShort, | |
| messageText | |
| ) { | |
| var message = { | |
| fallback: params.alert_subject, | |
| title: params.alert_subject, | |
| color: event_severity_color, | |
| title_link: problem_url, | |
| pretext: messageText || '', | |
| | |
| fields: [ | |
| { | |
| title: 'Host', | |
| value: '{0} [{1}]'.format(params.host_name, params.host_conn), | |
| short: true | |
| }, | |
| { | |
| title: 'Event time', | |
| value: '{0} {1}'.format(event_date, event_time), | |
| short: true | |
| } | |
| ], | |
| }; | |
| | |
| if (params.event_source === '0') { | |
| message.fields.push( | |
| { | |
| title: 'Severity', | |
| value: params.event_severity, | |
| short: true | |
| }, | |
| { | |
| title: 'Opdata', | |
| value: params.event_opdata, | |
| short: true | |
| } | |
| ); | |
| } | |
| | |
| if (!isShort && params.event_source === '0') { | |
| message['actions'] = [ | |
| { | |
| type: 'button', | |
| text: 'Open in Zabbix', | |
| url: problem_url | |
| } | |
| ]; | |
| | |
| message.fields.push( | |
| { | |
| title: 'Event tags', | |
| value: params.event_tags.replace(/__.+?:(.+?,|.+)/g, '') || 'None', | |
| short: true | |
| }, | |
| { | |
| title: 'Trigger description', | |
| value: params.trigger_description, | |
| short: true | |
| } | |
| ); | |
| } | |
| | |
| if (params.event_source !== '0' || params.event_update_status === '1') { | |
| message.fields.push( | |
| { | |
| title: 'Details', | |
| value: params.alert_message, | |
| short: false | |
| } | |
| ); | |
| } | |
| | |
| return message; | |
| } | |
| | |
| function validateParams(params) { | |
| if (typeof params.bot_token !== 'string' || params.bot_token.trim() === '') { | |
| throw 'Field "bot_token" cannot be empty'; | |
| } | |
| | |
| if (typeof params.channel !== 'string' || params.channel.trim() === '') { | |
| throw 'Field "channel" cannot be empty'; | |
| } | |
| | |
| if (isNaN(params.event_id)) { | |
| throw 'Field "event_id" is not a number'; | |
| } | |
| | |
| if ([0, 1, 2, 3].indexOf(parseInt(params.event_source)) === -1) { | |
| throw 'Incorrect "event_source" parameter given: "' + params.event_source + '".\nMust be 0-3.'; | |
| } | |
| | |
| if (params.event_source !== '0') { | |
| params.event_nseverity = '0'; | |
| params.event_severity = 'Not classified'; | |
| params.event_update_status = '0'; | |
| params.slack_mode = 'event'; | |
| } | |
| | |
| if (params.event_source === '1' || params.event_source === '2') { | |
| params.event_value = '1'; | |
| } | |
| | |
| if (params.event_source === '1') { | |
| params.host_name = params.discovery_host_dns; | |
| params.host_ip = params.discovery_host_ip; | |
| } | |
| | |
| if (!~[0, 1, 2, 3, 4, 5].indexOf(parseInt(params.event_nseverity))) { | |
| throw 'Incorrect "event_nseverity" parameter given: ' + params.event_nseverity + '\nMust be 0-5.'; | |
| } | |
| | |
| if (typeof params.event_severity !== 'string' || params.event_severity.trim() === '') { | |
| throw 'Field "event_severity" cannot be empty'; | |
| } | |
| | |
| if (params.event_update_status !== '0' && params.event_update_status !== '1') { | |
| throw 'Incorrect "event_update_status" parameter given: ' + params.event_update_status + '\nMust be 0 or 1.'; | |
| } | |
| | |
| if (params.event_value !== '0' && params.event_value !== '1') { | |
| throw 'Incorrect "event_value" parameter given: ' + params.event_value + '\nMust be 0 or 1.'; | |
| } | |
| | |
| if (typeof params.host_conn !== 'string' || params.host_conn.trim() === '') { | |
| throw 'Field "host_conn" cannot be empty'; | |
| } | |
| | |
| if (typeof params.host_name !== 'string' || params.host_name.trim() === '') { | |
| throw 'Field "host_name" cannot be empty'; | |
| } | |
| | |
| if (!~['true', 'false'].indexOf(params.slack_as_user.toLowerCase())) { | |
| throw 'Incorrect "slack_as_user" parameter given: ' + params.slack_as_user + '\nMust be "true" or "false".'; | |
| } | |
| | |
| if (!~['alarm', 'event'].indexOf(params.slack_mode)) { | |
| throw 'Incorrect "slack_mode" parameter given: ' + params.slack_mode + '\nMust be "alarm" or "event".'; | |
| } | |
| | |
| if (isNaN(params.trigger_id) && params.event_source === '0') { | |
| throw 'field "trigger_id" is not a number'; | |
| } | |
| | |
| if (typeof params.zabbix_url !== 'string' || params.zabbix_url.trim() === '') { | |
| throw 'Field "zabbix_url" cannot be empty'; | |
| } | |
| | |
| if (!/^(http|https):\/\/.+/.test(params.zabbix_url)) { | |
| throw 'Field "zabbix_url" must contain a schema'; | |
| } | |
| } | |
| | |
| try { | |
| var params = JSON.parse(value); | |
| | |
| validateParams(params); | |
| | |
| var req = new CurlHttpRequest(), | |
| result = {tags: {}}; | |
| | |
| if (typeof params.HTTPProxy === 'string' && params.HTTPProxy.trim() !== '') { | |
| req.SetProxy(params.HTTPProxy); | |
| } | |
| | |
| req.AddHeader('Content-Type: application/json; charset=utf-8'); | |
| req.AddHeader('Authorization: Bearer ' + params.bot_token); | |
| | |
| var slack_endpoint = 'https://slack.com/api/'; | |
| | |
| var Slack = { | |
| postMessage: slack_endpoint + 'chat.postMessage', | |
| getPermalink: slack_endpoint + 'chat.getPermalink', | |
| chatUpdate: slack_endpoint + 'chat.update' | |
| }; | |
| | |
| params.slack_mode = params.slack_mode.toLowerCase(); | |
| params.slack_mode = params.slack_mode in SLACK_MODE_HANDLERS | |
| ? params.slack_mode | |
| : 'alarm'; | |
| | |
| SLACK_MODE_HANDLERS[params.slack_mode](params); | |
| | |
| if (params.event_source === '0') { | |
| return JSON.stringify(result); | |
| } | |
| else { | |
| return 'OK'; | |
| } | |
| } | |
| catch (error) { | |
| Zabbix.Log(4, '[ Slack Webhook ] Slack notification failed : ' + error); | |
| throw 'Slack notification failed : ' + error; | |
| }</script> | |
| <process_tags>YES</process_tags> | |
| <show_event_menu>YES</show_event_menu> | |
| <event_menu_url>{EVENT.TAGS.__message_link}</event_menu_url> | |
| <event_menu_name>Open in Slack: {EVENT.TAGS.__channel_name}</event_menu_name> | |
| <message_templates> | |
| <message_template> | |
| <event_source>TRIGGERS</event_source> | |
| <operation_mode>PROBLEM</operation_mode> | |
| <subject>Problem: {EVENT.NAME}</subject> | |
| <message>Problem started at {EVENT.TIME} on {EVENT.DATE} | |
| Problem name: {EVENT.NAME} | |
| Host: {HOST.NAME} | |
| Severity: {EVENT.SEVERITY} | |
| Operational data: {EVENT.OPDATA} | |
| Original problem ID: {EVENT.ID} | |
| {TRIGGER.URL}</message> | |
| </message_template> | |
| <message_template> | |
| <event_source>TRIGGERS</event_source> | |
| <operation_mode>RECOVERY</operation_mode> | |
| <subject>Resolved in {EVENT.DURATION}: {EVENT.NAME}</subject> | |
| <message>Problem has been resolved at {EVENT.RECOVERY.TIME} on {EVENT.RECOVERY.DATE} | |
| Problem name: {EVENT.NAME} | |
| Problem duration: {EVENT.DURATION} | |
| Host: {HOST.NAME} | |
| Severity: {EVENT.SEVERITY} | |
| Original problem ID: {EVENT.ID} | |
| {TRIGGER.URL}</message> | |
| </message_template> | |
| <message_template> | |
| <event_source>TRIGGERS</event_source> | |
| <operation_mode>UPDATE</operation_mode> | |
| <subject>Updated problem in {EVENT.AGE}: {EVENT.NAME}</subject> | |
| <message>{USER.FULLNAME} {EVENT.UPDATE.ACTION} problem at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}. | |
| {EVENT.UPDATE.MESSAGE} | |
| | |
| Current problem status is {EVENT.STATUS}, age is {EVENT.AGE}, acknowledged: {EVENT.ACK.STATUS}.</message> | |
| </message_template> | |
| <message_template> | |
| <event_source>DISCOVERY</event_source> | |
| <operation_mode>PROBLEM</operation_mode> | |
| <subject>Discovery: {DISCOVERY.DEVICE.STATUS} {DISCOVERY.DEVICE.IPADDRESS}</subject> | |
| <message>Discovery rule: {DISCOVERY.RULE.NAME} | |
| | |
| Device IP: {DISCOVERY.DEVICE.IPADDRESS} | |
| Device DNS: {DISCOVERY.DEVICE.DNS} | |
| Device status: {DISCOVERY.DEVICE.STATUS} | |
| Device uptime: {DISCOVERY.DEVICE.UPTIME} | |
| | |
| Device service name: {DISCOVERY.SERVICE.NAME} | |
| Device service port: {DISCOVERY.SERVICE.PORT} | |
| Device service status: {DISCOVERY.SERVICE.STATUS} | |
| Device service uptime: {DISCOVERY.SERVICE.UPTIME}</message> | |
| </message_template> | |
| <message_template> | |
| <event_source>AUTOREGISTRATION</event_source> | |
| <operation_mode>PROBLEM</operation_mode> | |
| <subject>Autoregistration: {HOST.HOST}</subject> | |
| <message>Host name: {HOST.HOST} | |
| Host IP: {HOST.IP} | |
| Agent port: {HOST.PORT}</message> | |
| </message_template> | |
| </message_templates> | |
| </media_type> | |
| </media_types> | |
| </zabbix_export> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment