diff options
author | nico <nico@magicbroccoli.de> | 2018-10-23 23:59:09 +0200 |
---|---|---|
committer | nico <nico@magicbroccoli.de> | 2018-10-23 23:59:09 +0200 |
commit | 524242c5e88a265d86946eee6eadf9f7ed1f7c74 (patch) | |
tree | d92596785ad35fb9139e8c24162630915924ed60 | |
parent | 3eafd661ad37d4bdc605ac43df1be01eb5aee81e (diff) | |
parent | b76ec89c3abd8d2df628fae02fc7b1f685a8d245 (diff) |
Merge branch 'dev'
+ added min value
+ added version check for the updates_available graph
* all plugin configs updated
* optimized requests.session code
* used os.environ.get to simplify code
* simplified self.run code
* reduced code clutter
* replaced for iterations with list comprehension
* updated config
- removed code clutter
-rwxr-xr-x | nextcloud_apps | 64 | ||||
-rwxr-xr-x | nextcloud_dbsize | 54 | ||||
-rwxr-xr-x | nextcloud_multi | 109 | ||||
-rwxr-xr-x | nextcloud_shares | 78 | ||||
-rwxr-xr-x | nextcloud_users | 66 |
5 files changed, 176 insertions, 195 deletions
diff --git a/nextcloud_apps b/nextcloud_apps index 228a197..e7ec543 100755 --- a/nextcloud_apps +++ b/nextcloud_apps @@ -22,12 +22,13 @@ class NextcloudApps: config = { 'apps': [ 'graph_title Nextcloud available App updates', - 'graph_args --base 1024 -l 0', + 'graph_args --base 1000 -l 0', 'graph_vlabel updates available', 'graph_info graph showing the number of available app updates', 'graph_category nextcloud', 'num_updates_available.label available app updates', - 'num_updates_available.info number of available app updates' + 'num_updates_available.info number of available app updates', + 'num_updates_available.min 0' ] } @@ -39,37 +40,32 @@ class NextcloudApps: } # precaution for Nextcloud versions prior to version 14 - try: + version = api_response['ocs']['data']['nextcloud']['system']['version'].split(sep=".") + + if int(version[0]) >= 14: num_updates_available = api_response['ocs']['data']['nextcloud']['system']['apps']['num_updates_available'] data['nextcloud_available_updates'].append('num_updates_available.value %s' % num_updates_available) - except KeyError: - return False return data def run(self): - # read the configuration from munin environment - URL = os.environ['url'] - auth = (os.environ['username'], os.environ['password']) - - # init requests session with specific header and credentials + # init request session with specific header and credentials with requests.Session() as s: - s.auth = auth + # read credentials from env + s.auth = (os.environ.get('username'), os.environ.get('password')) + + # update header for json s.headers.update({'Accept': 'application/json'}) - s.stream = False - # request data from api - r = s.get(URL) + # request the data + r = s.get(os.environ.get('url')) - # if status code is successful close connection and continue + # if status code is successful continue if r.status_code == 200: - s.close() - api_response = r.json() + result = self.get_data(r.json()) - result = self.get_data(api_response) - - for key in result.keys(): - print('\n'.join(result[key])) + # for key in results print every entry in dict + [print('\n'.join(result[key])) for key in result.keys()] elif r.status_code == 996: print('server error') @@ -81,26 +77,22 @@ class NextcloudApps: print('unknown error') def main(self): - if (sys.argv.__len__() == 2) and (sys.argv[1] == "config"): - for key in self.config().keys(): - print('\n'.join(self.config()[key])) - try: - if os.environ['MUNIN_CAP_DIRTYCONFIG'] == '1': + # check if any argument is given + if sys.argv.__len__() >= 2: + # check if first argument is config or autoconf if not fetch data + if sys.argv[1] == "config": + # for key in config().keys() print every entry in dict + [print('\n'.join(self.config()[key])) for key in self.config().keys()] + if os.environ.get('MUNIN_CAP_DIRTYCONFIG') == '1': self.run() - except KeyError: - pass - - elif (sys.argv.__len__() == 2) and (sys.argv[1] == 'autoconf'): - # check host if env variables are set - try: - if None not in {os.environ['url'], os.environ['username'], os.environ['password']}: + elif sys.argv[1] == 'autoconf': + if None in [os.environ.get('username'), os.environ.get('password')]: + print('env variables are missing') + else: print('yes') - except KeyError: - print('no env configuration options are missing') else: self.run() if __name__ == "__main__": NextcloudApps().main() - quit(0) diff --git a/nextcloud_dbsize b/nextcloud_dbsize index fc4f035..0d4ce9d 100755 --- a/nextcloud_dbsize +++ b/nextcloud_dbsize @@ -29,6 +29,7 @@ class NextcloudDB: 'db_size.label database size in byte', 'db_size.info users connected in the last 5 minutes', 'db_size.draw AREA', + 'db_size.min 0' ] } @@ -45,28 +46,23 @@ class NextcloudDB: return data def run(self): - # read the configuration from munin environment - URL = os.environ['url'] - auth = (os.environ['username'], os.environ['password']) - - # init requests session with specific header and credentials + # init request session with specific header and credentials with requests.Session() as s: - s.auth = auth + # read credentials from env + s.auth = (os.environ.get('username'), os.environ.get('password')) + + # update header for json s.headers.update({'Accept': 'application/json'}) - s.stream = False - # request data from api - r = s.get(URL) + # request the data + r = s.get(os.environ.get('url')) - # if status code is successful close connection and continue + # if status code is successful continue if r.status_code == 200: - s.close() - api_response = r.json() + result = self.get_data(r.json()) - result = self.get_data(api_response) - - for key in result.keys(): - print('\n'.join(result[key])) + # for key in results print every entry in dict + [print('\n'.join(result[key])) for key in result.keys()] elif r.status_code == 996: print('server error') @@ -78,26 +74,22 @@ class NextcloudDB: print('unknown error') def main(self): - if (sys.argv.__len__() == 2) and (sys.argv[1] == "config"): - for key in self.config().keys(): - print('\n'.join(self.config()[key])) - try: - if os.environ['MUNIN_CAP_DIRTYCONFIG'] == '1': + # check if any argument is given + if sys.argv.__len__() >= 2: + # check if first argument is config or autoconf if not fetch data + if sys.argv[1] == "config": + # for key in config().keys() print every entry in dict + [print('\n'.join(self.config()[key])) for key in self.config().keys()] + if os.environ.get('MUNIN_CAP_DIRTYCONFIG') == '1': self.run() - except KeyError: - pass - - elif (sys.argv.__len__() == 2) and (sys.argv[1] == 'autoconf'): - # check host if env variables are set - try: - if None not in {os.environ['url'], os.environ['username'], os.environ['password']}: + elif sys.argv[1] == 'autoconf': + if None in [os.environ.get('username'), os.environ.get('password')]: + print('env variables are missing') + else: print('yes') - except KeyError: - print('no env configuration options are missing') else: self.run() if __name__ == "__main__": NextcloudDB().main() - quit(0) diff --git a/nextcloud_multi b/nextcloud_multi index 62d59c8..c419ee1 100755 --- a/nextcloud_multi +++ b/nextcloud_multi @@ -19,7 +19,6 @@ import requests import sys import os -import re class NextcloudMultiGraph: @@ -28,39 +27,49 @@ class NextcloudMultiGraph: 'users': [ 'multigraph nextcloud_users', 'graph_title Nextcloud User Activity', - 'graph_args --base 1024 -l 0', + 'graph_args --base 1000 -l 0', 'graph_printf %.0lf', 'graph_vlabel connected users', 'graph_info graph showing the number of connected user', 'graph_category nextcloud', 'last5minutes.label last 5 minutes', 'last5minutes.info users connected in the last 5 minutes', + 'last5minutes.min 0', 'last1hour.label last hour', 'last1hour.info users connected in the last hour', + 'last1hour.min 0', 'last24hours.label last 24 hours', - 'last24hours.info users connected in the last 24 hours' + 'last24hours.info users connected in the last 24 hours', + 'last24hours.min 0' ], 'shares': [ 'multigraph nextcloud_shares', 'graph_title Nextcloud Shares', - 'graph_args --base 1024 -l 0', + 'graph_args --base 1000 -l 0', 'graph_vlabel number of shares', 'graph_info graph showing the number of shares', 'graph_category nextcloud', 'num_fed_shares_received.label federated shares recieved', 'num_fed_shares_received.info current total of federated shares recieved', + 'num_fed_shares_received.min 0', 'num_fed_shares_sent.label federated shares sent', 'num_fed_shares_sent.info current total of federated shares sent', + 'num_fed_shares_sent.min 0', 'num_shares.label total number of shares', 'num_shares.info current over all total of shares', + 'num_shares.min 0', 'num_shares_groups.label group shares', 'num_shares_groups.info current total of group shares', + 'num_shares_groups.min 0', 'num_shares_link.label link shares', 'num_shares_link.info current total of shares through a link', + 'num_shares_link.min 0', 'num_shares_link_no_password.label link shares without a password', 'num_shares_link_no_password.info current total of shares through a link without a password protection', + 'num_shares_link_no_password.min 0', 'num_shares_user.label user shares', - 'num_shares_user.info current total of user shares' + 'num_shares_user.info current total of user shares', + 'num_shares_user.min 0' ], 'dbsize': [ 'multigraph nextcloud_dbsize', @@ -72,81 +81,81 @@ class NextcloudMultiGraph: 'db_size.label database size in byte', 'db_size.info users connected in the last 5 minutes', 'db_size.draw AREA', + 'db_size.min 0' ], 'available_updates': [ 'multigraph nextcloud_available_updates', 'graph_title Nextcloud available App updates', - 'graph_args --base 1024 -l 0', + 'graph_args --base 1000 -l 0', 'graph_vlabel updates available', 'graph_info graph showing the number of available app updates', 'graph_category nextcloud', 'num_updates_available.label available app updates', 'num_updates_available.info number of available app updates', + 'num_updates_available.min 0' ] } return config def get_data(self, api_response): - data ={ + data = { 'nextcloud_users': [], 'nextcloud_shares': [], 'nextcloud_dbsize': [], 'nextcloud_available_updates': [] } - users = api_response['ocs']['data']['activeUsers'] - shares = api_response['ocs']['data']['nextcloud']['shares'] - dbsize = api_response['ocs']['data']['server']['database']['size'] + # users + users = api_response['ocs']['data']['activeUsers'] data['nextcloud_users'].append('multigraph nextcloud_users') - for key in users.keys(): - data['nextcloud_users'].append(str(key) + ".value " + str(users[key])) - # use regex to remove permission stats from api response - reg = re.compile("num.*") - share_keys = shares.keys() - sharelist = list(filter(reg.match, share_keys)) + # append for every key in users the key and the value to the results + [data['nextcloud_users'].append(str(key) + ".value " + str(users[key])) + for key in users.keys()] + # shares + shares = api_response['ocs']['data']['nextcloud']['shares'] data['nextcloud_shares'].append('multigraph nextcloud_shares') - for key in sharelist: - data['nextcloud_shares'].append(str(key) + ".value " + str(shares[key])) + # append for every key in shares the key and the value if the key starts with "num" + [data['nextcloud_shares'].append(str(key) + ".value " + str(shares[key])) + for key in shares if key.startswith('num')] + + # dbsize + dbsize = api_response['ocs']['data']['server']['database']['size'] data['nextcloud_dbsize'].append('multigraph nextcloud_dbsize') data['nextcloud_dbsize'].append('db_size.value %s' % dbsize) + # app updates # precaution for Nextcloud versions prior to version 14 - try: + version = api_response['ocs']['data']['nextcloud']['system']['version'].split(sep=".") + + if int(version[0]) >= 14: num_updates_available = api_response['ocs']['data']['nextcloud']['system']['apps']['num_updates_available'] data['nextcloud_available_updates'].append('multigraph nextcloud_available_updates') data['nextcloud_available_updates'].append('num_updates_available.value %s' % num_updates_available) - except KeyError: - return False return data def run(self): - # read the configuration from munin environment - URL = os.environ['url'] - auth = (os.environ['username'], os.environ['password']) - - # init requests session with specific header and credentials + # init request session with specific header and credentials with requests.Session() as s: - s.auth = auth + # read credentials from env + s.auth = (os.environ.get('username'), os.environ.get('password')) + + # update header for json s.headers.update({'Accept': 'application/json'}) - s.stream = False - # request data from api - r = s.get(URL) + # request the data + r = s.get(os.environ.get('url')) - # if status code is successful close connection and continue + # if status code is successful continue if r.status_code == 200: - s.close() - api_response = r.json() - - result = self.get_data(api_response) + result = self.get_data(r.json()) - for key in result.keys(): - print('\n'.join(result[key])) + # for key in results print every entry in dict + [print('\n'.join(result[key])) for key in result.keys()] elif r.status_code == 996: print('server error') @@ -158,26 +167,22 @@ class NextcloudMultiGraph: print('unknown error') def main(self): - if (sys.argv.__len__() == 2) and (sys.argv[1] == "config"): - for key in self.config().keys(): - print('\n'.join(self.config()[key])) - try: - if os.environ['MUNIN_CAP_DIRTYCONFIG'] == '1': + # check if any argument is given + if sys.argv.__len__() >= 2: + # check if first argument is config or autoconf if not fetch data + if sys.argv[1] == "config": + # for key in config().keys() print every entry in dict + [print('\n'.join(self.config()[key])) for key in self.config().keys()] + if os.environ.get('MUNIN_CAP_DIRTYCONFIG') == '1': self.run() - except KeyError: - pass - - elif (sys.argv.__len__() == 2) and (sys.argv[1] == 'autoconf'): - # check host if env variables are set - try: - if None not in {os.environ['url'], os.environ['username'], os.environ['password']}: + elif sys.argv[1] == 'autoconf': + if None in [os.environ.get('username'), os.environ.get('password')]: + print('env variables are missing') + else: print('yes') - except KeyError: - print('no env configuration options are missing') else: self.run() if __name__ == "__main__": NextcloudMultiGraph().main() - quit(0) diff --git a/nextcloud_shares b/nextcloud_shares index 8e5173f..dc56fba 100755 --- a/nextcloud_shares +++ b/nextcloud_shares @@ -23,24 +23,31 @@ class NextcloudShares: config = { 'shares': [ 'graph_title Nextcloud Shares', - 'graph_args --base 1024 -l 0', + 'graph_args --base 1000 -l 0', 'graph_vlabel number of shares', 'graph_info graph showing the number of shares', 'graph_category nextcloud', 'num_fed_shares_received.label federated shares recieved', 'num_fed_shares_received.info current total of federated shares recieved', + 'num_fed_shares_received.min 0', 'num_fed_shares_sent.label federated shares sent', 'num_fed_shares_sent.info current total of federated shares sent', + 'num_fed_shares_sent.min 0', 'num_shares.label total number of shares', 'num_shares.info current over all total of shares', + 'num_shares.min 0', 'num_shares_groups.label group shares', 'num_shares_groups.info current total of group shares', + 'num_shares_groups.min 0', 'num_shares_link.label link shares', 'num_shares_link.info current total of shares through a link', + 'num_shares_link.min 0', 'num_shares_link_no_password.label link shares without a password', 'num_shares_link_no_password.info current total of shares through a link without a password protection', + 'num_shares_link_no_password.min 0', 'num_shares_user.label user shares', - 'num_shares_user.info current total of user shares' + 'num_shares_user.info current total of user shares', + 'num_shares_user.min 0' ] } @@ -50,41 +57,35 @@ class NextcloudShares: data ={ 'nextcloud_shares': [], } - shares = api_response['ocs']['data']['nextcloud']['shares'] - # use regex to remove permission stats from api response - reg = re.compile("num.*") - share_keys = shares.keys() - sharelist = list(filter(reg.match, share_keys)) + # shares + shares = api_response['ocs']['data']['nextcloud']['shares'] + data['nextcloud_shares'].append('multigraph nextcloud_shares') - for key in sharelist: - data['nextcloud_shares'].append(str(key) + ".value " + str(shares[key])) + # append for every key in shares the key and the value if the key starts with "num" + [data['nextcloud_shares'].append(str(key) + ".value " + str(shares[key])) + for key in shares if key.startswith('num')] return data def run(self): - # read the configuration from munin environment - URL = os.environ['url'] - auth = (os.environ['username'], os.environ['password']) - - # init requests session with specific header and credentials + # init request session with specific header and credentials with requests.Session() as s: - s.auth = auth + # read credentials from env + s.auth = (os.environ.get('username'), os.environ.get('password')) + + # update header for json s.headers.update({'Accept': 'application/json'}) - s.stream = False - # request data from api - r = s.get(URL) + # request the data + r = s.get(os.environ.get('url')) - # if status code is successful close connection and continue + # if status code is successful continue if r.status_code == 200: - s.close() - api_response = r.json() + result = self.get_data(r.json()) - result = self.get_data(api_response) - - for key in result.keys(): - print('\n'.join(result[key])) + # for key in results print every entry in dict + [print('\n'.join(result[key])) for key in result.keys()] elif r.status_code == 996: print('server error') @@ -96,26 +97,21 @@ class NextcloudShares: print('unknown error') def main(self): - if (sys.argv.__len__() == 2) and (sys.argv[1] == "config"): - for key in self.config().keys(): - print('\n'.join(self.config()[key])) - try: - if os.environ['MUNIN_CAP_DIRTYCONFIG'] == '1': + # check if any argument is given + if sys.argv.__len__() >= 2: + # check if first argument is config or autoconf if not fetch data + if sys.argv[1] == "config": + # for key in config().keys() print every entry in dict + [print('\n'.join(self.config()[key])) for key in self.config().keys()] + if os.environ.get('MUNIN_CAP_DIRTYCONFIG') == '1': self.run() - except KeyError: - pass - - elif (sys.argv.__len__() == 2) and (sys.argv[1] == 'autoconf'): - # check host if env variables are set - try: - if None not in {os.environ['url'], os.environ['username'], os.environ['password']}: + elif sys.argv[1] == 'autoconf': + if None in [os.environ.get('username'), os.environ.get('password')]: + print('env variables are missing') + else: print('yes') - except KeyError: - print('no env configuration options are missing') else: self.run() - if __name__ == "__main__": NextcloudShares().main() - quit(0) diff --git a/nextcloud_users b/nextcloud_users index 1e62dc3..350f14e 100755 --- a/nextcloud_users +++ b/nextcloud_users @@ -22,17 +22,20 @@ class NextcloudUsers: config = { 'users': [ 'graph_title Nextcloud User Activity', - 'graph_args --base 1024 -l 0', + 'graph_args --base 1000 -l 0', 'graph_printf %.0lf', 'graph_vlabel connected users', 'graph_info graph showing the number of connected user', 'graph_category nextcloud', 'last5minutes.label last 5 minutes', 'last5minutes.info users connected in the last 5 minutes', + 'last5minutes.min 0', 'last1hour.label last hour', 'last1hour.info users connected in the last hour', + 'last1hour.min 0', 'last24hours.label last 24 hours', - 'last24hours.info users connected in the last 24 hours' + 'last24hours.info users connected in the last 24 hours', + 'last24hours.min 0' ] } @@ -42,36 +45,33 @@ class NextcloudUsers: data ={ 'nextcloud_users': [], } + # users users = api_response['ocs']['data']['activeUsers'] - for key in users.keys(): - data['nextcloud_users'].append(str(key) + ".value " + str(users[key])) + # append for every key in users the key and the value to the results + [data['nextcloud_users'].append(str(key) + ".value " + str(users[key])) + for key in users.keys()] return data def run(self): - # read the configuration from munin environment - URL = os.environ['url'] - auth = (os.environ['username'], os.environ['password']) - - # init requests session with specific header and credentials + # init request session with specific header and credentials with requests.Session() as s: - s.auth = auth + # read credentials from env + s.auth = (os.environ.get('username'), os.environ.get('password')) + + # update header for json s.headers.update({'Accept': 'application/json'}) - s.stream = False - # request data from api - r = s.get(URL) + # request the data + r = s.get(os.environ.get('url')) - # if status code is successful close connection and continue + # if status code is successful continue if r.status_code == 200: - s.close() - api_response = r.json() + result = self.get_data(r.json()) - result = self.get_data(api_response) - - for key in result.keys(): - print('\n'.join(result[key])) + # for key in results print every entry in dict + [print('\n'.join(result[key])) for key in result.keys()] elif r.status_code == 996: print('server error') @@ -83,26 +83,22 @@ class NextcloudUsers: print('unknown error') def main(self): - if (sys.argv.__len__() == 2) and (sys.argv[1] == "config"): - for key in self.config().keys(): - print('\n'.join(self.config()[key])) - try: - if os.environ['MUNIN_CAP_DIRTYCONFIG'] == '1': + # check if any argument is given + if sys.argv.__len__() >= 2: + # check if first argument is config or autoconf if not fetch data + if sys.argv[1] == "config": + # for key in config().keys() print every entry in dict + [print('\n'.join(self.config()[key])) for key in self.config().keys()] + if os.environ.get('MUNIN_CAP_DIRTYCONFIG') == '1': self.run() - except KeyError: - pass - - elif (sys.argv.__len__() == 2) and (sys.argv[1] == 'autoconf'): - # check host if env variables are set - try: - if None not in {os.environ['url'], os.environ['username'], os.environ['password']}: + elif sys.argv[1] == 'autoconf': + if None in [os.environ.get('username'), os.environ.get('password')]: + print('env variables are missing') + else: print('yes') - except KeyError: - print('no env configuration options are missing') else: self.run() if __name__ == "__main__": NextcloudUsers().main() - quit(0) |