1 # -*- coding: utf-8 -*-
2 # Description: netdata python modules framework
3 # Author: Pawel Krupa (paulfantom)
6 # ALL CODE NEEDS TO BE COMPATIBLE WITH Python > 2.7 and Python > 3.1
7 # Follow PEP8 as much as it is possible
8 # "check" and "create" CANNOT be blocking.
9 # "update" CAN be blocking
10 # "update" function needs to be fast, so follow:
11 # https://wiki.python.org/moin/PythonSpeed/PerformanceTips
13 # - use local variables wherever it is possible
14 # - avoid dots in expressions that are executed many times
15 # - use "join()" instead of "+"
16 # - use "import" only at the beginning
18 # using ".encode()" in one thread can block other threads as well (only in python2)
26 import urllib.request as urllib2
30 from subprocess import Popen, PIPE
36 # class BaseService(threading.Thread):
37 class SimpleService(threading.Thread):
39 Prototype of Service class.
40 Implemented basic functionality to run jobs by `python.d.plugin`
42 def __init__(self, configuration=None, name=None):
44 This needs to be initialized in child classes
45 :param configuration: dict
48 threading.Thread.__init__(self)
49 self._data_stream = ""
53 self.priority = 140000
56 self.override_name = None
60 self.__chart_set = False
61 self.__first_run = True
64 if configuration is None:
65 self.error("BaseService: no configuration parameters supplied. Cannot create Service.")
68 self._extract_base_config(configuration)
70 self.create_timetable()
72 # --- BASIC SERVICE CONFIGURATION ---
74 def _extract_base_config(self, config):
76 Get basic parameters to run service
78 config = {'update_every':1,
85 self.override_name = pop('name')
88 self.update_every = int(pop('update_every'))
89 self.priority = int(pop('priority'))
90 self.retries = int(pop('retries'))
91 self.retries_left = self.retries
92 self.configuration = config
94 def create_timetable(self, freq=None):
96 Create service timetable.
99 timetable = {'last': 1466370091.3767564,
105 freq = self.update_every
107 self.timetable = {'last': now,
108 'next': now - (now % freq) + freq,
111 # --- THREAD CONFIGURATION ---
115 Executes self.update(interval) and draws run time chart.
116 Return value presents exit status of update()
119 t_start = time.time()
120 timetable = self.timetable
121 chart_name = self.chart_name
123 # check if it is time to execute job update() function
124 if timetable['next'] > t_start:
125 self.debug(chart_name, "will be run in", str(int((timetable['next'] - t_start) * 1000)), "ms")
128 since_last = int((t_start - timetable['last']) * 1000000)
129 self.debug(chart_name,
130 "ready to run, after", str(int((t_start - timetable['last']) * 1000)),
131 "ms (update_every:", str(timetable['freq'] * 1000),
132 "ms, latency:", str(int((t_start - timetable['next']) * 1000)), "ms")
137 if not self.update(since_last):
138 self.error("update function failed.")
142 self.timetable['next'] = t_end - (t_end % timetable['freq']) + timetable['freq']
144 # draw performance graph
145 run_time = str(int((t_end - t_start) * 1000))
146 # noinspection SqlNoDataSourceInspection
147 print("BEGIN netdata.plugin_pythond_%s %s\nSET run_time = %s\nEND\n" %
148 (self.chart_name, str(since_last), run_time))
150 self.debug(chart_name, "updated in", str(run_time), "ms")
151 self.timetable['last'] = t_start
152 self.__first_run = False
157 Runs job in thread. Handles retries.
158 Exits when job failed or timed out.
161 self.timetable['last'] = time.time()
162 self.debug("starting data collection - update frequency: " + str(self.update_every) + ", retries allowed: " + str(self.retries))
163 while True: # run forever, unless something is wrong
165 status = self._run_once()
166 except Exception as e:
167 self.alert("internal error - aborting data collection: " + str(e))
170 if status: # handle retries if update failed
171 time.sleep(self.timetable['next'] - time.time())
172 self.retries_left = self.retries
174 self.retries_left -= 1
175 if self.retries_left <= 0:
176 self.alert("failed to collect data - no more retries allowed - aborting data collection")
179 self.error("failed to collect data. " + str(self.retries_left) + " retries left.")
180 time.sleep(self.timetable['freq'])
187 Escape and convert passed arguments.
188 :param args: anything
192 append = params.append
197 if type(p) is not str:
204 def _line(self, instruction, *params):
206 Converts *params to string and joins them with one space between every one.
207 Result is appended to self._data_stream
208 :param params: str/int/float
210 tmp = list(map((lambda x: "''" if x is None or len(x) == 0 else x), params))
211 self._data_stream += "%s %s\n" % (instruction, str(" ".join(tmp)))
213 def chart(self, type_id, name="", title="", units="", family="",
214 category="", chart_type="line", priority="", update_every=""):
223 :param chart_type: str
224 :param priority: int/str
225 :param update_every: int/str
227 self._charts.append(type_id)
229 p = self._format(type_id, name, title, units, family, category, chart_type, priority, update_every)
230 self._line("CHART", *p)
232 def dimension(self, id, name=None, algorithm="absolute", multiplier=1, divisor=1, hidden=False):
234 Defines a new dimension for the chart
237 :param algorithm: str
238 :param multiplier: int/str
239 :param divisor: int/str
240 :param hidden: boolean
246 self.error("malformed dimension: multiplier is not a number:", multiplier)
251 self.error("malformed dimension: divisor is not a number:", divisor)
255 if algorithm not in ("absolute", "incremental", "percentage-of-absolute-row", "percentage-of-incremental-row"):
256 algorithm = "absolute"
258 self._dimensions.append(str(id))
260 p = self._format(id, name, algorithm, multiplier, divisor, "hidden")
262 p = self._format(id, name, algorithm, multiplier, divisor)
264 self._line("DIMENSION", *p)
266 def begin(self, type_id, microseconds=0):
270 :param microseconds: int
273 if type_id not in self._charts:
274 self.error("wrong chart type_id:", type_id)
279 self.error("malformed begin statement: microseconds are not a number:", microseconds)
282 self._line("BEGIN", type_id, str(microseconds))
285 def set(self, id, value):
287 Set value to dimension
289 :param value: int/float
292 if id not in self._dimensions:
293 self.error("wrong dimension id:", id, "Available dimensions are:", *self._dimensions)
296 value = str(int(value))
298 self.error("cannot set non-numeric value:", str(value))
300 self._line("SET", id, "=", str(value))
301 self.__chart_set = True
307 self.__chart_set = False
309 pos = self._data_stream.rfind("BEGIN")
310 self._data_stream = self._data_stream[:pos]
314 Upload new data to netdata.
316 print(self._data_stream)
317 self._data_stream = ""
319 # --- ERROR HANDLING ---
321 def error(self, *params):
323 Show error message on stderr
325 msg.error(self.chart_name, *params)
327 def alert(self, *params):
329 Show error message on stderr
331 msg.alert(self.chart_name, *params)
333 def debug(self, *params):
335 Show debug message on stderr
337 msg.debug(self.chart_name, *params)
339 def info(self, *params):
341 Show information message on stderr
343 msg.info(self.chart_name, *params)
345 # --- MAIN METHODS ---
359 self.debug("Module", str(self.__module__), "doesn't implement check() function. Using default.")
360 data = self._get_data()
363 self.debug("failed to receive data during check().")
367 self.debug("empty data during check().")
370 self.debug("successfully received data during check(): '" + str(data) + "'")
378 data = self._get_data()
380 self.debug("failed to receive data during create().")
384 for name in self.order:
385 options = self.definitions[name]['options'] + [self.priority + idx, self.update_every]
386 self.chart(self.chart_name + "." + name, *options)
387 # check if server has this datapoint
388 for line in self.definitions[name]['lines']:
390 self.dimension(*line)
396 def update(self, interval):
402 data = self._get_data()
404 self.debug("failed to receive data during update().")
408 for chart in self.order:
409 if self.begin(self.chart_name + "." + chart, interval):
411 for dim in self.definitions[chart]['lines']:
413 self.set(dim[0], data[dim[0]])
420 self.error("no charts to update")
425 class UrlService(SimpleService):
426 # TODO add support for https connections
427 def __init__(self, configuration=None, name=None):
432 SimpleService.__init__(self, configuration=configuration, name=name)
434 def __add_openers(self):
435 # TODO add error handling
436 self.opener = urllib2.build_opener()
439 # TODO currently self.proxies isn't parsed from configuration file
440 # if len(self.proxies) > 0:
441 # for proxy in self.proxies:
444 # if "user" in proxy and "pass" in proxy:
445 # if url.lower().startswith('https://'):
446 # url = 'https://' + proxy['user'] + ':' + proxy['pass'] + '@' + url[8:]
448 # url = 'http://' + proxy['user'] + ':' + proxy['pass'] + '@' + url[7:]
449 # # FIXME move proxy auth to sth like this:
450 # # passman = urllib2.HTTPPasswordMgrWithDefaultRealm()
451 # # passman.add_password(None, url, proxy['user'], proxy['password'])
452 # # opener.add_handler(urllib2.HTTPBasicAuthHandler(passman))
454 # if url.lower().startswith('https://'):
455 # opener.add_handler(urllib2.ProxyHandler({'https': url}))
457 # opener.add_handler(urllib2.ProxyHandler({'https': url}))
460 if self.user is not None and self.password is not None:
461 passman = urllib2.HTTPPasswordMgrWithDefaultRealm()
462 passman.add_password(None, self.url, self.user, self.password)
463 self.opener.add_handler(urllib2.HTTPBasicAuthHandler(passman))
464 self.debug("Enabling HTTP basic auth")
466 #urllib2.install_opener(opener)
468 def _get_raw_data(self):
470 Get raw data from http request
475 f = self.opener.open(self.url, timeout=self.update_every * 2)
476 # f = urllib2.urlopen(self.url, timeout=self.update_every * 2)
477 except Exception as e:
482 raw = f.read().decode('utf-8')
483 except Exception as e:
491 Format configuration data and try to connect to server
494 if self.name is None or self.name == str(None):
496 self.chart_name += "_" + self.name
498 self.name = str(self.name)
500 self.url = str(self.configuration['url'])
501 except (KeyError, TypeError):
504 self.user = str(self.configuration['user'])
505 except (KeyError, TypeError):
508 self.password = str(self.configuration['pass'])
509 except (KeyError, TypeError):
514 test = self._get_data()
515 if test is None or len(test) == 0:
521 class SocketService(SimpleService):
522 def __init__(self, configuration=None, name=None):
524 self._keep_alive = False
525 self.host = "localhost"
527 self.unix_socket = None
529 self.__socket_config = None
530 self.__empty_request = "".encode()
531 SimpleService.__init__(self, configuration=configuration, name=name)
533 def _socketerror(self, message=None):
534 if self.unix_socket is not None:
535 self.error("unix socket '" + self.unix_socket + "':", message)
537 if self.__socket_config is not None:
538 af, socktype, proto, canonname, sa = self.__socket_config
539 self.error("socket to '" + str(sa[0]) + "' port " + str(sa[1]) + ":", message)
541 self.error("unknown socket:", message)
543 def _connect2socket(self, res=None):
545 Connect to a socket, passing the result of getaddrinfo()
549 res = self.__socket_config
551 self.error("Cannot create socket to 'None':")
554 af, socktype, proto, canonname, sa = res
556 self.debug("creating socket to '" + str(sa[0]) + "', port " + str(sa[1]))
557 self._sock = socket.socket(af, socktype, proto)
558 except socket.error as e:
559 self.error("Failed to create socket to '" + str(sa[0]) + "', port " + str(sa[1]) + ":", str(e))
561 self.__socket_config = None
565 self.debug("connecting socket to '" + str(sa[0]) + "', port " + str(sa[1]))
566 self._sock.connect(sa)
567 except socket.error as e:
568 self.error("Failed to connect to '" + str(sa[0]) + "', port " + str(sa[1]) + ":", str(e))
570 self.__socket_config = None
573 self.debug("connected to '" + str(sa[0]) + "', port " + str(sa[1]))
574 self.__socket_config = res
577 def _connect2unixsocket(self):
579 Connect to a unix socket, given its filename
582 if self.unix_socket is None:
583 self.error("cannot connect to unix socket 'None'")
587 self.debug("attempting DGRAM unix socket '" + str(self.unix_socket) + "'")
588 self._sock = socket.socket(socket.AF_UNIX, socket.SOCK_DGRAM)
589 self._sock.connect(self.unix_socket)
590 self.debug("connected DGRAM unix socket '" + str(self.unix_socket) + "'")
592 except socket.error as e:
593 self.debug("Failed to connect DGRAM unix socket '" + str(self.unix_socket) + "':", str(e))
596 self.debug("attempting STREAM unix socket '" + str(self.unix_socket) + "'")
597 self._sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
598 self._sock.connect(self.unix_socket)
599 self.debug("connected STREAM unix socket '" + str(self.unix_socket) + "'")
601 except socket.error as e:
602 self.debug("Failed to connect STREAM unix socket '" + str(self.unix_socket) + "':", str(e))
603 self.error("Failed to connect to unix socket '" + str(self.unix_socket) + "':", str(e))
609 Recreate socket and connect to it since sockets cannot be reused after closing
610 Available configurations are IPv6, IPv4 or UNIX socket
614 if self.unix_socket is not None:
615 self._connect2unixsocket()
618 if self.__socket_config is not None:
619 self._connect2socket()
621 for res in socket.getaddrinfo(self.host, self.port, socket.AF_UNSPEC, socket.SOCK_STREAM):
622 if self._connect2socket(res): break
624 except Exception as e:
626 self.__socket_config = None
628 if self._sock is not None:
629 self._sock.setblocking(0)
630 self._sock.settimeout(5)
631 self.debug("set socket timeout to: " + str(self._sock.gettimeout()))
633 def _disconnect(self):
635 Close socket connection
638 if self._sock is not None:
640 self.debug("closing socket")
641 self._sock.shutdown(2) # 0 - read, 1 - write, 2 - all
652 # Send request if it is needed
653 if self.request != self.__empty_request:
655 self.debug("sending request:", str(self.request))
656 self._sock.send(self.request)
657 except Exception as e:
658 self._socketerror("error sending request:" + str(e))
665 Receive data from socket
670 self.debug("receiving response")
672 buf = self._sock.recv(4096)
673 except Exception as e:
674 self._socketerror("failed to receive response:" + str(e))
678 if buf is None or len(buf) == 0: # handle server disconnect
680 self._socketerror("unexpectedly disconnected")
682 self.debug("server closed the connection")
686 self.debug("received data:", str(buf))
687 data += buf.decode(errors='ignore')
688 if self._check_raw_data(data):
691 self.debug("final response:", str(data))
694 def _get_raw_data(self):
696 Get raw data with low-level "socket" module.
699 if self._sock is None:
701 if self._sock is None:
704 # Send request if it is needed
708 data = self._receive()
710 if not self._keep_alive:
715 def _check_raw_data(self, data):
717 Check if all data has been gathered from socket
723 def _parse_config(self):
725 Parse configuration data
728 if self.name is None or self.name == str(None):
731 self.name = str(self.name)
734 self.unix_socket = str(self.configuration['socket'])
735 except (KeyError, TypeError):
736 self.debug("No unix socket specified. Trying TCP/IP socket.")
737 self.unix_socket = None
739 self.host = str(self.configuration['host'])
740 except (KeyError, TypeError):
741 self.debug("No host specified. Using: '" + self.host + "'")
743 self.port = int(self.configuration['port'])
744 except (KeyError, TypeError):
745 self.debug("No port specified. Using: '" + str(self.port) + "'")
748 self.request = str(self.configuration['request'])
749 except (KeyError, TypeError):
750 self.debug("No request specified. Using: '" + str(self.request) + "'")
752 self.request = self.request.encode()
756 return SimpleService.check(self)
759 class LogService(SimpleService):
760 def __init__(self, configuration=None, name=None):
762 self._last_position = 0
763 # self._log_reader = None
764 SimpleService.__init__(self, configuration=configuration, name=name)
765 self.retries = 100000 # basically always retry
767 def _get_raw_data(self):
769 Get log lines since last poll
774 if os.path.getsize(self.log_path) < self._last_position:
775 self._last_position = 0 # read from beginning if file has shrunk
776 elif os.path.getsize(self.log_path) == self._last_position:
777 self.debug("Log file hasn't changed. No new data.")
778 return [] # return empty list if nothing has changed
779 with open(self.log_path, "r") as fp:
780 fp.seek(self._last_position)
781 for i, line in enumerate(fp):
783 self._last_position = fp.tell()
784 except Exception as e:
790 self.error("No data collected.")
795 Parse basic configuration and check if log file exists
798 if self.name is not None or self.name != str(None):
801 self.name = str(self.name)
803 self.log_path = str(self.configuration['path'])
804 except (KeyError, TypeError):
805 self.info("No path to log specified. Using: '" + self.log_path + "'")
807 if os.access(self.log_path, os.R_OK):
810 self.error("Cannot access file: '" + self.log_path + "'")
814 # set cursor at last byte of log file
815 self._last_position = os.path.getsize(self.log_path)
816 status = SimpleService.create(self)
817 # self._last_position = 0
821 class ExecutableService(SimpleService):
822 bad_substrings = ('&', '|', ';', '>', '<')
824 def __init__(self, configuration=None, name=None):
826 SimpleService.__init__(self, configuration=configuration, name=name)
828 def _get_raw_data(self):
830 Get raw data from executed command
834 p = Popen(self.command, stdout=PIPE, stderr=PIPE)
835 except Exception as e:
836 self.error("Executing command", self.command, "resulted in error:", str(e))
839 for line in p.stdout.readlines():
840 data.append(str(line.decode()))
843 self.error("No data collected.")
850 Parse basic configuration, check if command is whitelisted and is returning values
853 if self.name is not None or self.name != str(None):
856 self.name = str(self.name)
858 self.command = str(self.configuration['command'])
859 except (KeyError, TypeError):
860 self.info("No command specified. Using: '" + self.command + "'")
861 command = self.command.split(' ')
863 for arg in command[1:]:
864 if any(st in arg for st in self.bad_substrings):
865 self.error("Bad command argument:" + " ".join(self.command[1:]))
868 # test command and search for it in /usr/sbin or /sbin when failed
869 base = command[0].split('/')[-1]
870 if self._get_raw_data() is None:
871 for prefix in ['/sbin/', '/usr/sbin/']:
872 command[0] = prefix + base
873 if os.path.isfile(command[0]):
876 self.command = command
877 if self._get_data() is None or len(self._get_data()) == 0:
878 self.error("Command", self.command, "returned no data")