[WIP] Implement Slack notification plugin
Right now, Freezer-DR notification engine only supports email. This patch add support for sending notification to Slack channels. Change-Id: Ie19f71e9922750fcb295b7c808d423b2c01a1fc5
This commit is contained in:
Trinh Nguyen
parent
650bbc5755
commit
4ae1693bd0
|
|
@ -31,8 +31,8 @@ _MONITORS = [
|
|||
'StandardDriver',
|
||||
help='Driver used to get a status updates of compute nodes'),
|
||||
cfg.StrOpt('backend_name',
|
||||
help="configuration section name. This should contain your "
|
||||
"monitoring specific configuration options.")
|
||||
help='configuration section name. This should contain your '
|
||||
'monitoring specific configuration options.')
|
||||
]
|
||||
|
||||
_COMMON = [
|
||||
|
|
@ -67,73 +67,76 @@ _FENCER = [
|
|||
_KEYSTONE_AUTH_TOKEN = [
|
||||
cfg.StrOpt('auth_uri',
|
||||
help='OpenStack auth URI i.e. http://controller:5000',
|
||||
dest='auth_uri'), cfg.StrOpt(
|
||||
'auth_url',
|
||||
dest='auth_uri'),
|
||||
cfg.StrOpt('auth_url',
|
||||
help='OpenStack auth URL i.e. http://controller:35357/v3',
|
||||
dest='auth_url'),
|
||||
cfg.StrOpt('auth_plugin',
|
||||
help='OpenStack auth plugin i.e. ( password, token, ...) '
|
||||
'password is the only available plugin for the time being',
|
||||
dest='auth_plugin'), cfg.StrOpt('username',
|
||||
'password is the only available plugin for the time '
|
||||
'being',
|
||||
dest='auth_plugin'),
|
||||
cfg.StrOpt('username',
|
||||
help='OpenStack username',
|
||||
dest='username'),
|
||||
cfg.StrOpt('password',
|
||||
help='OpenStack Password',
|
||||
dest='password'), cfg.StrOpt('project_name',
|
||||
dest='password'),
|
||||
cfg.StrOpt('project_name',
|
||||
help='OpenStack Project Name.',
|
||||
dest='project_name'),
|
||||
cfg.StrOpt('domain_name',
|
||||
help='OpenStack domain Name.',
|
||||
dest='domain_name'), cfg.StrOpt(
|
||||
'project_domain_id',
|
||||
dest='domain_name'),
|
||||
cfg.StrOpt('project_domain_id',
|
||||
help='OpenStack Project Domain id, default is Default',
|
||||
dest='project_domain_id'),
|
||||
cfg.StrOpt('user_domain_id',
|
||||
help='OpenStack user Domain id, default is Default',
|
||||
dest='user_domain_id'), cfg.StrOpt(
|
||||
'project_domain_name',
|
||||
dest='user_domain_id'),
|
||||
cfg.StrOpt('project_domain_name',
|
||||
help='OpenStack Project Domain name, default is Default',
|
||||
dest='project_domain_name'), cfg.StrOpt(
|
||||
'user_domain_name',
|
||||
dest='project_domain_name'),
|
||||
cfg.StrOpt('user_domain_name',
|
||||
help='OpenStack user Domain name, default is Default',
|
||||
dest='user_domain_name'),
|
||||
cfg.DictOpt('kwargs',
|
||||
help='OpenStack Authentication arguments you can pass it here '
|
||||
'as Key:Value, Key1:Value1, ... ',
|
||||
help='OpenStack Authentication arguments you can pass it here'
|
||||
' as Key:Value, Key1:Value1, ... ',
|
||||
dest='kwargs',
|
||||
default={})
|
||||
]
|
||||
|
||||
_EVACUATION = [
|
||||
cfg.StrOpt(
|
||||
'driver',
|
||||
cfg.StrOpt('driver',
|
||||
default='freezer_dr.evacuators.drivers.default.standard.'
|
||||
'StandardEvacuator',
|
||||
help='Time in seconds to wait between retries to disable compute'
|
||||
' node or put it in maintenance mode. Default 10 seconds',
|
||||
dest='driver'), cfg.IntOpt(
|
||||
'wait',
|
||||
help='Time in seconds to wait between retries to disable '
|
||||
'compute node or put it in maintenance mode. Default '
|
||||
'10 seconds',
|
||||
dest='driver'),
|
||||
cfg.IntOpt('wait',
|
||||
default=10,
|
||||
help='Time in seconds to wait between retries to disable compute'
|
||||
' node or put it in maintenance mode. Default 10 seconds',
|
||||
help='Time in seconds to wait between retries to disable '
|
||||
'compute node or put it in maintenance mode. Default '
|
||||
'10 seconds',
|
||||
dest='wait'),
|
||||
cfg.IntOpt('retries',
|
||||
default=1,
|
||||
help='Number of retries to put node in maintenance mode before '
|
||||
'reporting failure to evacuate the node',
|
||||
help='Number of retries to put node in maintenance mode before'
|
||||
' reporting failure to evacuate the node',
|
||||
dest='retries'),
|
||||
cfg.BoolOpt('shared-storage',
|
||||
default=False,
|
||||
help='Set this option to True in case your compute nodes are '
|
||||
'running on a shared storage or False if not',
|
||||
dest='shared_storage'),
|
||||
cfg.DictOpt(
|
||||
'options',
|
||||
cfg.DictOpt('options',
|
||||
default={},
|
||||
help='Dict contains kwargs to be passed to the evacuator driver'
|
||||
'. In case you have additional args needs to be passed to '
|
||||
'your evacuator please, list them as key0:value0, '
|
||||
'key1:value1, ....',
|
||||
help='Dict contains kwargs to be passed to the evacuator '
|
||||
'driver. In case you have additional args needs to be '
|
||||
'passed to your evacuator please, list them as '
|
||||
'key0:value0, key1:value1, ...',
|
||||
dest='options')
|
||||
]
|
||||
|
||||
|
|
@ -143,21 +146,23 @@ _NOTIFIERS = [
|
|||
'StandardEmail',
|
||||
dest='driver',
|
||||
help='Notification driver to load it to notify users '
|
||||
'if something went wrong'),
|
||||
'if something went wrong. There are two supported drivers'
|
||||
': freezer_dr.notifiers.drivers.default.default_email.'
|
||||
'StandardEmail and freezer_dr.notifiers.drivers.default.'
|
||||
'slack.slack.SlackNotifier'),
|
||||
cfg.StrOpt('endpoint',
|
||||
default=None,
|
||||
dest='endpoint',
|
||||
help='Endpoint URL for the notification system. If you the '
|
||||
'driver you are using doesnot require any URL just comment '
|
||||
'it or use none'),
|
||||
cfg.StrOpt(
|
||||
'username',
|
||||
'driver you are using doesnot require any URL just comment'
|
||||
' it or use none'),
|
||||
cfg.StrOpt('username',
|
||||
default=None,
|
||||
dest='username',
|
||||
help='Username to authenticate against the notification system. '
|
||||
'If the driver you are using doesnot require any '
|
||||
'authentications comment or use None'), cfg.StrOpt(
|
||||
'password',
|
||||
help='Username to authenticate against the notification system.'
|
||||
' If the driver you are using doesnot require any '
|
||||
'authentications comment or use None'),
|
||||
cfg.StrOpt('password',
|
||||
default=None,
|
||||
dest='password',
|
||||
help='Password to authenticate against the notification system. '
|
||||
|
|
@ -173,13 +178,15 @@ _NOTIFIERS = [
|
|||
dest='options',
|
||||
help='Key:Value Kwargs to pass it to the notification driver, '
|
||||
'if you want to pass any special arguments for your '
|
||||
'driver. '),
|
||||
'driver. If you want to use the SlackNotifier driver, '
|
||||
'set as: options = slack_timeout:512,'
|
||||
'slack_ca_certs:/ca.crt,slack_insecured:True'),
|
||||
cfg.ListOpt('notify-list',
|
||||
default=[],
|
||||
dest='notify-list',
|
||||
help='List of emails to sent them notification if something '
|
||||
'went wrong and Freezer DR wasnot able to send an email to the '
|
||||
'tenant admin'),
|
||||
'went wrong and Freezer DR wasnot able to send an email '
|
||||
'to the tenant admin'),
|
||||
cfg.StrOpt('notify-from',
|
||||
dest='notify-from',
|
||||
help='The sender address, it can be email address if we used '
|
||||
|
|
@ -241,12 +248,12 @@ def build_os_options():
|
|||
help='Specify the region to use. Defaults to '
|
||||
'env[OS_REGION_NAME].',
|
||||
dest='os_region_name'),
|
||||
cfg.StrOpt(
|
||||
'os-token',
|
||||
cfg.StrOpt('os-token',
|
||||
default=env('OS_TOKEN'),
|
||||
help='Specify an existing token to use instead of retrieving'
|
||||
' one via authentication (e.g. with username & '
|
||||
'password). Defaults to env[OS_TOKEN].',
|
||||
help='Specify an existing token to use instead of '
|
||||
'retrieving one via authentication (e.g. '
|
||||
'with username & password). Defaults to '
|
||||
'env[OS_TOKEN].',
|
||||
dest='os_token'),
|
||||
cfg.StrOpt('os-identity-api-version',
|
||||
default=env('OS_IDENTITY_API_VERSION'),
|
||||
|
|
@ -258,8 +265,8 @@ def build_os_options():
|
|||
'admin', 'adminURL'],
|
||||
default=env('OS_ENDPOINT_TYPE') or 'public',
|
||||
help='Endpoint type to select. Valid endpoint types: '
|
||||
'"public" or "publicURL", "internal" or "internalURL",'
|
||||
' "admin" or "adminURL". Defaults to '
|
||||
'"public" or "publicURL", "internal" or "internalURL"'
|
||||
', "admin" or "adminURL". Defaults to '
|
||||
'env[OS_ENDPOINT_TYPE] or "public"',
|
||||
dest='os_endpoint_type'),
|
||||
]
|
||||
|
|
@ -297,8 +304,8 @@ def configure():
|
|||
notifiers_grp = cfg.OptGroup('notifiers',
|
||||
title='Notification Options',
|
||||
help='Notification Driver/plugin opts to be '
|
||||
'used to Notify admins/users if failure '
|
||||
'happens')
|
||||
'used to Notify admins/users if failure'
|
||||
' happens')
|
||||
CONF.register_group(notifiers_grp)
|
||||
CONF.register_opts(_NOTIFIERS, group='notifiers')
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,149 @@
|
|||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
from oslo_log import log
|
||||
from freezer_dr.notifiers.common.driver import NotifierBaseDriver
|
||||
from datetime import date
|
||||
from six.moves import urllib
|
||||
import requests
|
||||
import json
|
||||
import time
|
||||
|
||||
|
||||
LOG = log.getLogger(__name__)
|
||||
|
||||
|
||||
class SlackNotifier(NotifierBaseDriver):
|
||||
|
||||
MAX_CACHE_SIZE = 100
|
||||
RESPONSE_OK = 'ok'
|
||||
|
||||
_raw_data_url_caches = []
|
||||
|
||||
def __init__(self, url, username, password, templates_dir, notify_from,
|
||||
admin_list=None, **kwargs):
|
||||
super(SlackNotifier, self).__init__(url, username, password,
|
||||
templates_dir, notify_from,
|
||||
admin_list, **kwargs)
|
||||
LOG.info('Initializing SlackNotifier driver @ {0}'.format(url))
|
||||
|
||||
self.slack_timeout = kwargs.get('slack_timeout', '')
|
||||
self.slack_ca_certs = kwargs.get('slack_ca_certs', '')
|
||||
self.slack_insecured = kwargs.get('slack_insecured', 'True')
|
||||
self.slack_proxy = kwargs.get('slack_proxy', '')
|
||||
|
||||
def _build_slack_message(self, node, status):
|
||||
"""Builds slack message body
|
||||
"""
|
||||
body = {
|
||||
'title': 'Host Evacuation status',
|
||||
'host': node.get('host'),
|
||||
'tenants': node.get('tenants'),
|
||||
'instances': node.get('instances'),
|
||||
'hypervisor': node.get('details'),
|
||||
'evacuation_time': date.fromtimestamp(time.time()),
|
||||
'status': status
|
||||
}
|
||||
slack_request = {}
|
||||
slack_request['text'] = json.dumps(body, indent=3)
|
||||
|
||||
return slack_request
|
||||
|
||||
def _check_response(self, result):
|
||||
if 'application/json' in result.headers.get('Content-Type'):
|
||||
response = result.json()
|
||||
if response.get(self.RESPONSE_OK):
|
||||
return True
|
||||
else:
|
||||
LOG.error('Received an error message when trying to send to slack. error={}'
|
||||
.format(response.get('error')))
|
||||
return False
|
||||
elif self.RESPONSE_OK == result.text:
|
||||
return True
|
||||
else:
|
||||
LOG.error('Received an error message when trying to send to slack. error={}'
|
||||
.format(result.text))
|
||||
return False
|
||||
|
||||
def _send_message(self, request_options):
|
||||
try:
|
||||
url = request_options.get('url')
|
||||
result = requests.post(**request_options)
|
||||
if result.status_code not in range(200, 300):
|
||||
LOG.error('Received an HTTP code {} when trying to post on URL {}.'
|
||||
.format(result.status_code, url))
|
||||
return False
|
||||
|
||||
# Slack returns 200 ok even if the token is invalid. Response has valid error message
|
||||
if self._check_response(result):
|
||||
LOG.info('Notification successfully posted.')
|
||||
return True
|
||||
|
||||
LOG.error('Failed to send to slack on URL {}.'.format(url))
|
||||
return False
|
||||
except Exception as err:
|
||||
LOG.error('Error trying to send to slack on URL {}. Detail: {}'
|
||||
.format(url, err))
|
||||
return False
|
||||
|
||||
|
||||
|
||||
def notify_status(self, node, status):
|
||||
"""Notify the Host Evacuation status via slack
|
||||
Posts on the given url
|
||||
"""
|
||||
|
||||
slack_message = self._build_slack_message(node, status)
|
||||
address = self.url
|
||||
address = address.replace('#', '%23')
|
||||
|
||||
parsed_url = urllib.parse.urlsplit(address)
|
||||
query_params = urllib.parse.parse_qs(parsed_url.query)
|
||||
url = urllib.parse.urljoin(address, urllib.parse.urlparse(address).path)
|
||||
|
||||
verify = self.slack_ca_certs or not self.slack_insecured
|
||||
|
||||
proxy = self.slack_proxy
|
||||
proxy_dict = None
|
||||
if proxy is not None:
|
||||
proxy_dict = {'https': proxy}
|
||||
|
||||
data_format_list = ['json', 'data']
|
||||
if url in SlackNotifier._raw_data_url_caches:
|
||||
data_format_list = ['data']
|
||||
|
||||
for data_format in data_format_list:
|
||||
LOG.info('Trying to send message to {} as {}'
|
||||
.format(url, data_format))
|
||||
request_options = {
|
||||
'url': url,
|
||||
'verify': verify,
|
||||
'params': query_params,
|
||||
'proxies': proxy_dict,
|
||||
'timeout': self.slack_timeout,
|
||||
data_format: slack_message
|
||||
}
|
||||
if self._send_message(request_options):
|
||||
if (data_format == 'data' and
|
||||
url not in SlackNotifier._raw_data_url_caches and
|
||||
len(SlackNotifier._raw_data_url_caches) < self.MAX_CACHE_SIZE):
|
||||
SlackNotifier._raw_data_url_caches.append(url)
|
||||
return True
|
||||
|
||||
LOG.info('Failed to send message to {} as {}'
|
||||
.format(url, data_format))
|
||||
return False
|
||||
|
||||
def notify(self, message):
|
||||
pass
|
||||
|
||||
Loading…
Reference in New Issue