diff --git a/plugins/joomla/joomla-sessions b/plugins/joomla/joomla-sessions index e29a3919..f98c7354 100755 --- a/plugins/joomla/joomla-sessions +++ b/plugins/joomla/joomla-sessions @@ -1,11 +1,50 @@ #!/usr/bin/perl -# -# Munin plugin for different stats over a spotweb MySQL database -# -# Copyright (C) 2011 - Csaba Martha (http://www.zenebuzi.com) -# Based on Rowdy Schwachfer (http://rowdy.nl) 's Spotweb plugin -# -# + +=head1 NAME + +joomla-sessions - Munin plugin for different stats over a Joomla MySQL +database + +=head1 CONFIGURATION + +=over + +=item env.mysql + +Optional, path to the MySQL binary. Defaults to C. + +=item env.mysqlopts + +Optional, command line options for "mysql". May be used to set +username and password. No default value. + +=item env.database + +Optional, name of the joomla database name. Defaults to C. + +=back + +=head2 Configuration example + + + [joomla_sessions*] + env.mysql /usr/bin/mysql # MySQL binary (optional) + env.mysqlopts -u -p # How to connect to the database (optional if no password is set) + env.database databasename # Joomla database (optional) + +=head1 AUTHORS + +Copyright (C) 2011 - Csaba Martha (http://www.zenebuzi.com) + +Based on Rowdy Schwachfer (http://rowdy.nl) 's Spotweb plugin + +=head1 LICENSE + +GPLv3 or later + + +=cut + # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or @@ -18,15 +57,6 @@ # # You should have received a copy of the GNU General Public License # along with this program. If not, see . -# -# -# Configuration example -# -# [joomla_sessions*] -# env.mysql /usr/bin/mysql # MySQL binary (optional) -# env.mysqlopts -u -p # How to connect to the database (optional if no password is set) -# env.database databasename # Joomla database (optional) -# use strict; @@ -71,4 +101,4 @@ print "registered.value ".$1."\n"; #All count my $all = `$MYSQL $MYSQLOPTS -e 'SELECT COUNT(usertype) FROM $DATABASE.jos_session'`; $all =~/(\d+)/; -print "all.value ".$1."\n"; \ No newline at end of file +print "all.value ".$1."\n";