summaryrefslogtreecommitdiff
path: root/oslo_middleware/healthcheck/__init__.py
blob: 559770a49e763f4df8c8702563caee9150caa7e3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# Copyright 2011 OpenStack Foundation.
# All Rights Reserved.
#
#    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.

import stevedore
import webob.dec
import webob.exc
import webob.response

from oslo_middleware import base


class Healthcheck(base.Middleware):
    """Helper class that returns debug information.

    Can be inserted into any WSGI application chain to get information about
    the request and response.
    """

    NAMESPACE = "oslo.middleware.healthcheck"

    @classmethod
    def factory(cls, global_conf, **local_conf):
        """Factory method for paste.deploy."""
        conf = global_conf.copy()
        conf.update(local_conf)

        def healthcheck_filter(app):
            return cls(app, conf)
        return cls

    def __init__(self, application, conf):
        super(Healthcheck, self).__init__(application)
        self._path = conf.get('path', '/healthcheck')
        self._backend_names = []
        backends = conf.get('backends')
        if backends:
            self._backend_names = backends.split(',')

        self._backends = stevedore.NamedExtensionManager(
            self.NAMESPACE, self._backend_names,
            name_order=True, invoke_on_load=True,
            invoke_args=(conf,))

    @webob.dec.wsgify
    def process_request(self, req):
        if req.path != self._path:
            return None

        healthy = True
        reasons = []
        for ext in self._backends:
            result = ext.obj.healthcheck()
            healthy &= result.available
            if result.reason:
                reasons.append(result.reason)

        return webob.response.Response(
            status=(webob.exc.HTTPOk.code if healthy
                    else webob.exc.HTTPServiceUnavailable.code),
            body='\n'.join(reasons),
            content_type="text/plain",
        )