From eaed97cf4ff79bc1d5c5bc104a17117494864155 Mon Sep 17 00:00:00 2001 From: nico Date: Mon, 3 Feb 2020 20:49:52 +0100 Subject: [PATCH 1/3] utilize /etc/ directory + add config.py to read / touch create the etc config file _read(): tries to open the config files in read only mode to parse its contents. _check(): checks if the config file is present and then calls _read() if that is false it tries to touch create a new file. worst case scenario: file is present and holds content, the method assumes that the file isn't present. Therefore tries to touch-create a new file, if a file is against all odds present, only the mtime would be updated. Hence any file content would not be altered. get(): main method, calling _check() if a key is given return only the assigned value or None or return the whole dictionary --- .gitignore | 1 + config.py | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ influx.py | 8 ++------ 3 files changed, 59 insertions(+), 6 deletions(-) create mode 100644 config.py diff --git a/.gitignore b/.gitignore index 263cfcc..b4c2e09 100644 --- a/.gitignore +++ b/.gitignore @@ -110,6 +110,7 @@ dmypy.json # Pycharm .idea/ .venv/ +venv # config config.json diff --git a/config.py b/config.py new file mode 100644 index 0000000..374257e --- /dev/null +++ b/config.py @@ -0,0 +1,56 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +import json +import sys +from pathlib import Path + + +class Config: + def __init__(self): + # global config path + conf_path = '/etc/ejabberd-metrics.conf' + self.file = Path(conf_path) + + self.content = None + + def _read(self): + with open(self.file, 'r', encoding='utf-8') as f: + try: + self.content = json.load(f) + + # catch json decoding errors + except json.JSONDecodeError as err: + print(err, file=sys.stderr) + exit(1) + + def _check(self): + try: + # if file is present try to read it's contents + if self.file.exists(): + self._read() + + # if not create a blank file + else: + Path.touch(self.file) + + # catch permission exceptions as this tries to write to /etc/ + except PermissionError as err: + print(err, file=sys.stderr) + sys.exit(err.errno) + + def get(self, key: str = None) -> (dict, None): + self._check() + + # if a special key is request, return just that + if key is not None: + + # safety measure + if key in self.content: + return self.content[key] + + # if the key isn't part if self.content return None + else: + return None + + # else return everything + return self.content diff --git a/influx.py b/influx.py index 36d7a47..1557a6a 100644 --- a/influx.py +++ b/influx.py @@ -1,12 +1,10 @@ #!/usr/bin/env python3 # -*- coding: utf-8 -*- - -import json -import os import time from influxdb import InfluxDBClient +from config import Config from ejabberdrpc import EjabberdMetrics @@ -79,9 +77,7 @@ class Influx: if __name__ == '__main__': # load config - path = os.path.dirname(__file__) - with open('/'.join([path, 'config.json']), 'r', encoding='utf-8') as f: - config = json.load(f) + config = Config().get() # creds and params url = config['url'] if 'url' in config else 'http://localhost:5280/api' From ee4cb50ba654924a62d3d38110cc64d7edc8ea54 Mon Sep 17 00:00:00 2001 From: nico Date: Mon, 10 Feb 2020 00:06:59 +0100 Subject: [PATCH 2/3] config value defaults * config loads and reads the config file in the init method to reduce io operations + get method is now able to take 2 optional arguments, a request key and a definable default value --- config.py | 22 ++++++++++++++++------ influx.py | 16 ++++++++-------- 2 files changed, 24 insertions(+), 14 deletions(-) diff --git a/config.py b/config.py index 374257e..55b7639 100644 --- a/config.py +++ b/config.py @@ -10,10 +10,16 @@ class Config: # global config path conf_path = '/etc/ejabberd-metrics.conf' self.file = Path(conf_path) - self.content = None + # read config file + self._read() + def _read(self): + """init the config object with this method""" + self._check() + + # open and load json content from config with open(self.file, 'r', encoding='utf-8') as f: try: self.content = json.load(f) @@ -24,10 +30,11 @@ class Config: exit(1) def _check(self): + """internal method to check if the config file exists""" try: # if file is present try to read it's contents if self.file.exists(): - self._read() + return # if not create a blank file else: @@ -38,16 +45,19 @@ class Config: print(err, file=sys.stderr) sys.exit(err.errno) - def get(self, key: str = None) -> (dict, None): - self._check() - - # if a special key is request, return just that + def get(self, key: str = None, default: (str, int) = None) -> (dict, str, int, None): + """method to retrieve the whole config data, a single value or the optional default value""" + # if a special key is request, return only that value if key is not None: # safety measure if key in self.content: return self.content[key] + # if a default value is given return that + if default is not None: + return default + # if the key isn't part if self.content return None else: return None diff --git a/influx.py b/influx.py index 1557a6a..0b372ca 100644 --- a/influx.py +++ b/influx.py @@ -77,17 +77,17 @@ class Influx: if __name__ == '__main__': # load config - config = Config().get() + config = Config() - # creds and params - url = config['url'] if 'url' in config else 'http://localhost:5280/api' - login = config['login'] if 'login' in config else None - api = config['api'] if 'api' in config else 'rest' + # credentials and parameter + url = config.get('url', default='http://localhost:5280/api') + login = config.get('login', default=None) + api = config.get('api', default='rest') # config influxdb - influx_host = config['influxdb_host'] if 'influxdb_host' in config else 'localhost' - influx_port = config['influxdb_port'] if 'influxdb_port' in config else 8086 - influx_dbname = config['influxdb_db'] if 'influxdb_db' in config else 'ejabberd' + influx_host = config.get('influxdb_host', default='localhost') + influx_port = config.get('influxdb_port', default=8086) + influx_dbname = config.get('influxdb_db', default='ejabberd') # init handler metrics = EjabberdMetrics(url, login, api) From 54256587b1bf8c4a1bf0cefa38eece5aaee3103d Mon Sep 17 00:00:00 2001 From: nico Date: Sun, 16 Feb 2020 12:08:56 +0100 Subject: [PATCH 3/3] update plugins * add new config support to the Prometheus plugin * pep8 improvements --- influx.py | 2 +- prometheus.py | 34 +++++++++++++++------------------- 2 files changed, 16 insertions(+), 20 deletions(-) diff --git a/influx.py b/influx.py index 0b372ca..59728ac 100644 --- a/influx.py +++ b/influx.py @@ -79,7 +79,7 @@ if __name__ == '__main__': # load config config = Config() - # credentials and parameter + # credentials and parameters url = config.get('url', default='http://localhost:5280/api') login = config.get('login', default=None) api = config.get('api', default='rest') diff --git a/prometheus.py b/prometheus.py index dfca7d4..4aab1b3 100755 --- a/prometheus.py +++ b/prometheus.py @@ -1,14 +1,16 @@ #!/usr/bin/env python3 # -*- coding: utf-8 -*- -from ejabberdrpc import EjabberdMetrics - -import time -import threading import socket +import threading +import time from http.server import BaseHTTPRequestHandler, HTTPServer from socketserver import ThreadingMixIn +from config import Config +from ejabberdrpc import EjabberdMetrics + + class _ThreadingSimpleServer(ThreadingMixIn, HTTPServer): """Thread per request HTTP server.""" # Make worker threads "fire and forget". Beginning with Python 3.7 this @@ -65,10 +67,8 @@ class Prometheus(): for k, v in data.items(): output += self._parse_metric("ejabberd_online_client_ipversion", v, {"vhost": host, "node": node, "ipversion": str(k), "client": client}) - return output - def listen(self, port, addr='::'): """Starts an HTTP server for prometheus metrics as a daemon thread""" class myHandler(BaseHTTPRequestHandler): @@ -79,28 +79,24 @@ class Prometheus(): result = self._get_metrics() r.wfile.write(result.encode('utf-8')) - httpd = _ThreadingSimpleServer((addr, port), myHandler) t = threading.Thread(target=httpd.serve_forever) t.daemon = True t.start() + if __name__ == "__main__": - import os - import json - # load config - path = os.path.dirname(__file__) - with open("/".join([path, "config.json"]), "r", encoding="utf-8") as f: - config = json.load(f) + config = Config() + # credentials and parameters + url = config.get('url', default='http://[::1]:5280/api') + login = config.get('login', default=None) + api = config.get('api', default='rest') - url = config['url'] if "url" in config else "http://[::1]:5280/api" - login = config['login'] if "login" in config else None - api = config['api'] if "api" in config else "rest" - - prom_port = config['prometheus_port'] if "prometheus_port" in config else 8080 - prom_refresh = config['prometheus_refresh'] if "prometheus_refresh" in config else 10 + # config prometheus + prom_port = config.get('prometheus_port', default=8080) + prom_refresh = config.get('prometheus_refresh', default=10) metrics = EjabberdMetrics(url, login, api) prom = Prometheus(metrics)