1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
community.general/plugins/callback/nrdp.py

196 lines
6.6 KiB
Python
Raw Normal View History

2020-03-09 10:11:07 +01:00
# -*- coding: utf-8 -*-
# (c) 2018 Remi Verchere <remi@verchere.fr>
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
2020-03-09 10:11:07 +01:00
# Make coding more python3-ish
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
DOCUMENTATION = '''
2021-01-12 07:12:03 +01:00
name: nrdp
2020-03-09 10:11:07 +01:00
type: notification
author: "Remi VERCHERE (@rverchere)"
2021-06-27 09:57:51 +02:00
short_description: Post task results to a Nagios server through nrdp
2020-03-09 10:11:07 +01:00
description:
2021-06-27 09:57:51 +02:00
- This callback send playbook result to Nagios.
- Nagios shall use NRDP to recive passive events.
- The passive check is sent to a dedicated host/service for Ansible.
2020-03-09 10:11:07 +01:00
options:
url:
2021-06-27 09:57:51 +02:00
description: URL of the nrdp server.
required: true
2020-03-09 10:11:07 +01:00
env:
- name : NRDP_URL
ini:
- section: callback_nrdp
key: url
2021-06-27 09:57:51 +02:00
type: string
2020-03-09 10:11:07 +01:00
validate_certs:
2021-06-27 09:57:51 +02:00
description: Validate the SSL certificate of the nrdp server. (Used for HTTPS URLs.)
2020-03-09 10:11:07 +01:00
env:
- name: NRDP_VALIDATE_CERTS
ini:
- section: callback_nrdp
key: validate_nrdp_certs
- section: callback_nrdp
key: validate_certs
2021-06-27 09:57:51 +02:00
type: boolean
default: false
2020-03-09 10:11:07 +01:00
aliases: [ validate_nrdp_certs ]
token:
2021-06-27 09:57:51 +02:00
description: Token to be allowed to push nrdp events.
required: true
2020-03-09 10:11:07 +01:00
env:
- name: NRDP_TOKEN
ini:
- section: callback_nrdp
key: token
2021-06-27 09:57:51 +02:00
type: string
2020-03-09 10:11:07 +01:00
hostname:
2021-06-27 09:57:51 +02:00
description: Hostname where the passive check is linked to.
required: true
2020-03-09 10:11:07 +01:00
env:
- name : NRDP_HOSTNAME
ini:
- section: callback_nrdp
key: hostname
2021-06-27 09:57:51 +02:00
type: string
2020-03-09 10:11:07 +01:00
servicename:
2021-06-27 09:57:51 +02:00
description: Service where the passive check is linked to.
required: true
2020-03-09 10:11:07 +01:00
env:
- name : NRDP_SERVICENAME
ini:
- section: callback_nrdp
key: servicename
2021-06-27 09:57:51 +02:00
type: string
2020-03-09 10:11:07 +01:00
'''
import os
import json
from ansible.module_utils.six.moves.urllib.parse import urlencode
from ansible.module_utils.common.text.converters import to_bytes
2020-03-09 10:11:07 +01:00
from ansible.module_utils.urls import open_url
from ansible.plugins.callback import CallbackBase
class CallbackModule(CallbackBase):
'''
send ansible-playbook to Nagios server using nrdp protocol
'''
CALLBACK_VERSION = 2.0
CALLBACK_TYPE = 'notification'
CALLBACK_NAME = 'community.general.nrdp'
CALLBACK_NEEDS_WHITELIST = True
# Nagios states
OK = 0
WARNING = 1
CRITICAL = 2
UNKNOWN = 3
def __init__(self):
super(CallbackModule, self).__init__()
self.printed_playbook = False
self.playbook_name = None
self.play = None
def set_options(self, task_keys=None, var_options=None, direct=None):
super(CallbackModule, self).set_options(task_keys=task_keys, var_options=var_options, direct=direct)
self.url = self.get_option('url')
if not self.url.endswith('/'):
self.url += '/'
self.token = self.get_option('token')
self.hostname = self.get_option('hostname')
self.servicename = self.get_option('servicename')
self.validate_nrdp_certs = self.get_option('validate_certs')
if (self.url or self.token or self.hostname or
self.servicename) is None:
self._display.warning("NRDP callback wants the NRDP_URL,"
" NRDP_TOKEN, NRDP_HOSTNAME,"
" NRDP_SERVICENAME"
" environment variables'."
" The NRDP callback plugin is disabled.")
self.disabled = True
def _send_nrdp(self, state, msg):
'''
nrpd service check send XMLDATA like this:
<?xml version='1.0'?>
<checkresults>
<checkresult type='service'>
<hostname>somehost</hostname>
<servicename>someservice</servicename>
<state>1</state>
<output>WARNING: Danger Will Robinson!|perfdata</output>
</checkresult>
</checkresults>
'''
xmldata = "<?xml version='1.0'?>\n"
xmldata += "<checkresults>\n"
xmldata += "<checkresult type='service'>\n"
xmldata += "<hostname>%s</hostname>\n" % self.hostname
xmldata += "<servicename>%s</servicename>\n" % self.servicename
xmldata += "<state>%d</state>\n" % state
xmldata += "<output>%s</output>\n" % msg
xmldata += "</checkresult>\n"
xmldata += "</checkresults>\n"
body = {
'cmd': 'submitcheck',
'token': self.token,
'XMLDATA': to_bytes(xmldata)
2020-03-09 10:11:07 +01:00
}
try:
response = open_url(self.url,
data=urlencode(body),
method='POST',
validate_certs=self.validate_nrdp_certs)
return response.read()
except Exception as ex:
self._display.warning("NRDP callback cannot send result {0}".format(ex))
def v2_playbook_on_play_start(self, play):
'''
Display Playbook and play start messages
'''
self.play = play
def v2_playbook_on_stats(self, stats):
'''
Display info about playbook statistics
'''
name = self.play
gstats = ""
hosts = sorted(stats.processed.keys())
critical = warning = 0
for host in hosts:
stat = stats.summarize(host)
gstats += "'%s_ok'=%d '%s_changed'=%d \
'%s_unreachable'=%d '%s_failed'=%d " % \
(host, stat['ok'], host, stat['changed'],
host, stat['unreachable'], host, stat['failures'])
# Critical when failed tasks or unreachable host
critical += stat['failures']
critical += stat['unreachable']
# Warning when changed tasks
warning += stat['changed']
msg = "%s | %s" % (name, gstats)
if critical:
# Send Critical
self._send_nrdp(self.CRITICAL, msg)
elif warning:
# Send Warning
self._send_nrdp(self.WARNING, msg)
else:
# Send OK
self._send_nrdp(self.OK, msg)