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:
169 self.retries_left = self.retries
173 self.retries_left -= 1
174 if self.retries_left <= 0:
176 penalty = float(self.retries * step) / 2
183 self.retries_left = self.retries
184 self.alert("failed to collect data for " + str(self.retries) + " times - increasing penalty to " + str(penalty) + " sec and trying again")
187 self.error("failed to collect data - " + str(self.retries_left) + " retries left - penalty: " + str(penalty) + " sec")
194 Escape and convert passed arguments.
195 :param args: anything
199 append = params.append
204 if type(p) is not str:
211 def _line(self, instruction, *params):
213 Converts *params to string and joins them with one space between every one.
214 Result is appended to self._data_stream
215 :param params: str/int/float
217 tmp = list(map((lambda x: "''" if x is None or len(x) == 0 else x), params))
218 self._data_stream += "%s %s\n" % (instruction, str(" ".join(tmp)))
220 def chart(self, type_id, name="", title="", units="", family="",
221 category="", chart_type="line", priority="", update_every=""):
230 :param chart_type: str
231 :param priority: int/str
232 :param update_every: int/str
234 self._charts.append(type_id)
236 p = self._format(type_id, name, title, units, family, category, chart_type, priority, update_every)
237 self._line("CHART", *p)
239 def dimension(self, id, name=None, algorithm="absolute", multiplier=1, divisor=1, hidden=False):
241 Defines a new dimension for the chart
244 :param algorithm: str
245 :param multiplier: int/str
246 :param divisor: int/str
247 :param hidden: boolean
253 self.error("malformed dimension: multiplier is not a number:", multiplier)
258 self.error("malformed dimension: divisor is not a number:", divisor)
262 if algorithm not in ("absolute", "incremental", "percentage-of-absolute-row", "percentage-of-incremental-row"):
263 algorithm = "absolute"
265 self._dimensions.append(str(id))
267 p = self._format(id, name, algorithm, multiplier, divisor, "hidden")
269 p = self._format(id, name, algorithm, multiplier, divisor)
271 self._line("DIMENSION", *p)
273 def begin(self, type_id, microseconds=0):
277 :param microseconds: int
280 if type_id not in self._charts:
281 self.error("wrong chart type_id:", type_id)
286 self.error("malformed begin statement: microseconds are not a number:", microseconds)
289 self._line("BEGIN", type_id, str(microseconds))
292 def set(self, id, value):
294 Set value to dimension
296 :param value: int/float
299 if id not in self._dimensions:
300 self.error("wrong dimension id:", id, "Available dimensions are:", *self._dimensions)
303 value = str(int(value))
305 self.error("cannot set non-numeric value:", str(value))
307 self._line("SET", id, "=", str(value))
308 self.__chart_set = True
314 self.__chart_set = False
316 pos = self._data_stream.rfind("BEGIN")
317 self._data_stream = self._data_stream[:pos]
321 Upload new data to netdata.
324 print(self._data_stream)
325 except Exception as e:
326 msg.fatal('cannot send data to netdata:', str(e))
327 self._data_stream = ""
329 # --- ERROR HANDLING ---
331 def error(self, *params):
333 Show error message on stderr
335 msg.error(self.chart_name, *params)
337 def alert(self, *params):
339 Show error message on stderr
341 msg.alert(self.chart_name, *params)
343 def debug(self, *params):
345 Show debug message on stderr
347 msg.debug(self.chart_name, *params)
349 def info(self, *params):
351 Show information message on stderr
353 msg.info(self.chart_name, *params)
355 # --- MAIN METHODS ---
369 self.debug("Module", str(self.__module__), "doesn't implement check() function. Using default.")
370 data = self._get_data()
373 self.debug("failed to receive data during check().")
377 self.debug("empty data during check().")
380 self.debug("successfully received data during check(): '" + str(data) + "'")
388 data = self._get_data()
390 self.debug("failed to receive data during create().")
394 for name in self.order:
395 options = self.definitions[name]['options'] + [self.priority + idx, self.update_every]
396 self.chart(self.chart_name + "." + name, *options)
397 # check if server has this datapoint
398 for line in self.definitions[name]['lines']:
400 self.dimension(*line)
406 def update(self, interval):
412 data = self._get_data()
414 self.debug("failed to receive data during update().")
418 for chart in self.order:
419 if self.begin(self.chart_name + "." + chart, interval):
421 for dim in self.definitions[chart]['lines']:
423 self.set(dim[0], data[dim[0]])
430 self.error("no charts to update")
435 class UrlService(SimpleService):
436 # TODO add support for https connections
437 def __init__(self, configuration=None, name=None):
442 SimpleService.__init__(self, configuration=configuration, name=name)
444 def __add_openers(self):
445 # TODO add error handling
446 self.opener = urllib2.build_opener()
449 # TODO currently self.proxies isn't parsed from configuration file
450 # if len(self.proxies) > 0:
451 # for proxy in self.proxies:
454 # if "user" in proxy and "pass" in proxy:
455 # if url.lower().startswith('https://'):
456 # url = 'https://' + proxy['user'] + ':' + proxy['pass'] + '@' + url[8:]
458 # url = 'http://' + proxy['user'] + ':' + proxy['pass'] + '@' + url[7:]
459 # # FIXME move proxy auth to sth like this:
460 # # passman = urllib2.HTTPPasswordMgrWithDefaultRealm()
461 # # passman.add_password(None, url, proxy['user'], proxy['password'])
462 # # opener.add_handler(urllib2.HTTPBasicAuthHandler(passman))
464 # if url.lower().startswith('https://'):
465 # opener.add_handler(urllib2.ProxyHandler({'https': url}))
467 # opener.add_handler(urllib2.ProxyHandler({'https': url}))
470 if self.user is not None and self.password is not None:
471 passman = urllib2.HTTPPasswordMgrWithDefaultRealm()
472 passman.add_password(None, self.url, self.user, self.password)
473 self.opener.add_handler(urllib2.HTTPBasicAuthHandler(passman))
474 self.debug("Enabling HTTP basic auth")
476 #urllib2.install_opener(opener)
478 def _get_raw_data(self):
480 Get raw data from http request
485 f = self.opener.open(self.url, timeout=self.update_every * 2)
486 # f = urllib2.urlopen(self.url, timeout=self.update_every * 2)
487 except Exception as e:
492 raw = f.read().decode('utf-8', 'ignore')
493 except Exception as e:
501 Format configuration data and try to connect to server
504 if self.name is None or self.name == str(None):
506 self.chart_name += "_" + self.name
508 self.name = str(self.name)
510 self.url = str(self.configuration['url'])
511 except (KeyError, TypeError):
514 self.user = str(self.configuration['user'])
515 except (KeyError, TypeError):
518 self.password = str(self.configuration['pass'])
519 except (KeyError, TypeError):
524 test = self._get_data()
525 if test is None or len(test) == 0:
531 class SocketService(SimpleService):
532 def __init__(self, configuration=None, name=None):
534 self._keep_alive = False
535 self.host = "localhost"
537 self.unix_socket = None
539 self.__socket_config = None
540 self.__empty_request = "".encode()
541 SimpleService.__init__(self, configuration=configuration, name=name)
543 def _socketerror(self, message=None):
544 if self.unix_socket is not None:
545 self.error("unix socket '" + self.unix_socket + "':", message)
547 if self.__socket_config is not None:
548 af, socktype, proto, canonname, sa = self.__socket_config
549 self.error("socket to '" + str(sa[0]) + "' port " + str(sa[1]) + ":", message)
551 self.error("unknown socket:", message)
553 def _connect2socket(self, res=None):
555 Connect to a socket, passing the result of getaddrinfo()
559 res = self.__socket_config
561 self.error("Cannot create socket to 'None':")
564 af, socktype, proto, canonname, sa = res
566 self.debug("creating socket to '" + str(sa[0]) + "', port " + str(sa[1]))
567 self._sock = socket.socket(af, socktype, proto)
568 except socket.error as e:
569 self.error("Failed to create socket to '" + str(sa[0]) + "', port " + str(sa[1]) + ":", str(e))
571 self.__socket_config = None
575 self.debug("connecting socket to '" + str(sa[0]) + "', port " + str(sa[1]))
576 self._sock.connect(sa)
577 except socket.error as e:
578 self.error("Failed to connect to '" + str(sa[0]) + "', port " + str(sa[1]) + ":", str(e))
580 self.__socket_config = None
583 self.debug("connected to '" + str(sa[0]) + "', port " + str(sa[1]))
584 self.__socket_config = res
587 def _connect2unixsocket(self):
589 Connect to a unix socket, given its filename
592 if self.unix_socket is None:
593 self.error("cannot connect to unix socket 'None'")
597 self.debug("attempting DGRAM unix socket '" + str(self.unix_socket) + "'")
598 self._sock = socket.socket(socket.AF_UNIX, socket.SOCK_DGRAM)
599 self._sock.connect(self.unix_socket)
600 self.debug("connected DGRAM unix socket '" + str(self.unix_socket) + "'")
602 except socket.error as e:
603 self.debug("Failed to connect DGRAM unix socket '" + str(self.unix_socket) + "':", str(e))
606 self.debug("attempting STREAM unix socket '" + str(self.unix_socket) + "'")
607 self._sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
608 self._sock.connect(self.unix_socket)
609 self.debug("connected STREAM unix socket '" + str(self.unix_socket) + "'")
611 except socket.error as e:
612 self.debug("Failed to connect STREAM unix socket '" + str(self.unix_socket) + "':", str(e))
613 self.error("Failed to connect to unix socket '" + str(self.unix_socket) + "':", str(e))
619 Recreate socket and connect to it since sockets cannot be reused after closing
620 Available configurations are IPv6, IPv4 or UNIX socket
624 if self.unix_socket is not None:
625 self._connect2unixsocket()
628 if self.__socket_config is not None:
629 self._connect2socket()
631 for res in socket.getaddrinfo(self.host, self.port, socket.AF_UNSPEC, socket.SOCK_STREAM):
632 if self._connect2socket(res): break
634 except Exception as e:
636 self.__socket_config = None
638 if self._sock is not None:
639 self._sock.setblocking(0)
640 self._sock.settimeout(5)
641 self.debug("set socket timeout to: " + str(self._sock.gettimeout()))
643 def _disconnect(self):
645 Close socket connection
648 if self._sock is not None:
650 self.debug("closing socket")
651 self._sock.shutdown(2) # 0 - read, 1 - write, 2 - all
662 # Send request if it is needed
663 if self.request != self.__empty_request:
665 self.debug("sending request:", str(self.request))
666 self._sock.send(self.request)
667 except Exception as e:
668 self._socketerror("error sending request:" + str(e))
675 Receive data from socket
680 self.debug("receiving response")
682 buf = self._sock.recv(4096)
683 except Exception as e:
684 self._socketerror("failed to receive response:" + str(e))
688 if buf is None or len(buf) == 0: # handle server disconnect
690 self._socketerror("unexpectedly disconnected")
692 self.debug("server closed the connection")
696 self.debug("received data:", str(buf))
697 data += buf.decode('utf-8', 'ignore')
698 if self._check_raw_data(data):
701 self.debug("final response:", str(data))
704 def _get_raw_data(self):
706 Get raw data with low-level "socket" module.
709 if self._sock is None:
711 if self._sock is None:
714 # Send request if it is needed
718 data = self._receive()
720 if not self._keep_alive:
725 def _check_raw_data(self, data):
727 Check if all data has been gathered from socket
733 def _parse_config(self):
735 Parse configuration data
738 if self.name is None or self.name == str(None):
741 self.name = str(self.name)
744 self.unix_socket = str(self.configuration['socket'])
745 except (KeyError, TypeError):
746 self.debug("No unix socket specified. Trying TCP/IP socket.")
747 self.unix_socket = None
749 self.host = str(self.configuration['host'])
750 except (KeyError, TypeError):
751 self.debug("No host specified. Using: '" + self.host + "'")
753 self.port = int(self.configuration['port'])
754 except (KeyError, TypeError):
755 self.debug("No port specified. Using: '" + str(self.port) + "'")
758 self.request = str(self.configuration['request'])
759 except (KeyError, TypeError):
760 self.debug("No request specified. Using: '" + str(self.request) + "'")
762 self.request = self.request.encode()
766 return SimpleService.check(self)
769 class LogService(SimpleService):
770 def __init__(self, configuration=None, name=None):
772 self._last_position = 0
773 # self._log_reader = None
774 SimpleService.__init__(self, configuration=configuration, name=name)
775 self.retries = 100000 # basically always retry
777 def _get_raw_data(self):
779 Get log lines since last poll
784 if os.path.getsize(self.log_path) < self._last_position:
785 self._last_position = 0 # read from beginning if file has shrunk
786 elif os.path.getsize(self.log_path) == self._last_position:
787 self.debug("Log file hasn't changed. No new data.")
788 return [] # return empty list if nothing has changed
789 with open(self.log_path, "r") as fp:
790 fp.seek(self._last_position)
791 for i, line in enumerate(fp):
793 self._last_position = fp.tell()
794 except Exception as e:
800 self.error("No data collected.")
805 Parse basic configuration and check if log file exists
808 if self.name is not None or self.name != str(None):
811 self.name = str(self.name)
813 self.log_path = str(self.configuration['path'])
814 except (KeyError, TypeError):
815 self.info("No path to log specified. Using: '" + self.log_path + "'")
817 if os.access(self.log_path, os.R_OK):
820 self.error("Cannot access file: '" + self.log_path + "'")
824 # set cursor at last byte of log file
825 self._last_position = os.path.getsize(self.log_path)
826 status = SimpleService.create(self)
827 # self._last_position = 0
831 class ExecutableService(SimpleService):
832 bad_substrings = ('&', '|', ';', '>', '<')
834 def __init__(self, configuration=None, name=None):
836 SimpleService.__init__(self, configuration=configuration, name=name)
838 def _get_raw_data(self):
840 Get raw data from executed command
844 p = Popen(self.command, stdout=PIPE, stderr=PIPE)
845 except Exception as e:
846 self.error("Executing command", self.command, "resulted in error:", str(e))
849 for line in p.stdout.readlines():
850 data.append(str(line.decode()))
853 self.error("No data collected.")
860 Parse basic configuration, check if command is whitelisted and is returning values
863 if self.name is not None or self.name != str(None):
866 self.name = str(self.name)
868 self.command = str(self.configuration['command'])
869 except (KeyError, TypeError):
870 self.info("No command specified. Using: '" + self.command + "'")
871 command = self.command.split(' ')
873 for arg in command[1:]:
874 if any(st in arg for st in self.bad_substrings):
875 self.error("Bad command argument:" + " ".join(self.command[1:]))
878 # test command and search for it in /usr/sbin or /sbin when failed
879 base = command[0].split('/')[-1]
880 if self._get_raw_data() is None:
881 for prefix in ['/sbin/', '/usr/sbin/']:
882 command[0] = prefix + base
883 if os.path.isfile(command[0]):
886 self.command = command
887 if self._get_data() is None or len(self._get_data()) == 0:
888 self.error("Command", self.command, "returned no data")