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 = float(time.time())
120 chart_name = self.chart_name
122 since_last = int((t_start - self.timetable['last']) * 1000000)
126 if not self.update(since_last):
127 self.error("update function failed.")
130 # draw performance graph
131 run_time = int((time.time() - t_start) * 1000)
132 print("BEGIN netdata.plugin_pythond_%s %s\nSET run_time = %s\nEND\n" %
133 (self.chart_name, str(since_last), str(run_time)))
135 self.debug(chart_name, "updated in", str(run_time), "ms")
136 self.timetable['last'] = t_start
137 self.__first_run = False
142 Runs job in thread. Handles retries.
143 Exits when job failed or timed out.
146 step = float(self.timetable['freq'])
148 self.timetable['last'] = float(time.time() - step)
149 self.debug("starting data collection - update frequency:", str(step), " retries allowed:", str(self.retries))
150 while True: # run forever, unless something is wrong
151 now = float(time.time())
152 next = self.timetable['next'] = now - (now % step) + step + penalty
154 # it is important to do this in a loop
155 # sleep() is interruptable
157 self.debug("sleeping for", str(next - now), "secs to reach frequency of", str(step), "secs, now:", str(now), " next:", str(next), " penalty:", str(penalty))
158 time.sleep(next - now)
159 now = float(time.time())
163 status = self._run_once()
164 except Exception as e:
165 self.alert("internal error - aborting data collection: " + str(e))
170 self.retries_left = self.retries
174 self.retries_left -= 1
175 if self.retries_left <= 0:
177 penalty = float(self.retries * step) / 2
184 self.retries_left = self.retries
185 self.alert("failed to collect data for " + str(self.retries) + " times - increasing penalty to " + str(penalty) + " sec and trying again")
188 self.error("failed to collect data - " + str(self.retries_left) + " retries left - penalty: " + str(penalty) + " sec")
195 Escape and convert passed arguments.
196 :param args: anything
200 append = params.append
205 if type(p) is not str:
212 def _line(self, instruction, *params):
214 Converts *params to string and joins them with one space between every one.
215 Result is appended to self._data_stream
216 :param params: str/int/float
218 tmp = list(map((lambda x: "''" if x is None or len(x) == 0 else x), params))
219 self._data_stream += "%s %s\n" % (instruction, str(" ".join(tmp)))
221 def chart(self, type_id, name="", title="", units="", family="",
222 category="", chart_type="line", priority="", update_every=""):
231 :param chart_type: str
232 :param priority: int/str
233 :param update_every: int/str
235 self._charts.append(type_id)
237 p = self._format(type_id, name, title, units, family, category, chart_type, priority, update_every)
238 self._line("CHART", *p)
240 def dimension(self, id, name=None, algorithm="absolute", multiplier=1, divisor=1, hidden=False):
242 Defines a new dimension for the chart
245 :param algorithm: str
246 :param multiplier: int/str
247 :param divisor: int/str
248 :param hidden: boolean
254 self.error("malformed dimension: multiplier is not a number:", multiplier)
259 self.error("malformed dimension: divisor is not a number:", divisor)
263 if algorithm not in ("absolute", "incremental", "percentage-of-absolute-row", "percentage-of-incremental-row"):
264 algorithm = "absolute"
266 self._dimensions.append(str(id))
268 p = self._format(id, name, algorithm, multiplier, divisor, "hidden")
270 p = self._format(id, name, algorithm, multiplier, divisor)
272 self._line("DIMENSION", *p)
274 def begin(self, type_id, microseconds=0):
278 :param microseconds: int
281 if type_id not in self._charts:
282 self.error("wrong chart type_id:", type_id)
287 self.error("malformed begin statement: microseconds are not a number:", microseconds)
290 self._line("BEGIN", type_id, str(microseconds))
293 def set(self, id, value):
295 Set value to dimension
297 :param value: int/float
300 if id not in self._dimensions:
301 self.error("wrong dimension id:", id, "Available dimensions are:", *self._dimensions)
304 value = str(int(value))
306 self.error("cannot set non-numeric value:", str(value))
308 self._line("SET", id, "=", str(value))
309 self.__chart_set = True
315 self.__chart_set = False
317 pos = self._data_stream.rfind("BEGIN")
318 self._data_stream = self._data_stream[:pos]
322 Upload new data to netdata.
324 print(self._data_stream)
325 self._data_stream = ""
327 # --- ERROR HANDLING ---
329 def error(self, *params):
331 Show error message on stderr
333 msg.error(self.chart_name, *params)
335 def alert(self, *params):
337 Show error message on stderr
339 msg.alert(self.chart_name, *params)
341 def debug(self, *params):
343 Show debug message on stderr
345 msg.debug(self.chart_name, *params)
347 def info(self, *params):
349 Show information message on stderr
351 msg.info(self.chart_name, *params)
353 # --- MAIN METHODS ---
367 self.debug("Module", str(self.__module__), "doesn't implement check() function. Using default.")
368 data = self._get_data()
371 self.debug("failed to receive data during check().")
375 self.debug("empty data during check().")
378 self.debug("successfully received data during check(): '" + str(data) + "'")
386 data = self._get_data()
388 self.debug("failed to receive data during create().")
392 for name in self.order:
393 options = self.definitions[name]['options'] + [self.priority + idx, self.update_every]
394 self.chart(self.chart_name + "." + name, *options)
395 # check if server has this datapoint
396 for line in self.definitions[name]['lines']:
398 self.dimension(*line)
404 def update(self, interval):
410 data = self._get_data()
412 self.debug("failed to receive data during update().")
416 for chart in self.order:
417 if self.begin(self.chart_name + "." + chart, interval):
419 for dim in self.definitions[chart]['lines']:
421 self.set(dim[0], data[dim[0]])
428 self.error("no charts to update")
433 class UrlService(SimpleService):
434 # TODO add support for https connections
435 def __init__(self, configuration=None, name=None):
440 SimpleService.__init__(self, configuration=configuration, name=name)
442 def __add_openers(self):
443 # TODO add error handling
444 self.opener = urllib2.build_opener()
447 # TODO currently self.proxies isn't parsed from configuration file
448 # if len(self.proxies) > 0:
449 # for proxy in self.proxies:
452 # if "user" in proxy and "pass" in proxy:
453 # if url.lower().startswith('https://'):
454 # url = 'https://' + proxy['user'] + ':' + proxy['pass'] + '@' + url[8:]
456 # url = 'http://' + proxy['user'] + ':' + proxy['pass'] + '@' + url[7:]
457 # # FIXME move proxy auth to sth like this:
458 # # passman = urllib2.HTTPPasswordMgrWithDefaultRealm()
459 # # passman.add_password(None, url, proxy['user'], proxy['password'])
460 # # opener.add_handler(urllib2.HTTPBasicAuthHandler(passman))
462 # if url.lower().startswith('https://'):
463 # opener.add_handler(urllib2.ProxyHandler({'https': url}))
465 # opener.add_handler(urllib2.ProxyHandler({'https': url}))
468 if self.user is not None and self.password is not None:
469 passman = urllib2.HTTPPasswordMgrWithDefaultRealm()
470 passman.add_password(None, self.url, self.user, self.password)
471 self.opener.add_handler(urllib2.HTTPBasicAuthHandler(passman))
472 self.debug("Enabling HTTP basic auth")
474 #urllib2.install_opener(opener)
476 def _get_raw_data(self):
478 Get raw data from http request
483 f = self.opener.open(self.url, timeout=self.update_every * 2)
484 # f = urllib2.urlopen(self.url, timeout=self.update_every * 2)
485 except Exception as e:
490 raw = f.read().decode('utf-8')
491 except Exception as e:
499 Format configuration data and try to connect to server
502 if self.name is None or self.name == str(None):
504 self.chart_name += "_" + self.name
506 self.name = str(self.name)
508 self.url = str(self.configuration['url'])
509 except (KeyError, TypeError):
512 self.user = str(self.configuration['user'])
513 except (KeyError, TypeError):
516 self.password = str(self.configuration['pass'])
517 except (KeyError, TypeError):
522 test = self._get_data()
523 if test is None or len(test) == 0:
529 class SocketService(SimpleService):
530 def __init__(self, configuration=None, name=None):
532 self._keep_alive = False
533 self.host = "localhost"
535 self.unix_socket = None
537 self.__socket_config = None
538 self.__empty_request = "".encode()
539 SimpleService.__init__(self, configuration=configuration, name=name)
541 def _socketerror(self, message=None):
542 if self.unix_socket is not None:
543 self.error("unix socket '" + self.unix_socket + "':", message)
545 if self.__socket_config is not None:
546 af, socktype, proto, canonname, sa = self.__socket_config
547 self.error("socket to '" + str(sa[0]) + "' port " + str(sa[1]) + ":", message)
549 self.error("unknown socket:", message)
551 def _connect2socket(self, res=None):
553 Connect to a socket, passing the result of getaddrinfo()
557 res = self.__socket_config
559 self.error("Cannot create socket to 'None':")
562 af, socktype, proto, canonname, sa = res
564 self.debug("creating socket to '" + str(sa[0]) + "', port " + str(sa[1]))
565 self._sock = socket.socket(af, socktype, proto)
566 except socket.error as e:
567 self.error("Failed to create socket to '" + str(sa[0]) + "', port " + str(sa[1]) + ":", str(e))
569 self.__socket_config = None
573 self.debug("connecting socket to '" + str(sa[0]) + "', port " + str(sa[1]))
574 self._sock.connect(sa)
575 except socket.error as e:
576 self.error("Failed to connect to '" + str(sa[0]) + "', port " + str(sa[1]) + ":", str(e))
578 self.__socket_config = None
581 self.debug("connected to '" + str(sa[0]) + "', port " + str(sa[1]))
582 self.__socket_config = res
585 def _connect2unixsocket(self):
587 Connect to a unix socket, given its filename
590 if self.unix_socket is None:
591 self.error("cannot connect to unix socket 'None'")
595 self.debug("attempting DGRAM unix socket '" + str(self.unix_socket) + "'")
596 self._sock = socket.socket(socket.AF_UNIX, socket.SOCK_DGRAM)
597 self._sock.connect(self.unix_socket)
598 self.debug("connected DGRAM unix socket '" + str(self.unix_socket) + "'")
600 except socket.error as e:
601 self.debug("Failed to connect DGRAM unix socket '" + str(self.unix_socket) + "':", str(e))
604 self.debug("attempting STREAM unix socket '" + str(self.unix_socket) + "'")
605 self._sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
606 self._sock.connect(self.unix_socket)
607 self.debug("connected STREAM unix socket '" + str(self.unix_socket) + "'")
609 except socket.error as e:
610 self.debug("Failed to connect STREAM unix socket '" + str(self.unix_socket) + "':", str(e))
611 self.error("Failed to connect to unix socket '" + str(self.unix_socket) + "':", str(e))
617 Recreate socket and connect to it since sockets cannot be reused after closing
618 Available configurations are IPv6, IPv4 or UNIX socket
622 if self.unix_socket is not None:
623 self._connect2unixsocket()
626 if self.__socket_config is not None:
627 self._connect2socket()
629 for res in socket.getaddrinfo(self.host, self.port, socket.AF_UNSPEC, socket.SOCK_STREAM):
630 if self._connect2socket(res): break
632 except Exception as e:
634 self.__socket_config = None
636 if self._sock is not None:
637 self._sock.setblocking(0)
638 self._sock.settimeout(5)
639 self.debug("set socket timeout to: " + str(self._sock.gettimeout()))
641 def _disconnect(self):
643 Close socket connection
646 if self._sock is not None:
648 self.debug("closing socket")
649 self._sock.shutdown(2) # 0 - read, 1 - write, 2 - all
660 # Send request if it is needed
661 if self.request != self.__empty_request:
663 self.debug("sending request:", str(self.request))
664 self._sock.send(self.request)
665 except Exception as e:
666 self._socketerror("error sending request:" + str(e))
673 Receive data from socket
678 self.debug("receiving response")
680 buf = self._sock.recv(4096)
681 except Exception as e:
682 self._socketerror("failed to receive response:" + str(e))
686 if buf is None or len(buf) == 0: # handle server disconnect
688 self._socketerror("unexpectedly disconnected")
690 self.debug("server closed the connection")
694 self.debug("received data:", str(buf))
695 data += buf.decode(errors='ignore')
696 if self._check_raw_data(data):
699 self.debug("final response:", str(data))
702 def _get_raw_data(self):
704 Get raw data with low-level "socket" module.
707 if self._sock is None:
709 if self._sock is None:
712 # Send request if it is needed
716 data = self._receive()
718 if not self._keep_alive:
723 def _check_raw_data(self, data):
725 Check if all data has been gathered from socket
731 def _parse_config(self):
733 Parse configuration data
736 if self.name is None or self.name == str(None):
739 self.name = str(self.name)
742 self.unix_socket = str(self.configuration['socket'])
743 except (KeyError, TypeError):
744 self.debug("No unix socket specified. Trying TCP/IP socket.")
745 self.unix_socket = None
747 self.host = str(self.configuration['host'])
748 except (KeyError, TypeError):
749 self.debug("No host specified. Using: '" + self.host + "'")
751 self.port = int(self.configuration['port'])
752 except (KeyError, TypeError):
753 self.debug("No port specified. Using: '" + str(self.port) + "'")
756 self.request = str(self.configuration['request'])
757 except (KeyError, TypeError):
758 self.debug("No request specified. Using: '" + str(self.request) + "'")
760 self.request = self.request.encode()
764 return SimpleService.check(self)
767 class LogService(SimpleService):
768 def __init__(self, configuration=None, name=None):
770 self._last_position = 0
771 # self._log_reader = None
772 SimpleService.__init__(self, configuration=configuration, name=name)
773 self.retries = 100000 # basically always retry
775 def _get_raw_data(self):
777 Get log lines since last poll
782 if os.path.getsize(self.log_path) < self._last_position:
783 self._last_position = 0 # read from beginning if file has shrunk
784 elif os.path.getsize(self.log_path) == self._last_position:
785 self.debug("Log file hasn't changed. No new data.")
786 return [] # return empty list if nothing has changed
787 with open(self.log_path, "r") as fp:
788 fp.seek(self._last_position)
789 for i, line in enumerate(fp):
791 self._last_position = fp.tell()
792 except Exception as e:
798 self.error("No data collected.")
803 Parse basic configuration and check if log file exists
806 if self.name is not None or self.name != str(None):
809 self.name = str(self.name)
811 self.log_path = str(self.configuration['path'])
812 except (KeyError, TypeError):
813 self.info("No path to log specified. Using: '" + self.log_path + "'")
815 if os.access(self.log_path, os.R_OK):
818 self.error("Cannot access file: '" + self.log_path + "'")
822 # set cursor at last byte of log file
823 self._last_position = os.path.getsize(self.log_path)
824 status = SimpleService.create(self)
825 # self._last_position = 0
829 class ExecutableService(SimpleService):
830 bad_substrings = ('&', '|', ';', '>', '<')
832 def __init__(self, configuration=None, name=None):
834 SimpleService.__init__(self, configuration=configuration, name=name)
836 def _get_raw_data(self):
838 Get raw data from executed command
842 p = Popen(self.command, stdout=PIPE, stderr=PIPE)
843 except Exception as e:
844 self.error("Executing command", self.command, "resulted in error:", str(e))
847 for line in p.stdout.readlines():
848 data.append(str(line.decode()))
851 self.error("No data collected.")
858 Parse basic configuration, check if command is whitelisted and is returning values
861 if self.name is not None or self.name != str(None):
864 self.name = str(self.name)
866 self.command = str(self.configuration['command'])
867 except (KeyError, TypeError):
868 self.info("No command specified. Using: '" + self.command + "'")
869 command = self.command.split(' ')
871 for arg in command[1:]:
872 if any(st in arg for st in self.bad_substrings):
873 self.error("Bad command argument:" + " ".join(self.command[1:]))
876 # test command and search for it in /usr/sbin or /sbin when failed
877 base = command[0].split('/')[-1]
878 if self._get_raw_data() is None:
879 for prefix in ['/sbin/', '/usr/sbin/']:
880 command[0] = prefix + base
881 if os.path.isfile(command[0]):
884 self.command = command
885 if self._get_data() is None or len(self._get_data()) == 0:
886 self.error("Command", self.command, "returned no data")