Difference between revisions of "Freeside:2.3:Documentation:Torrus Installation"

From Freeside
Jump to: navigation, search
(Reporing setup)
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
= Introduction =
 
= Introduction =
  
Torrus is a network monitoring system (NMS) for discovering and monitoring routers, switches and other network equipment with SNMP.  Starting in version 2.3, Freeside integrates Torrus (like the RT ticketing system), providing an integrated system for doing 95th percentile and straight volume billing.
+
Torrus is a network monitoring system (NMS) for discovering and monitoring routers, switches and other network equipment with SNMP.  Starting in version 2.3, Freeside includes an integrated/skinned Torrus (like it does RT), providing 95th percentile and straight volume billing.
  
 
= Prerequisites =
 
= Prerequisites =
Line 15: Line 15:
 
   make deploy
 
   make deploy
  
= Network setup and discovery =
+
  mkdir /srv/torrus/collector_rrd
 +
  chown -R freeside:freeside /srv/torrus/collector_rrd /usr/local/etc/torrus/discovery /usr/local/etc/torrus/xmlconfig/
 +
 
 +
= Database configuration =
 +
 
 +
In /usr/local/etc/torrus/conf/torrus-siteconfig.pl, edit the following lines if necessary (the installation process does not yet substitute them in from the Makefile)
 +
 
 +
  $Torrus::SQL::connections{'Default'}{'dsn'} =
 +
      'DBI:mysql:database=torrus;host=dbhost.example.com';
 +
  $Torrus::SQL::connections{'Default'}{'username'} = 'torrus';
 +
  $Torrus::SQL::connections{'Default'}{'password'} = 'imiF1oih';
 +
 
 +
= Network discovery =
  
 
   cd /usr/local/etc/torrus/discovery
 
   cd /usr/local/etc/torrus/discovery
Line 27: Line 39:
 
   torrus devdiscover  --in=routers.ddx  
 
   torrus devdiscover  --in=routers.ddx  
  
  mkdir /srv/torrus/collector_rrd
+
   chown freeside routers.ddx
   chown freeside:freeside /srv/torrus/collector_rrd
 
  
 
   torrus compile --tree=main --verbose
 
   torrus compile --tree=main --verbose
  
 
   torrus bs --global --verbose
 
   torrus bs --global --verbose
 
XXX database config (before collector start)
 
  
 
   #launch data collector
 
   #launch data collector
   #XXX add to init
+
   /etc/init.d/freeside restart
  torrus collector --tree=main
 
  
 
= Cron and init script =
 
= Cron and init script =
  
  http://torrus.org/install.pod.html#cron_job  
+
  http://torrus.org/install.pod.html#cron_job
 
 
but do go from http://torrus.org/install.pod.html#cron_job on
 
 
 
= Reporing setup =
 
 
 
  cd /usr/local/etc/torrus/discovery
 
  vi routers.ddx
 
    <!-- host-specfic parameter  -->
 
    <param name="RFC2863_IF_MIB::external-serviceid">
 
      TESTING_1:TenGigabitEthernet2_1:Both:main,
 
      TESTING_2:TenGigabitEthernet2_2:Both:main,
 
    </param>
 
 
 
  torrus devdiscover  --in=routers.ddx
 
  torrus compile --tree=main --verbose
 
  
  #kill collector, then restart
+
= Freeside =
  torrus collector --tree=main
 
  
= Freeside setup =
+
Set the network_monitoring_system configuration setting to "Torrus_Internal".
  
* add serviceids
+
= Administration =
  
* in freeside, setup svc_port service defs, packages with torrus billing types order the package, provision an svc_port with a valid serviceid
+
Proceed to [[Freeside:2.3:Documentation:Torrus_Administration]]
  
 
= References =
 
= References =

Latest revision as of 23:30, 9 April 2012

Introduction

Torrus is a network monitoring system (NMS) for discovering and monitoring routers, switches and other network equipment with SNMP. Starting in version 2.3, Freeside includes an integrated/skinned Torrus (like it does RT), providing 95th percentile and straight volume billing.

Prerequisites

 aptitude install rrdtool librrds-perl libxml-libxml-perl libberkeleydb-perl libtemplate-perl libproc-daemon-perl \
   libnet-snmp-perl libapache-session-perl libjson-perl libdbix-abstract-perl libdbix-sequence-perl

Installation

In the Makefile, set TORRUS_ENABLED = 1

 make configure-torrus
 make deploy
 mkdir /srv/torrus/collector_rrd
 chown -R freeside:freeside /srv/torrus/collector_rrd /usr/local/etc/torrus/discovery /usr/local/etc/torrus/xmlconfig/

Database configuration

In /usr/local/etc/torrus/conf/torrus-siteconfig.pl, edit the following lines if necessary (the installation process does not yet substitute them in from the Makefile)

 $Torrus::SQL::connections{'Default'}{'dsn'} =
     'DBI:mysql:database=torrus;host=dbhost.example.com';
 $Torrus::SQL::connections{'Default'}{'username'} = 'torrus';
 $Torrus::SQL::connections{'Default'}{'password'} = 'imiF1oih';

Network discovery

 cd /usr/local/etc/torrus/discovery
 vi routers.txt #space-delimted router ip addresses
 torrus genddx \
   --hostfile=routers.txt \
   --domain=example.com \
   --community=community_string \
   --out=routers.ddx \
   --discout=routers.xml
 torrus devdiscover  --in=routers.ddx 
 chown freeside routers.ddx
 torrus compile --tree=main --verbose
 torrus bs --global --verbose
 #launch data collector
 /etc/init.d/freeside restart

Cron and init script

http://torrus.org/install.pod.html#cron_job

Freeside

Set the network_monitoring_system configuration setting to "Torrus_Internal".

Administration

Proceed to Freeside:2.3:Documentation:Torrus_Administration

References