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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
# 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 logging
import os
from oslo_middleware._i18n import _LW
from oslo_middleware.healthcheck import opts
from oslo_middleware.healthcheck import pluginbase
LOG = logging.getLogger(__name__)
class DisableByFilesPortsHealthcheck(pluginbase.HealthcheckBaseExtension):
"""DisableByFilesPorts healthcheck middleware plugin
This plugin checks presence of a file that is provided for a application
running on a certain port to report if the service is unavailable
or not.
Example of middleware configuration:
.. code-block:: ini
[filter:healthcheck]
paste.filter_factory = oslo_middleware:Healthcheck.factory
path = /healthcheck
backends = disable_by_files_ports
disable_by_file_paths = 5000:/var/run/keystone/healthcheck_disable, \
35357:/var/run/keystone/admin_healthcheck_disable
"""
def __init__(self, *args, **kwargs):
super(DisableByFilesPortsHealthcheck, self).__init__(*args, **kwargs)
self.oslo_conf.register_opts(opts.DISABLE_BY_FILES_OPTS,
group='healthcheck')
self.status_files = {}
paths = self._conf_get('disable_by_file_paths')
self.status_files.update(self._iter_paths_ports(paths))
@staticmethod
def _iter_paths_ports(paths):
for port_path in paths:
port_path = port_path.strip()
if port_path:
# On windows, drive letters are followed by colons,
# which makes split() return 3 elements in this case
port, path = port_path.split(":", 1)
port = int(port)
yield (port, path)
def healthcheck(self, server_port):
path = self.status_files.get(server_port)
if not path:
LOG.warning(_LW('DisableByFilesPorts healthcheck middleware'
' enabled without disable_by_file_paths set'
' for port %s') % server_port)
return pluginbase.HealthcheckResult(available=True,
reason="OK")
else:
if not os.path.exists(path):
return pluginbase.HealthcheckResult(available=True,
reason="OK")
else:
return pluginbase.HealthcheckResult(available=False,
reason="DISABLED BY FILE")
class DisableByFileHealthcheck(pluginbase.HealthcheckBaseExtension):
"""DisableByFile healthcheck middleware plugin
This plugin checks presence of a file to report if the service
is unavailable or not.
Example of middleware 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
"""
def __init__(self, *args, **kwargs):
super(DisableByFileHealthcheck, self).__init__(*args, **kwargs)
self.oslo_conf.register_opts(opts.DISABLE_BY_FILE_OPTS,
group='healthcheck')
def healthcheck(self, server_port):
path = self._conf_get('disable_by_file_path')
if not path:
LOG.warning(_LW('DisableByFile healthcheck middleware enabled '
'without disable_by_file_path set'))
return pluginbase.HealthcheckResult(
available=True, reason="OK",
details="No 'disable_by_file_path' configuration value"
" specified")
elif not os.path.exists(path):
return pluginbase.HealthcheckResult(
available=True, reason="OK",
details="Path '%s' was not found" % path)
else:
return pluginbase.HealthcheckResult(
available=False, reason="DISABLED BY FILE",
details="Path '%s' was found" % path)
|
