From 35647c091d183372e6acdbf1aec9c5d11b334fc6 Mon Sep 17 00:00:00 2001 From: nico Date: Tue, 13 Nov 2018 01:36:26 +0100 Subject: PEP8 + file corrections - remove unused import * change file ending for Codacy * PEP8 corrections + added a requirements.txt file --- nextcloud_apps | 98 -------------------------- nextcloud_apps.py | 98 ++++++++++++++++++++++++++ nextcloud_dbsize | 95 ------------------------- nextcloud_dbsize.py | 95 +++++++++++++++++++++++++ nextcloud_multi | 195 ---------------------------------------------------- nextcloud_multi.py | 195 ++++++++++++++++++++++++++++++++++++++++++++++++++++ nextcloud_shares | 117 ------------------------------- nextcloud_shares.py | 117 +++++++++++++++++++++++++++++++ nextcloud_users | 111 ------------------------------ nextcloud_users.py | 111 ++++++++++++++++++++++++++++++ requirements.txt | 1 + 11 files changed, 617 insertions(+), 616 deletions(-) delete mode 100755 nextcloud_apps create mode 100644 nextcloud_apps.py delete mode 100755 nextcloud_dbsize create mode 100644 nextcloud_dbsize.py delete mode 100755 nextcloud_multi create mode 100644 nextcloud_multi.py delete mode 100755 nextcloud_shares create mode 100644 nextcloud_shares.py delete mode 100755 nextcloud_users create mode 100644 nextcloud_users.py create mode 100644 requirements.txt diff --git a/nextcloud_apps b/nextcloud_apps deleted file mode 100755 index e7ec543..0000000 --- a/nextcloud_apps +++ /dev/null @@ -1,98 +0,0 @@ -#!/usr/bin/env python3 -# -*- coding: utf-8 -*- - -# Plugin to monitor the number of available nextcloud app updates -# -# Parameters understood: -# config (required) -# autoconf (optional - used by munin-config) - -# Magic markers - optional - used by installation scripts and -# munin-config: -# -# #%# family=manual -# #%# capabilities=autoconf -import requests -import sys -import os - - -class NextcloudApps: - def config(self): - config = { - 'apps': [ - 'graph_title Nextcloud available App updates', - '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 ={ - 'nextcloud_available_updates': [] - } - - # precaution for Nextcloud versions prior to version 14 - 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) - - return data - - def run(self): - # init request session with specific header and credentials - with requests.Session() as s: - # read credentials from env - s.auth = (os.environ.get('username'), os.environ.get('password')) - - # update header for json - s.headers.update({'Accept': 'application/json'}) - - # request the data - r = s.get(os.environ.get('url')) - - # if status code is successful continue - if r.status_code == 200: - result = self.get_data(r.json()) - - # 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') - elif r.status_code == 997: - print('not authorized') - elif r.status_code == 998: - print('not found') - else: - print('unknown error') - - def main(self): - # 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() - elif sys.argv[1] == 'autoconf': - if None in [os.environ.get('username'), os.environ.get('password')]: - print('env variables are missing') - else: - print('yes') - else: - self.run() - - -if __name__ == "__main__": - NextcloudApps().main() diff --git a/nextcloud_apps.py b/nextcloud_apps.py new file mode 100644 index 0000000..4ef3abc --- /dev/null +++ b/nextcloud_apps.py @@ -0,0 +1,98 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- + +# Plugin to monitor the number of available nextcloud app updates +# +# Parameters understood: +# config (required) +# autoconf (optional - used by munin-config) + +# Magic markers - optional - used by installation scripts and +# munin-config: +# +# #%# family=manual +# #%# capabilities=autoconf +import requests +import sys +import os + + +class NextcloudApps: + def config(self): + config = { + 'apps': [ + 'graph_title Nextcloud available App updates', + '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 = { + 'nextcloud_available_updates': [] + } + + # precaution for Nextcloud versions prior to version 14 + 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) + + return data + + def run(self): + # init request session with specific header and credentials + with requests.Session() as s: + # read credentials from env + s.auth = (os.environ.get('username'), os.environ.get('password')) + + # update header for json + s.headers.update({'Accept': 'application/json'}) + + # request the data + r = s.get(os.environ.get('url')) + + # if status code is successful continue + if r.status_code == 200: + result = self.get_data(r.json()) + + # 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') + elif r.status_code == 997: + print('not authorized') + elif r.status_code == 998: + print('not found') + else: + print('unknown error') + + def main(self): + # 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() + elif sys.argv[1] == 'autoconf': + if None in [os.environ.get('username'), os.environ.get('password')]: + print('env variables are missing') + else: + print('yes') + else: + self.run() + + +if __name__ == "__main__": + NextcloudApps().main() diff --git a/nextcloud_dbsize b/nextcloud_dbsize deleted file mode 100755 index 0d4ce9d..0000000 --- a/nextcloud_dbsize +++ /dev/null @@ -1,95 +0,0 @@ -#!/usr/bin/env python3 -# -*- coding: utf-8 -*- - -# Plugin to monitor the nextcloud database size -# -# Parameters understood: -# config (required) -# autoconf (optional - used by munin-config) - -# Magic markers - optional - used by installation scripts and -# munin-config: -# -# #%# family=manual -# #%# capabilities=autoconf -import requests -import sys -import os - - -class NextcloudDB: - def config(self): - config = { - 'dbsize': [ - 'graph_title Nextcloud Database Size', - 'graph_args --base 1024 -l 0', - 'graph_vlabel size in byte', - 'graph_info graph showing the database size in byte', - 'graph_category nextcloud', - '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' - ] - } - - return config - - def get_data(self, api_response): - data ={ - 'nextcloud_dbsize': [], - } - - dbsize = api_response['ocs']['data']['server']['database']['size'] - data['nextcloud_dbsize'].append('db_size.value %s' % dbsize) - - return data - - def run(self): - # init request session with specific header and credentials - with requests.Session() as s: - # read credentials from env - s.auth = (os.environ.get('username'), os.environ.get('password')) - - # update header for json - s.headers.update({'Accept': 'application/json'}) - - # request the data - r = s.get(os.environ.get('url')) - - # if status code is successful continue - if r.status_code == 200: - result = self.get_data(r.json()) - - # 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') - elif r.status_code == 997: - print('not authorized') - elif r.status_code == 998: - print('not found') - else: - print('unknown error') - - def main(self): - # 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() - elif sys.argv[1] == 'autoconf': - if None in [os.environ.get('username'), os.environ.get('password')]: - print('env variables are missing') - else: - print('yes') - else: - self.run() - - -if __name__ == "__main__": - NextcloudDB().main() diff --git a/nextcloud_dbsize.py b/nextcloud_dbsize.py new file mode 100644 index 0000000..b9377a7 --- /dev/null +++ b/nextcloud_dbsize.py @@ -0,0 +1,95 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- + +# Plugin to monitor the nextcloud database size +# +# Parameters understood: +# config (required) +# autoconf (optional - used by munin-config) + +# Magic markers - optional - used by installation scripts and +# munin-config: +# +# #%# family=manual +# #%# capabilities=autoconf +import requests +import sys +import os + + +class NextcloudDB: + def config(self): + config = { + 'dbsize': [ + 'graph_title Nextcloud Database Size', + 'graph_args --base 1024 -l 0', + 'graph_vlabel size in byte', + 'graph_info graph showing the database size in byte', + 'graph_category nextcloud', + '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' + ] + } + + return config + + def get_data(self, api_response): + data = { + 'nextcloud_dbsize': [], + } + + dbsize = api_response['ocs']['data']['server']['database']['size'] + data['nextcloud_dbsize'].append('db_size.value %s' % dbsize) + + return data + + def run(self): + # init request session with specific header and credentials + with requests.Session() as s: + # read credentials from env + s.auth = (os.environ.get('username'), os.environ.get('password')) + + # update header for json + s.headers.update({'Accept': 'application/json'}) + + # request the data + r = s.get(os.environ.get('url')) + + # if status code is successful continue + if r.status_code == 200: + result = self.get_data(r.json()) + + # 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') + elif r.status_code == 997: + print('not authorized') + elif r.status_code == 998: + print('not found') + else: + print('unknown error') + + def main(self): + # 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() + elif sys.argv[1] == 'autoconf': + if None in [os.environ.get('username'), os.environ.get('password')]: + print('env variables are missing') + else: + print('yes') + else: + self.run() + + +if __name__ == "__main__": + NextcloudDB().main() diff --git a/nextcloud_multi b/nextcloud_multi deleted file mode 100755 index da33225..0000000 --- a/nextcloud_multi +++ /dev/null @@ -1,195 +0,0 @@ -#!/usr/bin/env python3 -# -*- coding: utf-8 -*- - -# Plugin to monitor nextcloud external api statistics -# * user activity -# * db size -# * share count -# * available app updates -# -# Parameters understood: -# config (required) -# autoconf (optional - used by munin-config) - -# Magic markers - optional - used by installation scripts and -# munin-config: -# -# #%# family=manual -# #%# capabilities=autoconf -import requests -import sys -import os - - -class NextcloudMultiGraph: - def config(self): - config = { - 'users': [ - 'multigraph nextcloud_users', - 'graph_title Nextcloud User Activity', - '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.min 0', - 'num_users.label number of users', - 'num_users.info total number of users', - 'num_users.min 0' - ], - 'shares': [ - 'multigraph nextcloud_shares', - 'graph_title Nextcloud Shares', - '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.min 0' - ], - 'dbsize': [ - 'multigraph nextcloud_dbsize', - 'graph_title Nextcloud Database Size', - 'graph_args --base 1024 -l 0', - 'graph_vlabel size in byte', - 'graph_info graph showing the database size in byte', - 'graph_category nextcloud', - '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 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 = { - 'nextcloud_users': [], - 'nextcloud_shares': [], - 'nextcloud_dbsize': [], - 'nextcloud_available_updates': [] - } - - # users - users = api_response['ocs']['data']['activeUsers'] - num_users = api_response['ocs']['data']['nextcloud']['storage']['num_users'] - data['nextcloud_users'].append('multigraph nextcloud_users') - - # 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()] - - # append total number of users - data['nextcloud_users'].append('num_users.value %s' % num_users) - - # shares - shares = api_response['ocs']['data']['nextcloud']['shares'] - data['nextcloud_shares'].append('multigraph nextcloud_shares') - - # 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 - 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) - - return data - - def run(self): - # init request session with specific header and credentials - with requests.Session() as s: - # read credentials from env - s.auth = (os.environ.get('username'), os.environ.get('password')) - - # update header for json - s.headers.update({'Accept': 'application/json'}) - - # request the data - r = s.get(os.environ.get('url')) - - # if status code is successful continue - if r.status_code == 200: - result = self.get_data(r.json()) - - # 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') - elif r.status_code == 997: - print('not authorized') - elif r.status_code == 998: - print('not found') - else: - print('unknown error') - - def main(self): - # 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() - elif sys.argv[1] == 'autoconf': - if None in [os.environ.get('username'), os.environ.get('password')]: - print('env variables are missing') - else: - print('yes') - else: - self.run() - - -if __name__ == "__main__": - NextcloudMultiGraph().main() diff --git a/nextcloud_multi.py b/nextcloud_multi.py new file mode 100644 index 0000000..da33225 --- /dev/null +++ b/nextcloud_multi.py @@ -0,0 +1,195 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- + +# Plugin to monitor nextcloud external api statistics +# * user activity +# * db size +# * share count +# * available app updates +# +# Parameters understood: +# config (required) +# autoconf (optional - used by munin-config) + +# Magic markers - optional - used by installation scripts and +# munin-config: +# +# #%# family=manual +# #%# capabilities=autoconf +import requests +import sys +import os + + +class NextcloudMultiGraph: + def config(self): + config = { + 'users': [ + 'multigraph nextcloud_users', + 'graph_title Nextcloud User Activity', + '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.min 0', + 'num_users.label number of users', + 'num_users.info total number of users', + 'num_users.min 0' + ], + 'shares': [ + 'multigraph nextcloud_shares', + 'graph_title Nextcloud Shares', + '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.min 0' + ], + 'dbsize': [ + 'multigraph nextcloud_dbsize', + 'graph_title Nextcloud Database Size', + 'graph_args --base 1024 -l 0', + 'graph_vlabel size in byte', + 'graph_info graph showing the database size in byte', + 'graph_category nextcloud', + '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 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 = { + 'nextcloud_users': [], + 'nextcloud_shares': [], + 'nextcloud_dbsize': [], + 'nextcloud_available_updates': [] + } + + # users + users = api_response['ocs']['data']['activeUsers'] + num_users = api_response['ocs']['data']['nextcloud']['storage']['num_users'] + data['nextcloud_users'].append('multigraph nextcloud_users') + + # 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()] + + # append total number of users + data['nextcloud_users'].append('num_users.value %s' % num_users) + + # shares + shares = api_response['ocs']['data']['nextcloud']['shares'] + data['nextcloud_shares'].append('multigraph nextcloud_shares') + + # 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 + 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) + + return data + + def run(self): + # init request session with specific header and credentials + with requests.Session() as s: + # read credentials from env + s.auth = (os.environ.get('username'), os.environ.get('password')) + + # update header for json + s.headers.update({'Accept': 'application/json'}) + + # request the data + r = s.get(os.environ.get('url')) + + # if status code is successful continue + if r.status_code == 200: + result = self.get_data(r.json()) + + # 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') + elif r.status_code == 997: + print('not authorized') + elif r.status_code == 998: + print('not found') + else: + print('unknown error') + + def main(self): + # 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() + elif sys.argv[1] == 'autoconf': + if None in [os.environ.get('username'), os.environ.get('password')]: + print('env variables are missing') + else: + print('yes') + else: + self.run() + + +if __name__ == "__main__": + NextcloudMultiGraph().main() diff --git a/nextcloud_shares b/nextcloud_shares deleted file mode 100755 index dc56fba..0000000 --- a/nextcloud_shares +++ /dev/null @@ -1,117 +0,0 @@ -#!/usr/bin/env python3 -# -*- coding: utf-8 -*- - -# Plugin to monitor the amount shares to and from the specified nextcloud instance -# -# Parameters understood: -# config (required) -# autoconf (optional - used by munin-config) - -# Magic markers - optional - used by installation scripts and -# munin-config: -# -# #%# family=manual -# #%# capabilities=autoconf -import re -import requests -import sys -import os - - -class NextcloudShares: - def config(self): - config = { - 'shares': [ - 'graph_title Nextcloud Shares', - '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.min 0' - ] - } - - return config - - def get_data(self, api_response): - data ={ - 'nextcloud_shares': [], - } - - # shares - shares = api_response['ocs']['data']['nextcloud']['shares'] - data['nextcloud_shares'].append('multigraph nextcloud_shares') - - # 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): - # init request session with specific header and credentials - with requests.Session() as s: - # read credentials from env - s.auth = (os.environ.get('username'), os.environ.get('password')) - - # update header for json - s.headers.update({'Accept': 'application/json'}) - - # request the data - r = s.get(os.environ.get('url')) - - # if status code is successful continue - if r.status_code == 200: - result = self.get_data(r.json()) - - # 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') - elif r.status_code == 997: - print('not authorized') - elif r.status_code == 998: - print('not found') - else: - print('unknown error') - - def main(self): - # 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() - elif sys.argv[1] == 'autoconf': - if None in [os.environ.get('username'), os.environ.get('password')]: - print('env variables are missing') - else: - print('yes') - else: - self.run() - -if __name__ == "__main__": - NextcloudShares().main() diff --git a/nextcloud_shares.py b/nextcloud_shares.py new file mode 100644 index 0000000..0057a4c --- /dev/null +++ b/nextcloud_shares.py @@ -0,0 +1,117 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- + +# Plugin to monitor the amount shares to and from the specified nextcloud instance +# +# Parameters understood: +# config (required) +# autoconf (optional - used by munin-config) + +# Magic markers - optional - used by installation scripts and +# munin-config: +# +# #%# family=manual +# #%# capabilities=autoconf +import requests +import sys +import os + + +class NextcloudShares: + def config(self): + config = { + 'shares': [ + 'graph_title Nextcloud Shares', + '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.min 0' + ] + } + + return config + + def get_data(self, api_response): + data = { + 'nextcloud_shares': [], + } + + # shares + shares = api_response['ocs']['data']['nextcloud']['shares'] + data['nextcloud_shares'].append('multigraph nextcloud_shares') + + # 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): + # init request session with specific header and credentials + with requests.Session() as s: + # read credentials from env + s.auth = (os.environ.get('username'), os.environ.get('password')) + + # update header for json + s.headers.update({'Accept': 'application/json'}) + + # request the data + r = s.get(os.environ.get('url')) + + # if status code is successful continue + if r.status_code == 200: + result = self.get_data(r.json()) + + # 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') + elif r.status_code == 997: + print('not authorized') + elif r.status_code == 998: + print('not found') + else: + print('unknown error') + + def main(self): + # 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() + elif sys.argv[1] == 'autoconf': + if None in [os.environ.get('username'), os.environ.get('password')]: + print('env variables are missing') + else: + print('yes') + else: + self.run() + + +if __name__ == "__main__": + NextcloudShares().main() diff --git a/nextcloud_users b/nextcloud_users deleted file mode 100755 index b2c651d..0000000 --- a/nextcloud_users +++ /dev/null @@ -1,111 +0,0 @@ -#!/usr/bin/env python3 -# -*- coding: utf-8 -*- - -# Plugin to monitor the amount of users sucessfully logging in to the specified nextcloud instance -# -# Parameters understood: -# config (required) -# autoconf (optional - used by munin-config) - -# Magic markers - optional - used by installation scripts and -# munin-config: -# -# #%# family=manual -# #%# capabilities=autoconf -import requests -import sys -import os - - -class NextcloudUsers: - def config(self): - config = { - 'users': [ - 'graph_title Nextcloud User Activity', - '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.min 0', - 'num_users.label number of users', - 'num_users.info total number of users', - 'num_users.min 0' - ] - } - - return config - - def get_data(self, api_response): - data = { - 'nextcloud_users': [], - } - # users - users = api_response['ocs']['data']['activeUsers'] - num_users = api_response['ocs']['data']['nextcloud']['storage']['num_users'] - - # 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()] - - # append total number of users - data['nextcloud_users'].append('num_users.value %s' % num_users) - - return data - - def run(self): - # init request session with specific header and credentials - with requests.Session() as s: - # read credentials from env - s.auth = (os.environ.get('username'), os.environ.get('password')) - - # update header for json - s.headers.update({'Accept': 'application/json'}) - - # request the data - r = s.get(os.environ.get('url')) - - # if status code is successful continue - if r.status_code == 200: - result = self.get_data(r.json()) - - # 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') - elif r.status_code == 997: - print('not authorized') - elif r.status_code == 998: - print('not found') - else: - print('unknown error') - - def main(self): - # 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() - elif sys.argv[1] == 'autoconf': - if None in [os.environ.get('username'), os.environ.get('password')]: - print('env variables are missing') - else: - print('yes') - else: - self.run() - - -if __name__ == "__main__": - NextcloudUsers().main() diff --git a/nextcloud_users.py b/nextcloud_users.py new file mode 100644 index 0000000..b2c651d --- /dev/null +++ b/nextcloud_users.py @@ -0,0 +1,111 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- + +# Plugin to monitor the amount of users sucessfully logging in to the specified nextcloud instance +# +# Parameters understood: +# config (required) +# autoconf (optional - used by munin-config) + +# Magic markers - optional - used by installation scripts and +# munin-config: +# +# #%# family=manual +# #%# capabilities=autoconf +import requests +import sys +import os + + +class NextcloudUsers: + def config(self): + config = { + 'users': [ + 'graph_title Nextcloud User Activity', + '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.min 0', + 'num_users.label number of users', + 'num_users.info total number of users', + 'num_users.min 0' + ] + } + + return config + + def get_data(self, api_response): + data = { + 'nextcloud_users': [], + } + # users + users = api_response['ocs']['data']['activeUsers'] + num_users = api_response['ocs']['data']['nextcloud']['storage']['num_users'] + + # 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()] + + # append total number of users + data['nextcloud_users'].append('num_users.value %s' % num_users) + + return data + + def run(self): + # init request session with specific header and credentials + with requests.Session() as s: + # read credentials from env + s.auth = (os.environ.get('username'), os.environ.get('password')) + + # update header for json + s.headers.update({'Accept': 'application/json'}) + + # request the data + r = s.get(os.environ.get('url')) + + # if status code is successful continue + if r.status_code == 200: + result = self.get_data(r.json()) + + # 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') + elif r.status_code == 997: + print('not authorized') + elif r.status_code == 998: + print('not found') + else: + print('unknown error') + + def main(self): + # 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() + elif sys.argv[1] == 'autoconf': + if None in [os.environ.get('username'), os.environ.get('password')]: + print('env variables are missing') + else: + print('yes') + else: + self.run() + + +if __name__ == "__main__": + NextcloudUsers().main() diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..111f18b --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +requests>=2.20.0 -- cgit v1.2.3-54-g00ecf