plugins/overview/tp-overview.pod

   1
   2 #  overview.pod - Torrus configuration guide
   3 #  Copyright (C) 2003  Christian Schnidrig
   4 #
   5 #  This program is free software; you can redistribute it and/or modify
   6 #  it under the terms of the GNU General Public License as published by
   7 #  the Free Software Foundation; either version 2 of the License, or
   8 #  (at your option) any later version.
   9 #
  10 #  This program is distributed in the hope that it will be useful,
  11 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 #  GNU General Public License for more details.
  14 #
  15 #  You should have received a copy of the GNU General Public License
  16 #  along with this program; if not, write to the Free Software
  17 #  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 # Christian Schnidrig <christian.schnidrig@bluewin.ch>
  20 #
  21 #
  22
  23 =head1 Overview Plugin
  24
  25
  26 =head2 Introduction
  27
  28 This plugin adds an alternative user interface to Torrus.
  29 The main feature is that it
  30 allows for creation of overview pages showing counters from
  31 different parts of a tree. For example a page containing all
  32 CPU usage counters of all network devices.
  33
  34 Other features are:
  35
  36 =over 2
  37
  38 =item * date and time picker
  39
  40 allowing for chosing of the vieving date and time. (In oder to take full
  41 advantage of this features one has to make sure the RRD files do keep
  42 full history data for longer then just a couple of days. For example
  43 to keep 2 years worth of history data:
  44
  45 =back
  46
  47     <param name="rrd-create-rra">
  48         RRA:AVERAGE:0:1:209664
  49         RRA:AVERAGE:0.1:12:17472 RRA:MAX:0.1:12:17472 RRA:MIN:0.1:12:17472
  50         RRA:AVERAGE:0.1:288:1456 RRA:MAX:0.1:288:1456 RRA:MIN:0.1:288:1456
  51         RRA:AVERAGE:0.1:2016:416 RRA:MAX:0.1:2016:416 RRA:MIN:0.1:2016:416
  52     </param>
  53
  54 =over 2
  55
  56
  57 =item * 'window' picker.
  58
  59 This allows for choosing the time
  60 range which is to be displayed: day, week, month etc.
  61
  62 =item * show hidden checkbox.
  63
  64 Toggle display of hidden counters.
  65
  66 =item * auto-scale checkbox.
  67
  68 Toggle display between auto-scaling and fixed scaling.
  69
  70 =back
  71
  72 This plugin has been tested with Internet Explorer 6.0, Netscape 7.1,
  73 and Mozilla 1.4. Other browsers were not tested and will most likely
  74 not work.
  75
  76 =head2 Required Software (apart from Torrus)
  77
  78 =over 2
  79
  80 =item * Perl Modules
  81
  82 Apache::ASP http://www.apache-asp.org/
  83
  84 either XML::Sablotron http://www.cpan.org/
  85
  86 or XML::LibXSLT http://www.cpan.org/
  87
  88 =item * WebFx modules
  89
  90 Tab Pane http://webfx.eae.net/download/tabpane102.zip
  91
  92 Xtree (modified version is included in this plugin)
  93
  94 =item * jscalendar
  95
  96 Date Picker from http://sourceforge.net/projects/jscalendar/. (Version 1.0)
  97
  98 =back
  99
 100 =head2 Installation
 101
 102 Follow the Torrus installation guide for the main software installation.
 103
 104 Unpack the plugin distribution package in some directory:
 105
 106   gzip -dc tp-overview-1.X.tar.gz | tar xvf -
 107
 108 Then run the Torrus plugin installation utility:
 109
 110   torrus install_plugin tp-overview-1.X
 111
 112 Restart all Torrus processes, including Apache HTTP daemon.
 113
 114 After the plugin installation has finished:
 115
 116 Install the perl module Apache::ASP acording to the instructions on
 117 http://www.apache-asp.org/
 118
 119 Add the following lines to your apache config file (http.conf). Or
 120 if you are using apache2 simply copy the file apache2.conf to the
 121 /etc/apache2/conf/modules.d directory.
 122 (Note: WEBPLAINDIR is /usr/local/torrus/sup/webplain by default):
 123
 124
 125   ScriptAlias /menu/ "WEBPLAINDIR/menu/"
 126   ScriptAlias /overviews/ "WEBPLAINDIR/overviews/"
 127
 128   <Location /menu>
 129   SetHandler  perl-script
 130   PerlModule  Apache::ASP
 131   PerlHandler Apache::ASP
 132   PerlSetVar  Global /var/torrus/asp
 133   PerlSetVar NoState 1
 134   #PerlSetVar XSLTParser XML::Sablotron
 135   PerlSetVar XSLTParser XML::LibXSLT
 136   PerlSetVar XSLTMatch xml$
 137   PerlSetVar XSLT menu.xsl
 138   PerlSetVar RequestParams 1
 139   </Location>
 140
 141   <Location /overviews>
 142   SetHandler  perl-script
 143   PerlModule  Apache::ASP
 144   PerlHandler Apache::ASP
 145   PerlSetVar  Global /var/torrus/asp
 146   PerlSetVar NoState 1
 147   #PerlSetVar XSLTParser XML::Sablotron
 148   PerlSetVar XSLTParser XML::LibXSLT
 149   PerlSetVar XSLTMatch xml$
 150   PerlSetVar XSLT overview.xsl
 151   PerlSetVar RequestParams 1
 152   </Location>
 153
 154 The plugin installer creates the directory F</var/torrus/asp> with
 155 the default owner C<torrus> and group C<torrus> and mode 775.
 156
 157
 158 Copy the contents of http://webfx.eae.net/download/tabpane102.zip to
 159 'WEBPLAINDIR'/tabpane
 160
 161 Copy the contents of the jscalendar package to 'WEBPLAINDIR'/calendar
 162
 163 =head2 Usage
 164
 165 Now you're ready to go. A usage example has been included. In order to
 166 use the example you need to follow these additional steps:
 167
 168 =over 2
 169
 170 =item * install randomcollector-plugin
 171
 172
 173 =item * Edit your torrus-siteconfig.pl:
 174
 175 Add the following item to Torrus::Global::treeConfig
 176
 177 =back
 178
 179     'ovExamples' => {
 180         'description' => 'Example data for overview',
 181         'xmlfiles' => [
 182             'ovDefaults.xml',
 183             'examples/ovExample.xml',
 184         ],
 185         'run' => { 'collector' => 1, 'monitor' => 1 } },
 186
 187 =over 2
 188
 189 =item * run the collector
 190
 191 Wait a few minutes for it to create all RRDs and collect some data.
 192
 193 =item * Enjoy!
 194
 195 You can access the sample menu at: http://your-server/menu/sampleMenu.xml
 196
 197
 198 =back
 199
 200 =head1 Author
 201
 202 Copyright (c) 2003-2004 Christian Schnidrig
 203 E<lt>christian.schnidrig@bluewin.chE<gt>