aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authornico <nico@magicbroccoli.de>2018-09-12 16:46:34 +0200
committernico <nico@magicbroccoli.de>2018-09-12 16:52:25 +0200
commitcb7670a84ccef4283401a68271ab64e91e158dd8 (patch)
treea85264b0d066a0eee4633b46842d18f905af6c5b /README.md
parent1ed8efcacb1ccd18ed7945492b6d2683a9a31b71 (diff)
added Multigraph, Licence
+ added ICS Licence to repo + added multiggraph plugin variant with all features included + added nextcloud 14 pending app updates plugin * updated README.md * updated requests.sessions handeling to reduce keepalive sessions - removed keepalive header for all plugins
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 20 insertions, 6 deletions
diff --git a/README.md b/README.md
index 45bf39c..267f9a8 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
# Nextcloud Munin Plugin
-Some basic Munin Plugins gathering information from the NextCloud external API.
+Within this repository there are some basic Munin Plugins gathering information from the NextCloud external API. I choose to also include a multigraph plugin `nextcloud_multi` which does everything the other plugins do but in one single request.
+
+There are drawbacks to using a multigraph plugin which can be read up here : [Munin-Monitoring.org](http://guide.munin-monitoring.org/en/latest/plugin/multigraphing.html)
## install
To use these plugins properly some configuration parameters need to be added to the plugin-config `/etc/munin/plugin-config.d/munin-node`.
@@ -9,21 +11,33 @@ url = https://URL.TO.YOUR.NEXTCLOUD.tld/ocs/v2.php/apps/serverinfo/api/v1/info
username = username
password = password or logintoken
```
-After that the script needs to be placed in the munin plugin directory eg. `/etc/munin/plugins/`
+To install these plugins, you just have to symlink those plugins you would like to activate to the munin plugin directory eg. `/etc/munin/plugins/`. Or if you want to use the multigraph plugin only symlink that one the the munin plugin directory.
-The munin-node needs to be restarted to facilitate the new plugins.
+After this has been done the munin-node needs to be restarted to facilitate the new plugins.
`systemctl restart munin-node`
### everything working?
-To check if everything is working as expected check if the plugins actually gather data.
+To check if everything is working as expected check if the plugins are listed and actually gather data.
```
telnet localhost 4949 # localhost or IP the munin-node
list
fetch nextcloud_shares
fetch nextcloud_users
+fetch nextcloud_db
+fetch nextcloud_apps
+```
+If everything works as it should, list will return the symlinked plugins within the list of active plugins.
+
+##### multipgrah plugin
+To check if the multigraph plugin is working correctly it is necessary to first instruct the capability multigraph before the `list` instruction.
+```
+telnet localhost 4949 # localhost or IP the munin-node
+cap multigraph
+list
+fetch nextcloud_multi
```
-If everything works as it should, list will return `nextcloud_shares` and `nextcloud_users` within the list of other active plugins. The `fetch` commands will run the script and return the gathered values. As long as none of them are NaN everything works as expected.
+The `fetch` commands will run the script and return the gathered values. As long as none of them are NaN everything works as expected.
### uninstall
-To remove the plugins from munin remove both plugins from the directory and restart the node.
+To remove the plugins from munin remove all symlinked plugins from the directory and restart the node.