= rTorrent-O-Meter =

rTorrent-O-Meter is a simple [http://munin.projects.linpro.no/ Munin] plugin pack for monitoring rTorrent's upload/download speed, torrent, peer and DHT statistics

 * [#Screenshots Screenshots]
 * [#Prerequisites Prerequisites]
 * [#Installation Installation]
 * [#Changelog Changelog]
 * [#Download Download]

== Screenshots ==
[[myImage(http://static.jmk.hu/rtwi/screenshots/rtom/th/rtom_albi_dht-day.th.png, http://static.jmk.hu/rtwi/screenshots/rtom/rtom_albi_dht-day.png, rTorrent DHT statistics)]]
[[myImage(http://static.jmk.hu/rtwi/screenshots/rtom/th/rtom_albi_mem-day.th.png, http://static.jmk.hu/rtwi/screenshots/rtom/rtom_albi_mem-day.png, rTorrent memory usage)]]
[[myImage(http://static.jmk.hu/rtwi/screenshots/rtom/th/rtom_albi_peers-day.th.png, http://static.jmk.hu/rtwi/screenshots/rtom/rtom_albi_peers-day.png, rTorrent peer count)]]
[[myImage(http://static.jmk.hu/rtwi/screenshots/rtom/th/rtom_albi_som-day.th.png, http://static.jmk.hu/rtwi/screenshots/rtom/rtom_albi_som-day.png, rTorrent per torrent seed-o-meter)]]
[[myImage(http://static.jmk.hu/rtwi/screenshots/rtom/th/rtom_albi_spd-day.th.png, http://static.jmk.hu/rtwi/screenshots/rtom/rtom_albi_spd-day.png, rTorrent upload/download speed (deprecated))]]
[[myImage(http://static.jmk.hu/rtwi/screenshots/rtom/th/rtom_albi_spdd-day.th.png, http://static.jmk.hu/rtwi/screenshots/rtom/rtom_albi_spdd-day.png, rTorrent upload/download speed)]]
[[myImage(http://static.jmk.hu/rtwi/screenshots/rtom/th/rtom_albi_vol-day.th.png, http://static.jmk.hu/rtwi/screenshots/rtom/rtom_albi_volt-day.png, rTorrent torrent count)]]

== Prerequisites ==

 * rTorrent 0.7.5 or newer
  * compiled with "--with-xmlrpc-c"
  * XMLRPC-C >= 1.00

== Installation ==

Install the plugins, like any munin plugin (e.g.: create a symlink into /etc/munin/plugins), and open the /etc/munin/plugin-conf.d file. Create a section for the installed plugin, and insert the lines similar to the ones shown below:

{{{
[rtom_username_spdd]
user username
env.src socket
env.socket /home/username/torrent/.socket/rpc.socket
env.diff yes
}}}

or

{{{
[rtom_username_spdd]
env.ip 127.0.0.1
env.port 5000
env.diff yes
}}}

depending on what rTorrent configuration you have.[[BR]]

If you use more than one plugin for a user, you don't need to add a section for every plugin to your /etc/munin/plugin-conf.d file, you can use the following syntax:

{{{
[rtom_username_*]
user username
env.src socket
env.socket /home/username/torrent/.socket/rpc.socket
env.diff yes
}}}

or

{{{
[rtom_username_*]
env.ip 127.0.0.1
env.port 5000
env.diff yes
}}}

Also, if you don't want to monitor more than one user, the username is not mandatory, you can leave the filenames as they were, and use the following configuration:

{{{
[rtom__spdd]
user username
env.src socket
env.socket /home/username/torrent/.socket/rpc.socket
env.diff yes
}}}

or

{{{
[rtom__spdd]
env.ip 127.0.0.1
env.port 5000
env.diff yes
}}}

The * character can be used in this case too.

Configurable variables:

|| src || "socket" when using scgi_socket, or anything else when using scgi_port ||||||
|| socket || rTorrent's rpc socket (scgi_local)	|| using scgi_local || needed when "src" is set to "socket" ||
|| ip || rTorrent's ip address || using scgi_port || needed when "src" is NOT set to "socket" ||
|| port || rTorrent's scgi port (scgi_port) || using scgi_port || needed when "src" is NOT set to "socket" ||
|| diff || "yes" for displaying bits per second for upload and Byets per second for download, or anything else for using Bytes per second for both |||| used by rtom!__spd and rtom!__spdd plugins ||

== Cleanup ==

You might want to run the following command from time to time, to remove the unused rrd files from your munin directory (files that hasn't been touched in more than a week - in other words, files, that has probably been removed from rTorrent)

{{{
find -iname '*-rtom_*_som-info_hash_*-d.rrd' -mtime +7 -exec rm {} \;
}}}

== Changelog ==

 * [#v0.4.0 0.4.0]
 * [#v0.3.0 0.3.0]
 * [#v0.2.0 0.2.0]
 * [#v0.1.0d 0.1.0d]
 * [#v0.1.0 0.1.0]
 * [#v0.0.1d 0.0.1d]
 * [#v0.0.1 0.0.1]
 * [#v0.0.0 0.0.0]
 * [#legend Legend]

=== 0.4.0 === #v0.4.0
 * * New plugin for monitoring the amount of uploaded data per torrent
 * + minor formatting changes, and cleanup in the code
 * - 2010. 07. 24.

=== 0.3.0 === #v0.3.0
 * * New plugin for monitoring DHT statistics
 * * New filename format to support multiple instances, with easy munin-node configuration - just name the file rtom_username_peers
 * + Using different query for rtom!__vol plugin (a single request instead of 5 different one) for speed improvement
 * - 2010. 01. 17.

=== 0.2.0 === #v0.2.0

 * * New plugins for monitoring rTorrent's memory usage, torrent count, and peer count
 * + rtom_spdd displays upload and download limit on the graph
 * x Fixed bug, where rtom_spd stopped working on 32 bit integer overflow (when using XMLRPC-C < 1.07)
 * - rtom_spd is now obsolete, use rtom_spdd instead
 * - 2008. 06. 19.

=== 0.1.0 === #v0.1.0

 * * Full rewrite in Perl
 * * New plugins for monitoring torrent statistics (shows number of started/stopped/incomplete/complete/all torrents)
 * * Now supports UNIX domain socket (scgi_local)
 * + Speed graph uses get_{up|down}_total to get more actual values (and to make the graph smoother)
 * + Configurable via munin-node's plugin config (environmental variables)
 * - 2008. 05. 23.

=== 0.0.1d === #v0.0.1d

 * - Different graph scale for upload and download for asymmetric line (upload is in b/s, download is in B/s)
 * - 2008. 02. 29.

=== 0.0.1 === #v0.0.1

 * x Minor textbugs fixed
 * - 2007. 12. 20.

=== 0.0.0 === #v0.0.0

 * - Initial release
 * - 2007. 12. 18.

=== Legend === #legend

 * * New feature
 * + Minor update
 * x Bugfix
 * - Information

== Download ==

 * [http://static.jmk.hu/rtwi/downloads/rtom/rtom-0.4.0-100724.tar.gz Latest release]
 * [http://static.jmk.hu/rtwi/downloads/rtom/ All releases]