e744501c47
Currently application that doesn't use the global configuration object have to rely on hack to setup the global oslo config object for each middleware it want to use. For example, gnocchi have its own middleware loader and add crap to load keystonemiddleware: https://github.com/openstack/gnocchi/blob/master/gnocchi/rest/app.py#L140 And it can't use oslo.middleware that relies on the global conf object. Also aodh (use 'paste' for middleware) have to hack the global configuration object for each middlewares it want to use by code... https://review.openstack.org/#/c/208632/1/aodh/service.py But middleware are optional deployer stuffs, we should not write any code for them... This change allows application to use paste-deploy (or any middleware loader) without enforcing the application to use the global oslo.config object. If the middleware want to use oslo.config it should load the configuration file himself (and fallback to the global one if any) The proposed paste configuration to allow this is: [filter:cors] paste.filter_factory = oslo.middleware:cors oslo_config_project = aodh So the cors middleware can find and load the aodh config and what is it interested in. Also, some of them use oslo.config local, some other the global object. Some can be loaded by an middleware loader like paste, some other not. This change make consistent the way we bootstrap all middlewares. Closes-bug: #1482086 Change-Id: Iad197d1f3a386683d818b59718df34e14e15ca5c
107 lines
3.4 KiB
Python
107 lines
3.4 KiB
Python
# 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):
|
|
"""Healthcheck middleware used for monitoring.
|
|
|
|
If the path is /healthcheck, it will respond 200 with "OK" as the body.
|
|
Or 503 with the reason as the body if one of the backend report
|
|
an application issue.
|
|
|
|
Example of paste configuration:
|
|
|
|
.. code-block:: ini
|
|
|
|
[filter:healthcheck]
|
|
paste.filter_factory = oslo_middleware:Healthcheck.factory
|
|
path = /healthcheck
|
|
backends = disable_by_file
|
|
disable_by_file_path = /var/run/nova/healthcheck_disable
|
|
|
|
[pipeline:public_api]
|
|
pipeline = healthcheck sizelimit [...] public_service
|
|
|
|
|
|
Multiple filter sections can be defined if it desired to have
|
|
pipelines with different healthcheck configuration, example:
|
|
|
|
.. code-block:: ini
|
|
|
|
[pipeline:public_api]
|
|
pipeline = healthcheck_public sizelimit [...] public_service
|
|
|
|
[pipeline:admin_api]
|
|
pipeline = healthcheck_admin sizelimit [...] admin_service
|
|
|
|
[filter:healthcheck_public]
|
|
paste.filter_factory = oslo_middleware:Healthcheck.factory
|
|
path = /healthcheck_public
|
|
backends = disable_by_file
|
|
disable_by_file_path = /var/run/nova/healthcheck_public_disable
|
|
|
|
[filter:healthcheck_admin]
|
|
paste.filter_factory = oslo_middleware:Healthcheck.factory
|
|
path = /healthcheck_admin
|
|
backends = disable_by_file
|
|
disable_by_file_path = /var/run/nova/healthcheck_admin_disable
|
|
|
|
More details on available backends and their configuration can be found
|
|
on this page: :doc:`healthcheck_plugins`.
|
|
|
|
"""
|
|
|
|
NAMESPACE = "oslo.middleware.healthcheck"
|
|
|
|
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",
|
|
)
|