Mirrors/Munin-Contrib
1
0
Fork 0
mirror of https://github.com/munin-monitoring/contrib.git synced 2025-07-25 18:38:30 +00:00
Code Issues Releases Wiki Activity

Improve doc

Browse source 
- Migrate style to perldoc
- Improve requirements
- Add interpretation
- Add licence
This commit is contained in:
Neraud 2017-07-21 10:28:19 +02:00
parent 2370d4e742
commit 0dd06a6b73
1 changed files with 97 additions and 42 deletions
Download patch file Download diff file Expand all files Collapse all files

139
plugins/torrent/deluge_
View file

@ -1,46 +1,101 @@
#! /usr/bin/env python2 #! /usr/bin/env python2
#
# Munin Wildcard Plugin for Deluge torrent client """=cut
# =head1 NAME
# This plugin has 3 modes :
# - connections : monitors the number of connections deluge_ - Munin wildcard plugin to monitor Deluge torrent client
# - bandwidth : monitors the bandwidth (up, up overhead, down, down overhead)
# - states : monitors the torrents' states =head1 REQUIREMENTS
#
# To use one of these modes, link the this plugin with a name like 'deluge_<mode>' - Python2.5+ (Deluge itself won't work with python3)
# For example : - Deluge
# ln -s /path/to/deluge_ /etc/munin/plugins/deluge_connections
# This plugin also uses
# Use your "/etc/munin/plugin-conf.d/munin-node" to configure this plugin. - deluge.ui.client
# You must at least add : - deluge.log
# [deluge_*] - twisted
# user <user_with_access_to_deluge> These modules are required by Deluge itself.
# env.HOME <path_to_deluge_user_home>
# =head1 INSTALLATION
# By default, this plugin will try to access the deluge daemon with the following configuration :
# host 127.0.0.1 This plugin has 3 modes :
# port 58846 - connections : monitors the number of connections
# no username - bandwidth : monitors the bandwidth (up, up overhead, down, down overhead)
# no password - states : monitors the torrents' states
#
# You can change these settings in "plugin-conf.d/munin-node" : To use one of these modes, link the this plugin as 'deluge_<mode>'
# [deluge_*] For example :
# user <user_with_access_to_deluge> ln -s /path/to/deluge_ /etc/munin/plugins/deluge_connections
# env.HOME <path_to_deluge_user_home>
# env.host 127.0.0.1 =head1 CONFIGURATION
# env.port 58846
# env.username user Use your "/etc/munin/plugin-conf.d/munin-node" to configure this plugin.
# env.password pass You must at least add :
# [deluge_*]
# By default, deluge configuration files will be searched under $XDG_CONFIG_HOME, which is by default set to $HOME/.config user <user_with_access_to_deluge>
# Setting env.HOME allows this default to work. However, you can also explicitly set the env.XDG_CONFIG_HOME if needed. env.HOME <path_to_deluge_user_home>
#
# Written by : Neraud By default, this plugin will try to access the deluge daemon with the following
# settings :
# Markers for munin : host 127.0.0.1
# %# family=auto port 58846
# %# capabilities=autoconf suggest no username
########################################## no password
You can change these settings in "plugin-conf.d/munin-node" :
[deluge_*]
user <user_with_access_to_deluge>
env.HOME <path_to_deluge_user_home>
env.host 127.0.0.1
env.port 58846
env.username user
env.password pass
By default, deluge configuration files will be searched under $XDG_CONFIG_HOME,
which is by default set to $HOME/.config
Setting env.HOME allows this default to work. However, you can also explicitly
set the env.XDG_CONFIG_HOME if needed.
=head1 INTERPRETATION
=head2 connections
In the "connections" mode, this plugin shows a graph with the number of
connections
=head2 bandwidth
In the "bandwidth" mode, this plugin show graphs for the download and upload
bandwidth.
Each of them has "payload" and "overhead" value.
- with positive values : the download values
(payloadDownloadRate & overheadDownloadRate)
- with negative values : the upload values
(payloadUploadRate & overheadUploadRate)
=head2 states
In the "states" mode, this plugin shows the number of torrents in each state :
Downloading, Seeding, Paused, Error, Queued, Checking, Other
=head1 MAGIC MARKERS
#%# family=auto
#%# capabilities=autoconf suggest
=head1 VERSION
1.0.0
=head1 AUTHOR
Neraud (https://github.com/Neraud)
=head1 LICENSE
GPLv2
=cut"""
import logging import logging