2 # -*- coding: utf-8 -*-
4 # Description: netdata python modules supervisor
5 # Author: Pawel Krupa (paulfantom)
11 # -----------------------------------------------------------------------------
12 # globals & environment setup
13 # https://github.com/firehol/netdata/wiki/External-Plugins#environment-variables
14 MODULE_EXTENSION = ".chart.py"
15 BASE_CONFIG = {'update_every': os.getenv('NETDATA_UPDATE_EVERY', 1),
19 MODULES_DIR = os.path.abspath(os.getenv('NETDATA_PLUGINS_DIR',
20 os.path.dirname(__file__)) + "/../python.d") + "/"
21 CONFIG_DIR = os.getenv('NETDATA_CONFIG_DIR', "/etc/netdata/")
22 # directories should end with '/'
23 if CONFIG_DIR[-1] != "/":
25 sys.path.append(MODULES_DIR + "python_modules")
27 PROGRAM = os.path.basename(__file__).replace(".plugin", "")
29 OVERRIDE_UPDATE_EVERY = False
32 # -----------------------------------------------------------------------------
34 def log_msg(msg_type, *args):
36 Print message on stderr.
39 sys.stderr.write(PROGRAM)
41 sys.stderr.write(msg_type)
42 sys.stderr.write(": ")
45 sys.stderr.write(str(i))
46 sys.stderr.write("\n")
52 Print debug message on stderr.
57 log_msg("DEBUG", *args)
62 Print message on stderr.
64 log_msg("ERROR", *args)
69 Print message on stderr.
71 log_msg("INFO", *args)
76 Print message on stderr and exit.
78 log_msg("FATAL", *args)
79 sys.stdout.write('DISABLE\n')
83 # -----------------------------------------------------------------------------
84 # third party and version specific python modules management
86 assert sys.version_info >= (3, 1)
87 import importlib.machinery
89 # change this hack below if we want PY_VERSION to be used in modules
91 # builtins.PY_VERSION = 3
93 info('Using python v3')
94 except (AssertionError, ImportError):
98 # change this hack below if we want PY_VERSION to be used in modules
100 # __builtin__.PY_VERSION = 2
102 info('Using python v2')
104 fatal('Cannot start. No importlib.machinery on python3 or lack of imp on python2')
108 fatal('Cannot find yaml library')
111 class PythonCharts(object):
113 Main class used to control every python module.
117 modules_path='../python.d/',
118 modules_configs='../conf.d/',
119 modules_disabled=None):
122 :param modules_path: str
123 :param modules_configs: str
124 :param modules_disabled: list
129 if modules_disabled is None:
130 modules_disabled = []
132 self.first_run = True
133 # set configuration directory
134 self.configs = modules_configs
137 loaded_modules = self._load_modules(modules_path, modules, modules_disabled)
139 # load configuration files
140 configured_modules = self._load_configs(loaded_modules)
142 # good economy and prosperity:
143 self.jobs = self._create_jobs(configured_modules) # type: list
145 # enable timetable override like `python.d.plugin mysql debug 1`
146 if DEBUG_FLAG and OVERRIDE_UPDATE_EVERY:
147 for job in self.jobs:
148 job.create_timetable(BASE_CONFIG['update_every'])
151 def _import_module(path, name=None):
153 Try to import module using only its path.
160 name = path.split('/')[-1]
161 if name[-len(MODULE_EXTENSION):] != MODULE_EXTENSION:
163 name = name[:-len(MODULE_EXTENSION)]
166 return importlib.machinery.SourceFileLoader(name, path).load_module()
168 return imp.load_source(name, path)
169 except Exception as e:
170 error("Problem loading", name, str(e))
173 def _load_modules(self, path, modules, disabled):
175 Load modules from 'modules' list or dynamically every file from 'path' (only .chart.py files)
178 :param disabled: list
182 # check if plugin directory exists
183 if not os.path.isdir(path):
184 fatal("cannot find charts directory ", path)
192 mod = self._import_module(path + m + MODULE_EXTENSION)
195 else: # exit if plugin is not found
196 fatal('no modules found.')
198 # scan directory specified in path and load all modules from there
199 names = os.listdir(path)
201 if mod.replace(MODULE_EXTENSION,"") in disabled:
202 error(mod + ": disabled module ", mod.replace(MODULE_EXTENSION,""))
204 m = self._import_module(path + mod)
206 debug(mod + ": loading module '" + path + mod + "'")
210 def _load_configs(self, modules):
212 Append configuration in list named `config` to every module.
213 For multi-job modules `config` list is created in _parse_config,
214 otherwise it is created here based on BASE_CONFIG prototype with None as identifier.
219 configfile = self.configs + mod.__name__ + ".conf"
220 if os.path.isfile(configfile):
221 debug(mod.__name__ + ": loading module configuration: '" + configfile + "'")
225 self._parse_config(mod, read_config(configfile)))
226 except Exception as e:
227 error(mod.__name__ + ": cannot parse configuration file '" + configfile + "':", str(e))
229 error(mod.__name__ + ": configuration file '" + configfile + "' not found. Using defaults.")
230 # set config if not found
231 if not hasattr(mod, 'config'):
232 debug(mod.__name__ + ": setting configuration for only one job")
233 mod.config = {None: {}}
234 for var in BASE_CONFIG:
236 mod.config[None][var] = getattr(mod, var)
237 except AttributeError:
238 mod.config[None][var] = BASE_CONFIG[var]
242 def _parse_config(module, config):
244 Parse configuration file or extract configuration from module file.
245 Example of returned dictionary:
251 :param module: object
257 debug(module.__name__ + ": reading configuration")
258 for key in BASE_CONFIG:
260 # get defaults from module config
261 defaults[key] = int(config.pop(key))
262 except (KeyError, ValueError):
264 # get defaults from module source code
265 defaults[key] = getattr(module, key)
266 except (KeyError, ValueError):
267 # if above failed, get defaults from global dict
268 defaults[key] = BASE_CONFIG[key]
270 # check if there are dict in config dict
273 if type(config[name]) is dict:
277 # assign variables needed by supervisor to every job configuration
281 if key not in config[name]:
282 config[name][key] = defaults[key]
283 # if only one job is needed, values doesn't have to be in dict (in YAML)
285 config = {None: config.copy()}
286 config[None].update(defaults)
288 # return dictionary of jobs where every job has BASE_CONFIG variables
292 def _create_jobs(modules):
294 Create jobs based on module.config dictionary and module.Service class definition.
299 for module in modules:
300 for name in module.config:
302 conf = module.config[name]
304 job = module.Service(configuration=conf, name=name)
305 except Exception as e:
306 error(module.__name__ +
307 ("/" + str(name) if name is not None else "") +
308 ": cannot start job: '" +
312 # set chart_name (needed to plot run time graphs)
313 job.chart_name = module.__name__
315 job.chart_name += "_" + name
317 debug(module.__name__ + ("/" + str(name) if name is not None else "") + ": job added")
319 return [j for j in jobs if j is not None]
321 def _stop(self, job, reason=None):
323 Stop specified job and remove it from self.jobs list
324 Also notifies user about job failure if DEBUG_FLAG is set
328 prefix = job.__module__
329 if job.name is not None:
330 prefix += "/" + job.name
333 self.jobs.remove(job)
336 elif reason[:3] == "no ":
338 "does not seem to have " +
340 "() function. Disabling it.")
341 elif reason[:7] == "failed ":
344 "() function reports failure.")
345 elif reason[:13] == "configuration":
347 "configuration file '" +
350 ".conf' not found. Using defaults.")
351 elif reason[:11] == "misbehaving":
352 error(prefix + "is " + reason)
356 Tries to execute check() on every job.
357 This cannot fail thus it is catching every exception
358 If job.check() fails job is stopped
361 while i < len(self.jobs):
365 self._stop(job, "failed check")
367 debug(job.chart_name, ": check succeeded")
369 except AttributeError:
370 self._stop(job, "no check")
371 except (UnboundLocalError, Exception) as e:
372 self._stop(job, "misbehaving. Reason:" + str(e))
376 Tries to execute create() on every job.
377 This cannot fail thus it is catching every exception.
378 If job.create() fails job is stopped.
379 This is also creating job run time chart.
382 while i < len(self.jobs):
386 self._stop(job, "failed create")
388 chart = job.chart_name
390 "CHART netdata.plugin_pythond_" +
392 " '' 'Execution time for " +
394 " plugin' 'milliseconds / run' python.d netdata.plugin_python area 145000 " +
395 str(job.timetable['freq']) +
397 sys.stdout.write("DIMENSION run_time 'run time' absolute 1 1\n\n")
398 debug("created charts for", job.chart_name)
401 except AttributeError:
402 self._stop(job, "no create")
403 except (UnboundLocalError, Exception) as e:
404 self._stop(job, "misbehaving. Reason: " + str(e))
406 def _update_job(self, job):
408 Tries to execute update() on specified job.
409 This cannot fail thus it is catching every exception.
410 If job.update() returns False, number of retries_left is decremented.
411 If there are no more retries, job is stopped.
412 Job is also stopped if it throws an exception.
413 This is also updating job run time chart.
414 Return False if job is stopped
418 t_start = time.time()
419 # check if it is time to execute job update() function
420 if job.timetable['next'] > t_start:
421 debug(job.chart_name + " will be run in " + str(int((job.timetable['next'] - t_start) * 1000)) + " ms")
427 since_last = int((t_start - job.timetable['last']) * 1000000)
428 debug(job.chart_name +
429 " ready to run, after " + str(int((t_start - job.timetable['last']) * 1000)) +
430 " ms (update_every: " + str(job.timetable['freq'] * 1000) +
431 " ms, latency: " + str(int((t_start - job.timetable['next']) * 1000)) + " ms)")
432 if not job.update(since_last):
433 if job.retries_left <= 0:
434 self._stop(job, "update failed")
436 job.retries_left -= 1
437 job.timetable['next'] += job.timetable['freq']
439 except AttributeError:
440 self._stop(job, "no update")
442 except (UnboundLocalError, Exception) as e:
443 self._stop(job, "misbehaving. Reason: " + str(e))
446 job.timetable['next'] = t_end - (t_end % job.timetable['freq']) + job.timetable['freq']
447 # draw performance graph
448 run_time = str(int((t_end - t_start) * 1000))
449 debug(job.chart_name, "updated in", run_time, "ms")
450 sys.stdout.write("BEGIN netdata.plugin_pythond_" + job.chart_name + " " + str(since_last) + '\n')
451 sys.stdout.write("SET run_time = " + run_time + '\n')
452 sys.stdout.write("END\n")
454 job.timetable['last'] = t_start
455 job.retries_left = job.retries
456 self.first_run = False
461 Tries to execute update() on every job by using _update_job()
462 This will stay forever and ever and ever forever and ever it'll be the one...
464 self.first_run = True
468 while i < len(self.jobs):
470 if self._update_job(job):
472 next_runs.append(job.timetable['next'])
476 if len(next_runs) == 0:
477 fatal('no python.d modules loaded.')
478 time.sleep(min(next_runs) - time.time())
481 def read_config(path):
483 Read YAML configuration from specified file
488 with open(path, 'r') as stream:
489 config = yaml.load(stream)
490 except (OSError, IOError):
491 error(str(path), "is not a valid configuration file")
493 except yaml.YAMLError as e:
494 error(str(path), "is malformed:", e)
499 def parse_cmdline(directory, *commands):
501 Parse parameters from command line.
502 :param directory: str
503 :param commands: list of str
507 global OVERRIDE_UPDATE_EVERY
510 changed_update = False
512 for cmd in commands[1:]:
515 elif cmd == "debug" or cmd == "all":
517 # redirect stderr to stdout?
518 elif os.path.isfile(directory + cmd + ".chart.py") or os.path.isfile(directory + cmd):
520 mods.append(cmd.replace(".chart.py", ""))
523 BASE_CONFIG['update_every'] = int(cmd)
524 changed_update = True
527 if changed_update and DEBUG_FLAG:
528 OVERRIDE_UPDATE_EVERY = True
529 debug(PROGRAM, "overriding update interval to", str(BASE_CONFIG['update_every']))
531 debug("started from", commands[0], "with options:", *commands[1:])
536 # if __name__ == '__main__':
541 global DEBUG_FLAG, BASE_CONFIG
543 # read configuration file
545 configfile = CONFIG_DIR + "python.d.conf"
546 debug(PROGRAM, "reading configuration file:", configfile)
548 conf = read_config(configfile)
551 # exit the whole plugin when 'enabled: no' is set in 'python.d.conf'
552 if conf['enabled'] is False:
553 fatal('disabled in configuration file.\n')
554 except (KeyError, TypeError):
557 for param in BASE_CONFIG:
558 BASE_CONFIG[param] = conf[param]
559 except (KeyError, TypeError):
560 pass # use default update_every from NETDATA_UPDATE_EVERY
562 DEBUG_FLAG = conf['debug']
563 except (KeyError, TypeError):
565 for k, v in conf.items():
566 if k in ("update_every", "debug", "enabled"):
571 # parse passed command line arguments
572 modules = parse_cmdline(MODULES_DIR, *sys.argv)
573 info("MODULES_DIR='" + MODULES_DIR +
574 "', CONFIG_DIR='" + CONFIG_DIR +
575 "', UPDATE_EVERY=" + str(BASE_CONFIG['update_every']) +
576 ", ONLY_MODULES=" + str(modules))
579 modules = ['apache', 'nginx']
580 charts = PythonCharts(modules, MODULES_DIR, CONFIG_DIR + "python.d/", disabled)
587 if __name__ == '__main__':