initial commit
This commit is contained in:
Phillip Smith
839
api/python/livestatus.py
Normal file
839
api/python/livestatus.py
Normal file
@@ -0,0 +1,839 @@
|
||||
#!/usr/bin/python
|
||||
# -*- encoding: utf-8; py-indent-offset: 4 -*-
|
||||
# +------------------------------------------------------------------+
|
||||
# | ____ _ _ __ __ _ __ |
|
||||
# | / ___| |__ ___ ___| | __ | \/ | |/ / |
|
||||
# | | | | '_ \ / _ \/ __| |/ / | |\/| | ' / |
|
||||
# | | |___| | | | __/ (__| < | | | | . \ |
|
||||
# | \____|_| |_|\___|\___|_|\_\___|_| |_|_|\_\ |
|
||||
# | |
|
||||
# | Copyright Mathias Kettner 2014 mk@mathias-kettner.de |
|
||||
# +------------------------------------------------------------------+
|
||||
#
|
||||
# This file is part of Check_MK.
|
||||
# The official homepage is at http://mathias-kettner.de/check_mk.
|
||||
#
|
||||
# check_mk is free software; you can redistribute it and/or modify it
|
||||
# under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation in version 2. check_mk is distributed
|
||||
# in the hope that it will be useful, but WITHOUT ANY WARRANTY; with-
|
||||
# out even the implied warranty of MERCHANTABILITY or FITNESS FOR A
|
||||
# PARTICULAR PURPOSE. See the GNU General Public License for more de-
|
||||
# tails. You should have received a copy of the GNU General Public
|
||||
# License along with GNU Make; see the file COPYING. If not, write
|
||||
# to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
|
||||
# Boston, MA 02110-1301 USA.
|
||||
|
||||
import socket, time, re, os
|
||||
import ast
|
||||
|
||||
"""MK Livestatus Python API"""
|
||||
|
||||
# .--Globals-------------------------------------------------------------.
|
||||
# | ____ _ _ _ |
|
||||
# | / ___| | ___ | |__ __ _| |___ |
|
||||
# | | | _| |/ _ \| '_ \ / _` | / __| |
|
||||
# | | |_| | | (_) | |_) | (_| | \__ \ |
|
||||
# | \____|_|\___/|_.__/ \__,_|_|___/ |
|
||||
# | |
|
||||
# +----------------------------------------------------------------------+
|
||||
# | Global variables and Exception classes |
|
||||
# '----------------------------------------------------------------------'
|
||||
|
||||
# Keep a global array of persistant connections
|
||||
persistent_connections = {}
|
||||
|
||||
# Regular expression for removing Cache: headers if caching is not allowed
|
||||
remove_cache_regex = re.compile("\nCache:[^\n]*")
|
||||
|
||||
class MKLivestatusException(Exception):
|
||||
|
||||
def __init__(self, value):
|
||||
self.parameter = value
|
||||
super(MKLivestatusException, self).__init__(value)
|
||||
|
||||
def __str__(self):
|
||||
return str(self.parameter)
|
||||
|
||||
class MKLivestatusSocketError(MKLivestatusException):
|
||||
pass
|
||||
|
||||
class MKLivestatusSocketClosed(MKLivestatusSocketError):
|
||||
pass
|
||||
|
||||
class MKLivestatusConfigError(MKLivestatusException):
|
||||
pass
|
||||
|
||||
class MKLivestatusQueryError(MKLivestatusException):
|
||||
pass
|
||||
|
||||
class MKLivestatusNotFoundError(MKLivestatusException):
|
||||
def __str__(self):
|
||||
return "No matching entries found for query %s" % str(self.parameter)
|
||||
|
||||
class MKLivestatusTableNotFoundError(MKLivestatusException):
|
||||
pass
|
||||
|
||||
# We need some unique value here
|
||||
NO_DEFAULT = lambda: None
|
||||
|
||||
|
||||
|
||||
#.
|
||||
# .--Helpers-------------------------------------------------------------.
|
||||
# | _ _ _ |
|
||||
# | | | | | ___| |_ __ ___ _ __ ___ |
|
||||
# | | |_| |/ _ \ | '_ \ / _ \ '__/ __| |
|
||||
# | | _ | __/ | |_) | __/ | \__ \ |
|
||||
# | |_| |_|\___|_| .__/ \___|_| |___/ |
|
||||
# | |_| |
|
||||
# +----------------------------------------------------------------------+
|
||||
# | Helper class implementing some generic shortcut functions, e.g. |
|
||||
# | for fetching just one row or one single value. |
|
||||
# '----------------------------------------------------------------------'
|
||||
|
||||
class Helpers:
|
||||
def query(self, query, add_headers = ""):
|
||||
raise NotImplementedError()
|
||||
|
||||
|
||||
def query_value(self, query, deflt = NO_DEFAULT):
|
||||
"""Issues a query that returns exactly one line and one columns and returns
|
||||
the response as a single value"""
|
||||
result = self.query(query, "ColumnHeaders: off\n")
|
||||
try:
|
||||
return result[0][0]
|
||||
except:
|
||||
if deflt == NO_DEFAULT:
|
||||
raise MKLivestatusNotFoundError(query)
|
||||
else:
|
||||
return deflt
|
||||
|
||||
|
||||
def query_row(self, query):
|
||||
"""Issues a query that returns one line of data and returns the elements
|
||||
of that line as list"""
|
||||
result = self.query(query, "ColumnHeaders: off\n")
|
||||
try:
|
||||
return result[0]
|
||||
except IndexError:
|
||||
raise MKLivestatusNotFoundError(query)
|
||||
|
||||
|
||||
def query_row_assoc(self, query):
|
||||
"""Issues a query that returns one line of data and returns the elements
|
||||
of that line as a dictionary from column names to values"""
|
||||
r = self.query(query, "ColumnHeaders: on\n")[0:2]
|
||||
return dict(zip(r[0], r[1]))
|
||||
|
||||
|
||||
def query_column(self, query):
|
||||
"""Issues a query that returns exactly one column and returns the values
|
||||
of all lines in that column as a single list"""
|
||||
return [ l[0] for l in self.query(query, "ColumnHeaders: off\n") ]
|
||||
|
||||
|
||||
def query_column_unique(self, query):
|
||||
"""Issues a query that returns exactly one column and returns the values
|
||||
of all lines with duplicates removed"""
|
||||
result = []
|
||||
for line in self.query(query, "ColumnHeaders: off\n"):
|
||||
if line[0] not in result:
|
||||
result.append(line[0])
|
||||
return result
|
||||
|
||||
|
||||
def query_table(self, query):
|
||||
"""Issues a query that may return multiple lines and columns and returns
|
||||
a list of lists"""
|
||||
return self.query(query, "ColumnHeaders: off\n")
|
||||
|
||||
|
||||
def query_table_assoc(self, query):
|
||||
"""Issues a query that may return multiple lines and columns and returns
|
||||
a dictionary from column names to values for each line. This can be
|
||||
very ineffective for large response sets."""
|
||||
response = self.query(query, "ColumnHeaders: on\n")
|
||||
headers = response[0]
|
||||
result = []
|
||||
for line in response[1:]:
|
||||
result.append(dict(zip(headers, line)))
|
||||
return result
|
||||
|
||||
|
||||
def query_summed_stats(self, query, add_headers = ""):
|
||||
"""Conveniance function for adding up numbers from Stats queries
|
||||
Adds up results column-wise. This is useful for multisite queries."""
|
||||
data = self.query(query, add_headers)
|
||||
if len(data) == 1:
|
||||
return data[0]
|
||||
elif len(data) == 0:
|
||||
raise MKLivestatusNotFoundError("Empty result to Stats-Query")
|
||||
|
||||
result = []
|
||||
for x in range(0, len(data[0])):
|
||||
result.append(sum([row[x] for row in data]))
|
||||
return result
|
||||
|
||||
|
||||
# TODO: Add more functionality to the Query class:
|
||||
# - set_prepend_site
|
||||
# - set_only_sites
|
||||
# - set_auth_domain
|
||||
# All these are mostly set for a single query and reset back to another
|
||||
# value after the query. But nearly all of these usages does not care
|
||||
# about resetting the option in case of an exception. This could be
|
||||
# handled better using the query class
|
||||
class Query(object):
|
||||
"""This object can be passed to all livestatus methods accepting a livestatus
|
||||
query. The object can be used to hand over the handling code some flags, for
|
||||
example to influence the error handling during query processing."""
|
||||
|
||||
default_suppressed_exceptions = [MKLivestatusTableNotFoundError]
|
||||
|
||||
def __init__(self, query, suppress_exceptions=None):
|
||||
super(Query, self).__init__()
|
||||
|
||||
self._query = self._ensure_unicode(query)
|
||||
|
||||
if suppress_exceptions == None:
|
||||
self.suppress_exceptions = self.default_suppressed_exceptions
|
||||
else:
|
||||
self.suppress_exceptions = suppress_exceptions
|
||||
|
||||
|
||||
def _ensure_unicode(self, thing):
|
||||
try:
|
||||
return unicode(thing)
|
||||
except UnicodeDecodeError:
|
||||
return thing.decode("utf-8")
|
||||
|
||||
|
||||
def __unicode__(self):
|
||||
return self._query
|
||||
|
||||
|
||||
def __str__(self):
|
||||
return self._query.encode("utf-8")
|
||||
|
||||
|
||||
|
||||
#.
|
||||
# .--BaseConnection----------------------------------------------------------.
|
||||
# | ____ ____ _ _ |
|
||||
# || __ ) __ _ ___ ___ / ___|___ _ __ _ __ ___ ___| |_(_) ___ _ __ |
|
||||
# || _ \ / _` / __|/ _ \ | / _ \| '_ \| '_ \ / _ \/ __| __| |/ _ \ | '_ \ |
|
||||
# || |_) | (_| \__ \ __/ |__| (_) | | | | | | | __/ (__| |_| | (_) || | | ||
|
||||
# ||____/ \__,_|___/\___|\____\___/|_| |_|_| |_|\___|\___|\__|_|\___/ |_| |_||
|
||||
# | |
|
||||
# +--------------------------------------------------------------------------+
|
||||
# | Abstract base class of SingleSiteConnection and MultiSiteConnection |
|
||||
# '--------------------------------------------------------------------------'
|
||||
|
||||
class BaseConnection:
|
||||
def __init__(self, socketurl, persist = False, allow_cache = False):
|
||||
"""Create a new connection to a MK Livestatus socket"""
|
||||
self.add_headers = ""
|
||||
self.auth_header = ""
|
||||
self.persist = persist
|
||||
self.allow_cache = allow_cache
|
||||
self.socketurl = socketurl
|
||||
self.socket = None
|
||||
self.timeout = None
|
||||
self.successful_persistence = False
|
||||
|
||||
def successfully_persisted(self):
|
||||
return self.successful_persistence
|
||||
|
||||
def add_header(self, header):
|
||||
self.add_headers += header + "\n"
|
||||
|
||||
def set_timeout(self, timeout):
|
||||
self.timeout = timeout
|
||||
if self.socket:
|
||||
self.socket.settimeout(float(timeout))
|
||||
|
||||
def connect(self):
|
||||
if self.persist and self.socketurl in persistent_connections:
|
||||
self.socket = persistent_connections[self.socketurl]
|
||||
self.successful_persistence = True
|
||||
return
|
||||
|
||||
self.successful_persistence = False
|
||||
|
||||
# Create new socket
|
||||
self.socket = None
|
||||
url = self.socketurl
|
||||
parts = url.split(":")
|
||||
if parts[0] == "unix":
|
||||
if len(parts) != 2:
|
||||
raise MKLivestatusConfigError("Invalid livestatus unix URL: %s. "
|
||||
"Correct example is 'unix:/var/run/nagios/rw/live'" % url)
|
||||
self.socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
|
||||
target = parts[1]
|
||||
|
||||
elif parts[0] == "tcp":
|
||||
try:
|
||||
host = parts[1]
|
||||
port = int(parts[2])
|
||||
except:
|
||||
raise MKLivestatusConfigError("Invalid livestatus tcp URL '%s'. "
|
||||
"Correct example is 'tcp:somehost:6557'" % url)
|
||||
self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
||||
target = (host, port)
|
||||
else:
|
||||
raise MKLivestatusConfigError("Invalid livestatus URL '%s'. "
|
||||
"Must begin with 'tcp:' or 'unix:'" % url)
|
||||
|
||||
# If a timeout is set, then we retry after a failure with mild
|
||||
# a binary backoff.
|
||||
if self.timeout:
|
||||
before = time.time()
|
||||
sleep_interval = 0.1
|
||||
|
||||
while True:
|
||||
try:
|
||||
if self.timeout:
|
||||
self.socket.settimeout(float(sleep_interval))
|
||||
self.socket.connect(target)
|
||||
break
|
||||
except Exception, e:
|
||||
if self.timeout:
|
||||
time_left = self.timeout - (time.time() - before)
|
||||
# only try again, if there is substantial time left
|
||||
if time_left > sleep_interval:
|
||||
time.sleep(sleep_interval)
|
||||
sleep_interval *= 1.5
|
||||
continue
|
||||
|
||||
self.socket = None
|
||||
raise MKLivestatusSocketError("Cannot connect to '%s': %s" % (self.socketurl, e))
|
||||
|
||||
if self.persist:
|
||||
persistent_connections[self.socketurl] = self.socket
|
||||
|
||||
def disconnect(self):
|
||||
self.socket = None
|
||||
if self.persist:
|
||||
try:
|
||||
del persistent_connections[self.socketurl]
|
||||
except KeyError:
|
||||
pass
|
||||
|
||||
def receive_data(self, size):
|
||||
result = b""
|
||||
# Timeout is only honored when connecting
|
||||
self.socket.settimeout(None)
|
||||
while size > 0:
|
||||
packet = self.socket.recv(size)
|
||||
if len(packet) == 0:
|
||||
raise MKLivestatusSocketClosed("Read zero data from socket, nagios server closed connection")
|
||||
size -= len(packet)
|
||||
result += packet
|
||||
return result
|
||||
|
||||
def do_query(self, query, add_headers = ""):
|
||||
self.send_query(query, add_headers)
|
||||
return self.recv_response(query, add_headers)
|
||||
|
||||
def send_query(self, query_obj, add_headers = "", do_reconnect=True):
|
||||
orig_query = query_obj
|
||||
|
||||
query = "%s" % query_obj
|
||||
if not self.allow_cache:
|
||||
query = remove_cache_regex.sub("", query)
|
||||
|
||||
if self.socket == None:
|
||||
self.connect()
|
||||
|
||||
if not query.endswith("\n"):
|
||||
query += "\n"
|
||||
query += self.auth_header + self.add_headers
|
||||
query += "Localtime: %d\nOutputFormat: python\nKeepAlive: on\nResponseHeader: fixed16\n" % int(time.time())
|
||||
query += add_headers
|
||||
|
||||
if not query.endswith("\n"):
|
||||
query += "\n"
|
||||
query += "\n"
|
||||
|
||||
try:
|
||||
# socket.send() will implicitely cast to str(), we need ot
|
||||
# convert to UTF-8 in order to avoid exceptions
|
||||
if type(query) == unicode:
|
||||
query = query.encode("utf-8")
|
||||
self.socket.send(query)
|
||||
except IOError, e:
|
||||
if self.persist:
|
||||
del persistent_connections[self.socketurl]
|
||||
self.successful_persistence = False
|
||||
self.socket = None
|
||||
|
||||
if do_reconnect:
|
||||
# Automatically try to reconnect in case of an error, but
|
||||
# only once.
|
||||
self.connect()
|
||||
self.send_query(orig_query, add_headers, False)
|
||||
return
|
||||
|
||||
raise MKLivestatusSocketError("RC1:" + str(e))
|
||||
|
||||
# Reads a response from the livestatus socket. If the socket is closed
|
||||
# by the livestatus server, we automatically make a reconnect and send
|
||||
# the query again (once). This is due to timeouts during keepalive.
|
||||
def recv_response(self, query = None, add_headers = "", timeout_at = None):
|
||||
try:
|
||||
# Headers are always ASCII encoded
|
||||
resp = self.receive_data(16)
|
||||
code = resp[0:3]
|
||||
try:
|
||||
length = int(resp[4:15].lstrip())
|
||||
except:
|
||||
self.disconnect()
|
||||
raise MKLivestatusSocketError("Malformed output. Livestatus TCP socket might be unreachable.")
|
||||
|
||||
data = self.receive_data(length).decode("utf-8")
|
||||
|
||||
if code == "200":
|
||||
try:
|
||||
return ast.literal_eval(data)
|
||||
except:
|
||||
self.disconnect()
|
||||
raise MKLivestatusSocketError("Malformed output")
|
||||
|
||||
elif code == "404":
|
||||
raise MKLivestatusTableNotFoundError("Not Found (%s): %s" % (code, data.strip()))
|
||||
|
||||
else:
|
||||
raise MKLivestatusQueryError("%s: %s" % (code, data.strip()))
|
||||
|
||||
except (MKLivestatusSocketClosed, IOError), e:
|
||||
# In case of an IO error or the other side having
|
||||
# closed the socket do a reconnect and try again
|
||||
self.disconnect()
|
||||
now = time.time()
|
||||
if query and (not timeout_at or timeout_at > now):
|
||||
if timeout_at == None:
|
||||
# Try until timeout reached in case there was a timeout configured.
|
||||
# Otherwise only retry once.
|
||||
timeout_at = now
|
||||
if self.timeout:
|
||||
timeout_at += self.timeout
|
||||
|
||||
time.sleep(0.1)
|
||||
self.connect()
|
||||
self.send_query(query, add_headers)
|
||||
return self.recv_response(query, add_headers, timeout_at) # do not send query again -> danger of infinite loop
|
||||
else:
|
||||
raise MKLivestatusSocketError(str(e))
|
||||
|
||||
except MKLivestatusTableNotFoundError:
|
||||
raise
|
||||
|
||||
except Exception, e:
|
||||
# Catches
|
||||
# MKLivestatusQueryError
|
||||
# MKLivestatusSocketError
|
||||
# FIXME: ? self.disconnect()
|
||||
raise MKLivestatusSocketError("Unhandled exception: %s" % e)
|
||||
|
||||
|
||||
def do_command(self, command):
|
||||
if self.socket == None:
|
||||
self.connect()
|
||||
if not command.endswith("\n"):
|
||||
command += "\n"
|
||||
try:
|
||||
self.socket.send("COMMAND " + command + "\n")
|
||||
except IOError, e:
|
||||
self.socket = None
|
||||
if self.persist:
|
||||
del persistent_connections[self.socketurl]
|
||||
raise MKLivestatusSocketError(str(e))
|
||||
|
||||
|
||||
#.
|
||||
# .--SingleSiteConn------------------------------------------------------.
|
||||
# | ____ _ _ ____ _ _ ____ |
|
||||
# | / ___|(_)_ __ __ _| | ___/ ___|(_) |_ ___ / ___|___ _ __ _ __ |
|
||||
# | \___ \| | '_ \ / _` | |/ _ \___ \| | __/ _ \ | / _ \| '_ \| '_ \ |
|
||||
# | ___) | | | | | (_| | | __/___) | | || __/ |__| (_) | | | | | | | |
|
||||
# | |____/|_|_| |_|\__, |_|\___|____/|_|\__\___|\____\___/|_| |_|_| |_| |
|
||||
# | |___/ |
|
||||
# +----------------------------------------------------------------------+
|
||||
# | Connections to one local Unix or remote TCP socket. |
|
||||
# '----------------------------------------------------------------------'
|
||||
|
||||
class SingleSiteConnection(BaseConnection, Helpers):
|
||||
def __init__(self, socketurl, persist = False, allow_cache = False):
|
||||
BaseConnection.__init__(self, socketurl, persist, allow_cache)
|
||||
self.prepend_site = False
|
||||
self.auth_users = {}
|
||||
self.deadsites = {} # never filled, just for compatibility
|
||||
self.limit = None
|
||||
|
||||
def set_prepend_site(self, p):
|
||||
self.prepend_site = p
|
||||
|
||||
def set_only_sites(self, os = None):
|
||||
pass
|
||||
|
||||
def set_limit(self, limit = None):
|
||||
self.limit = limit
|
||||
|
||||
def query(self, query, add_headers = ""):
|
||||
if self.limit != None:
|
||||
query += "Limit: %d\n" % self.limit
|
||||
data = self.do_query(query, add_headers)
|
||||
if self.prepend_site:
|
||||
return [ [''] + line for line in data ]
|
||||
else:
|
||||
return data
|
||||
|
||||
def command(self, command, site = None):
|
||||
self.do_command(command)
|
||||
|
||||
# Set user to be used in certain authorization domain
|
||||
def set_auth_user(self, domain, user):
|
||||
if user:
|
||||
self.auth_users[domain] = user
|
||||
elif domain in self.auth_users:
|
||||
del self.auth_users[domain]
|
||||
|
||||
# Switch future request to new authorization domain
|
||||
def set_auth_domain(self, domain):
|
||||
auth_user = self.auth_users.get(domain)
|
||||
if auth_user:
|
||||
self.auth_header = "AuthUser: %s\n" % auth_user
|
||||
else:
|
||||
self.auth_header = ""
|
||||
|
||||
|
||||
#.
|
||||
# .--MultiSiteConn-------------------------------------------------------.
|
||||
# | __ __ _ _ _ ____ _ _ ____ |
|
||||
# | | \/ |_ _| | |_(_) ___|(_) |_ ___ / ___|___ _ __ _ __ |
|
||||
# | | |\/| | | | | | __| \___ \| | __/ _ \ | / _ \| '_ \| '_ \ |
|
||||
# | | | | | |_| | | |_| |___) | | || __/ |__| (_) | | | | | | | |
|
||||
# | |_| |_|\__,_|_|\__|_|____/|_|\__\___|\____\___/|_| |_|_| |_| |
|
||||
# | |
|
||||
# +----------------------------------------------------------------------+
|
||||
# | Connections to a list of local and remote sites. |
|
||||
# '----------------------------------------------------------------------'
|
||||
|
||||
# sites is a dictionary from site name to a dict.
|
||||
# Keys in the dictionary:
|
||||
# socket: socketurl (obligatory)
|
||||
# timeout: timeout for tcp/unix in seconds
|
||||
|
||||
# TODO: Move the connect/disconnect stuff to separate methods. Then make
|
||||
# it possible to connect/disconnect duing existance of a single object.
|
||||
|
||||
class MultiSiteConnection(Helpers):
|
||||
def __init__(self, sites, disabled_sites = None):
|
||||
if disabled_sites is None:
|
||||
disabled_sites = {}
|
||||
|
||||
self.sites = sites
|
||||
self.connections = []
|
||||
self.deadsites = {}
|
||||
self.prepend_site = False
|
||||
self.only_sites = None
|
||||
self.limit = None
|
||||
self.parallelize = True
|
||||
|
||||
# Helper function for connecting to a site
|
||||
def connect_to_site(sitename, site, temporary=False):
|
||||
try:
|
||||
url = site["socket"]
|
||||
persist = not temporary and site.get("persist", False)
|
||||
connection = SingleSiteConnection(url, persist, allow_cache=site.get("cache", False))
|
||||
if "timeout" in site:
|
||||
connection.set_timeout(int(site["timeout"]))
|
||||
connection.connect()
|
||||
self.connections.append((sitename, site, connection))
|
||||
|
||||
except Exception, e:
|
||||
self.deadsites[sitename] = {
|
||||
"exception" : e,
|
||||
"site" : site,
|
||||
}
|
||||
|
||||
# Needed for temporary connection for status_hosts in disabled sites
|
||||
def disconnect_site(sitename):
|
||||
i = 0
|
||||
for name, site, connection in self.connections:
|
||||
if name == sitename:
|
||||
del self.connections[i]
|
||||
return
|
||||
i += 1
|
||||
|
||||
|
||||
# Status host: A status host helps to prevent trying to connect
|
||||
# to a remote site which is unreachable. This is done by looking
|
||||
# at the current state of a certain host on a local site that is
|
||||
# representing the connection to the remote site. The status host
|
||||
# is specified as an optional pair of (site, host) in the entry
|
||||
# "status_host". We first connect to all sites without a status_host
|
||||
# entry, then retrieve the host states of the status hosts and then
|
||||
# connect to the remote site which are reachable
|
||||
|
||||
# Tackle very special problem: If the user disables a site which
|
||||
# provides status_host information for other sites, the dead-detection
|
||||
# would not work. For that cases we make a temporary connection just
|
||||
# to fetch the status information
|
||||
extra_status_sites = {}
|
||||
if len(disabled_sites) > 0:
|
||||
status_sitenames = set([])
|
||||
for sitename, site in sites.items():
|
||||
try:
|
||||
s, h = site.get("status_host")
|
||||
status_sitenames.add(s)
|
||||
except:
|
||||
continue
|
||||
for sitename in status_sitenames:
|
||||
site = disabled_sites.get(sitename)
|
||||
if site:
|
||||
extra_status_sites[sitename] = site
|
||||
|
||||
|
||||
# First connect to sites without status host. Collect status
|
||||
# hosts at the same time.
|
||||
|
||||
status_hosts = {} # dict from site to list of status_hosts
|
||||
for sitename, site in sites.items() + extra_status_sites.items():
|
||||
status_host = site.get("status_host")
|
||||
if status_host:
|
||||
if type(status_host) != tuple or len(status_host) != 2:
|
||||
raise MKLivestatusConfigError("Status host of site %s is %r, but must be pair of site and host" %
|
||||
(sitename, status_host))
|
||||
s, h = status_host
|
||||
status_hosts[s] = status_hosts.get(s, []) + [h]
|
||||
else:
|
||||
connect_to_site(sitename, site)
|
||||
|
||||
# Now learn current states of status hosts and store it in a dictionary
|
||||
# from (local_site, host) => state
|
||||
status_host_states = {}
|
||||
for sitename, hosts in status_hosts.items():
|
||||
# Fetch all the states of status hosts of this local site in one query
|
||||
query = "GET hosts\nColumns: name state has_been_checked last_time_up\n"
|
||||
for host in hosts:
|
||||
query += "Filter: name = %s\n" % host
|
||||
query += "Or: %d\n" % len(hosts)
|
||||
self.set_only_sites([sitename]) # only connect one site
|
||||
try:
|
||||
result = self.query_table(query)
|
||||
# raise MKLivestatusConfigError("TRESulT: %s" % (result,))
|
||||
for host, state, has_been_checked, lastup in result:
|
||||
if has_been_checked == 0:
|
||||
state = 3
|
||||
status_host_states[(sitename, host)] = (state, lastup)
|
||||
except Exception, e:
|
||||
raise MKLivestatusConfigError(e)
|
||||
status_host_states[(sitename, host)] = (str(e), None)
|
||||
self.set_only_sites() # clear site filter
|
||||
|
||||
# Disconnect from disabled sites that we connected to only to
|
||||
# get status information from
|
||||
for sitename, site in extra_status_sites.items():
|
||||
disconnect_site(sitename)
|
||||
|
||||
# Now loop over all sites having a status_host and take that state
|
||||
# of that into consideration
|
||||
|
||||
for sitename, site in sites.items():
|
||||
status_host = site.get("status_host")
|
||||
if status_host:
|
||||
now = time.time()
|
||||
shs, lastup = status_host_states.get(status_host, (4, now)) # None => Status host not existing
|
||||
deltatime = now - lastup
|
||||
if shs == 0 or shs == None:
|
||||
connect_to_site(sitename, site)
|
||||
else:
|
||||
if shs == 1:
|
||||
ex = "The remote monitoring host is down"
|
||||
elif shs == 2:
|
||||
ex = "The remote monitoring host is unreachable"
|
||||
elif shs == 3:
|
||||
ex = "The remote monitoring host's state it not yet determined"
|
||||
elif shs == 4:
|
||||
ex = "Invalid status host: site %s has no host %s" % (status_host[0], status_host[1])
|
||||
else:
|
||||
ex = "Error determining state of remote monitoring host: %s" % shs
|
||||
self.deadsites[sitename] = {
|
||||
"site" : site,
|
||||
"status_host_state" : shs,
|
||||
"exception" : ex,
|
||||
}
|
||||
|
||||
def add_header(self, header):
|
||||
for sitename, site, connection in self.connections:
|
||||
connection.add_header(header)
|
||||
|
||||
def set_prepend_site(self, p):
|
||||
self.prepend_site = p
|
||||
|
||||
def set_only_sites(self, sites=None):
|
||||
"""Make future queries only contact the given sites.
|
||||
|
||||
Provide a list of site IDs to not contact all configured sites, but only the listed
|
||||
site IDs. In case None is given, the limitation is removed.
|
||||
"""
|
||||
self.only_sites = sites
|
||||
|
||||
# Impose Limit on number of returned datasets (distributed amoung sites)
|
||||
def set_limit(self, limit = None):
|
||||
self.limit = limit
|
||||
|
||||
def dead_sites(self):
|
||||
return self.deadsites
|
||||
|
||||
def alive_sites(self):
|
||||
return [ s[0] for s in self.connections ]
|
||||
|
||||
def successfully_persisted(self):
|
||||
for sitename, site, connection in self.connections:
|
||||
if connection.successfully_persisted():
|
||||
return True
|
||||
return False
|
||||
|
||||
def set_auth_user(self, domain, user):
|
||||
for sitename, site, connection in self.connections:
|
||||
connection.set_auth_user(domain, user)
|
||||
|
||||
def set_auth_domain(self, domain):
|
||||
for sitename, site, connection in self.connections:
|
||||
connection.set_auth_domain(domain)
|
||||
|
||||
def query(self, query, add_headers = ""):
|
||||
if self.parallelize:
|
||||
return self.query_parallel(query, add_headers)
|
||||
else:
|
||||
return self.query_non_parallel(query, add_headers)
|
||||
|
||||
def query_non_parallel(self, query, add_headers = ""):
|
||||
result = []
|
||||
stillalive = []
|
||||
limit = self.limit
|
||||
for sitename, site, connection in self.connections:
|
||||
if self.only_sites != None and sitename not in self.only_sites:
|
||||
stillalive.append( (sitename, site, connection) ) # state unknown, assume still alive
|
||||
continue
|
||||
try:
|
||||
if limit != None:
|
||||
limit_header = "Limit: %d\n" % limit
|
||||
else:
|
||||
limit_header = ""
|
||||
r = connection.query(query, add_headers + limit_header)
|
||||
if self.prepend_site:
|
||||
r = [ [sitename] + l for l in r ]
|
||||
if limit != None:
|
||||
limit -= len(r) # Account for portion of limit used by this site
|
||||
result += r
|
||||
stillalive.append( (sitename, site, connection) )
|
||||
except Exception, e:
|
||||
connection.disconnect()
|
||||
self.deadsites[sitename] = {
|
||||
"exception" : e,
|
||||
"site" : site,
|
||||
}
|
||||
self.connections = stillalive
|
||||
return result
|
||||
|
||||
# New parallelized version of query(). The semantics differs in the handling
|
||||
# of Limit: since all sites are queried in parallel, the Limit: is simply
|
||||
# applied to all sites - resulting in possibly more results then Limit requests.
|
||||
def query_parallel(self, query, add_headers = ""):
|
||||
stillalive = []
|
||||
if self.only_sites != None:
|
||||
connect_to_sites = [ c for c in self.connections if c[0] in self.only_sites ]
|
||||
# Unused sites are assumed to be alive
|
||||
stillalive.extend( [ c for c in self.connections if c[0] not in self.only_sites])
|
||||
else:
|
||||
connect_to_sites = self.connections
|
||||
|
||||
start_time = time.time()
|
||||
limit = self.limit
|
||||
if limit != None:
|
||||
limit_header = "Limit: %d\n" % limit
|
||||
else:
|
||||
limit_header = ""
|
||||
|
||||
# First send all queries
|
||||
for sitename, site, connection in connect_to_sites:
|
||||
try:
|
||||
connection.send_query(query, add_headers + limit_header)
|
||||
except Exception, e:
|
||||
self.deadsites[sitename] = {
|
||||
"exception" : e,
|
||||
"site" : site,
|
||||
}
|
||||
|
||||
if isinstance(query, Query):
|
||||
suppress_exceptions = tuple(query.suppress_exceptions)
|
||||
else:
|
||||
suppress_exceptions = tuple(Query.default_suppressed_exceptions)
|
||||
|
||||
# Then retrieve all answers. We will be as slow as the slowest of all
|
||||
# connections.
|
||||
result = []
|
||||
for sitename, site, connection in connect_to_sites:
|
||||
try:
|
||||
r = connection.recv_response(query, add_headers + limit_header)
|
||||
stillalive.append( (sitename, site, connection) )
|
||||
if self.prepend_site:
|
||||
r = [ [sitename] + l for l in r ]
|
||||
result += r
|
||||
except suppress_exceptions:
|
||||
stillalive.append( (sitename, site, connection) )
|
||||
continue
|
||||
|
||||
except Exception, e:
|
||||
connection.disconnect()
|
||||
self.deadsites[sitename] = {
|
||||
"exception" : e,
|
||||
"site" : site,
|
||||
}
|
||||
|
||||
self.connections = stillalive
|
||||
return result
|
||||
|
||||
def command(self, command, sitename = "local"):
|
||||
if sitename in self.deadsites:
|
||||
raise MKLivestatusSocketError("Connection to site %s is dead: %s" % \
|
||||
(sitename, self.deadsites[sitename]["exception"]))
|
||||
conn = [t[2] for t in self.connections if t[0] == sitename]
|
||||
if len(conn) == 0:
|
||||
raise MKLivestatusConfigError("Cannot send command to unconfigured site '%s'" % sitename)
|
||||
conn[0].do_command(command)
|
||||
|
||||
# Return connection to localhost (UNIX), if available
|
||||
def local_connection(self):
|
||||
for sitename, site, connection in self.connections:
|
||||
if site["socket"].startswith("unix:") and "liveproxy" not in site["socket"]:
|
||||
return connection
|
||||
raise MKLivestatusConfigError("No livestatus connection to local host")
|
||||
|
||||
|
||||
|
||||
#.
|
||||
# .--LocalConn-----------------------------------------------------------.
|
||||
# | _ _ ____ |
|
||||
# | | | ___ ___ __ _| |/ ___|___ _ __ _ __ |
|
||||
# | | | / _ \ / __/ _` | | | / _ \| '_ \| '_ \ |
|
||||
# | | |__| (_) | (_| (_| | | |__| (_) | | | | | | | |
|
||||
# | |_____\___/ \___\__,_|_|\____\___/|_| |_|_| |_| |
|
||||
# | |
|
||||
# +----------------------------------------------------------------------+
|
||||
# | LocalConnection is a convenciance class for connecting to the |
|
||||
# | local Livestatus socket within an OMD site. It only works within |
|
||||
# | OMD context. It immediately connects() |
|
||||
# '----------------------------------------------------------------------'
|
||||
|
||||
class LocalConnection(SingleSiteConnection):
|
||||
def __init__(self, *args, **kwargs):
|
||||
omd_root = os.getenv("OMD_ROOT")
|
||||
if not omd_root:
|
||||
raise MKLivestatusConfigError("OMD_ROOT is not set. You are not running in OMD context.")
|
||||
SingleSiteConnection.__init__(self, "unix:" + omd_root + "/tmp/run/live", *args, **kwargs)
|
||||
self.connect()
|
||||
Reference in New Issue
Block a user