collectd/files/plugin/check_openstack_api.py

#!/usr/bin/python
# Copyright 2015 Mirantis, Inc.
#
# 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.
#
# Collectd plugin for checking the status of OpenStack API services
import collectd

import collectd_openstack as openstack

from urlparse import urlparse

PLUGIN_NAME = 'check_openstack_api'
INTERVAL = openstack.INTERVAL


class APICheckPlugin(openstack.CollectdPlugin):
    """Class to check the status of OpenStack API services."""

    # TODO(all): sahara, murano
    CHECK_MAP = {
        'keystone': {
            'path': '/', 'expect': [300], 'name': 'keystone-public-api'},
        'heat': {'path': '/', 'expect': [300], 'name': 'heat-api'},
        'heat-cfn': {'path': '/', 'expect': [300], 'name': 'heat-cfn-api'},
        'glance': {'path': '/', 'expect': [300], 'name': 'glance-api'},
        # Since Mitaka, Cinder returns 300 instead of 200 in previous releases
        'cinder': {'path': '/', 'expect': [200, 300], 'name': 'cinder-api'},
        'cinderv2': {
            'path': '/', 'expect': [200, 300], 'name': 'cinder-v2-api'},
        'neutron': {'path': '/', 'expect': [200], 'name': 'neutron-api'},
        'nova': {'path': '/', 'expect': [200], 'name': 'nova-api'},
        # Ceilometer requires authentication for all paths
        'ceilometer': {
            'path': 'v2/capabilities', 'expect': [200], 'auth': True,
            'name': 'ceilometer-api'},
        'swift': {'path': 'healthcheck', 'expect': [200], 'name': 'swift-api'},
        'swift_s3': {
            'path': 'healthcheck', 'expect': [200], 'name': 'swift-s3-api'},
    }

    def _service_url(self, endpoint, path):
        url = urlparse(endpoint)
        u = '%s://%s' % (url.scheme, url.netloc)
        if path != '/':
            u = '%s/%s' % (u, path)
        return u

    def check_api(self):
        """ Check the status of all the API services.

            Yields a list of dict items with 'service', 'status' (either OK,
            FAIL or UNKNOWN) and 'region' keys.
        """
        catalog = self.service_catalog
        for service in catalog:
            name = service['name']
            if name not in self.CHECK_MAP:
                self.logger.notice(
                    "No check found for service '%s', skipping it" % name)
                status = self.UNKNOWN
                check = {}
            else:
                check = self.CHECK_MAP[name]
                url = self._service_url(service['url'], check['path'])
                r = self.raw_get(url, token_required=check.get('auth', False))

                if r is None or r.status_code not in check['expect']:
                    def _status(ret):
                        return 'N/A' if r is None else r.status_code

                    self.logger.notice(
                        "Service %s check failed "
                        "(returned '%s' but expected '%s')" % (
                            name, _status(r), check['expect'])
                    )
                    status = self.FAIL
                else:
                    status = self.OK

            yield {
                'service': check.get('name', name),
                'status': status,
                'region': service['region']
            }

    def collect(self):
        for item in self.check_api():
            if item['status'] == self.UNKNOWN:
                # skip if status is UNKNOWN
                continue

            value = collectd.Values(
                plugin=PLUGIN_NAME,
                plugin_instance=item['service'],
                type='gauge',
                interval=INTERVAL,
                values=[item['status']],
                meta={'region': item['region']}
            )
            value.dispatch()


plugin = APICheckPlugin(collectd, PLUGIN_NAME)


def config_callback(conf):
    plugin.config_callback(conf)


def notification_callback(notification):
    plugin.notification_callback(notification)


def read_callback():
    plugin.conditional_read_callback()

collectd.register_config(config_callback)
collectd.register_notification(notification_callback)
collectd.register_read(read_callback, INTERVAL)