Quick Installation Guide

Below is the result of our efforts to be able to walk you through, step by step, the process of installing SARGE on a central server and have it monitor your systems. Walk through it sequentially or hit the quick links to skip to the juicy bits. We've tried very hard to not leave anything out, but, hey, we're only humanoid. If you're having problems, visit our documentation pages to see if your problem has already been addressed. If not, please, .



System Requirements

  • Hardware
  • ~29 MB of disk space per monitored host, plus another ~3.3 MB of disk space per block device per monitored host. A monitored host with 3 disks would require about 39 MB for 1 year of data.

  • Perl 5 (or greater)
  • Also, the following modules, all of which are core modules that have been included with every version of Perl 5 (you shouldn't have to install them yourself).

    Required Perl Modules
    Cwd(Cwd.pm)
    File::Basename(File/Basename.pm)
    FileHandle(FileHandle.pm)
    Getopt::Long(Getopt/Long.pm)
    Net::Ping(Net/Ping.pm)
    POSIX(<arch>/POSIX)
    Time::Local(Time/local.pm)
  • HTTP Server
  • Only if you want the graphs web accessible. The Apache webserver is used for development purposes.

  • Web Browser
  • For viewing files (Firefox, Microsoft IE, etc).

  • RRDTool
  • Installed with the RRD Perl modules in the system perl libraries. Available at: https://oss.oetiker.ch/rrdtool/download.en.html

  • SARGE User
  • A generic user and group on all systems that will be used to collect data via the 'rsh' or 'ssh' command from the SARGE server. .rhosts (or .shosts or ssh key exchange) must be configured to allow access without password prompting. (The account can have a disabled password.)

    Ex.
    user - sarge:x:3334:SAR Graph Engine:/usr/local/sarge:/bin/bash
    group - sarge:x:3334:sarge

    NOTE: If you intend to use sarge to also monitor the 'server' machine, make sure that the key exchanges are also performed to allow passwordless 'remote' access from that machine to itself.

Installation

  1. Make sure all of the above prerequisites are installed.
  2. Edit the Makefile and modify the varables to suit your site.
  3. Type 'make install'.

Configuration

  1. Edit the hosts.master file.
  2. Change directory to ${SARGE_PREFIX}/sarge/bin and edit the hosts.master file.

    Ex. % cd /usr/local/sarge/bin
       % vi hosts.master


    The example file hosts.master.orig documents the fields.

  3. Run webgen
  4. Ex. % ./webgen

    This will generate the HTML pages, crontab entries, and httpd.conf entries.

    The crontab and httpd.conf entries will be created in the same folder. You'll need these in a bit.

  5. Create ${SARGE_USER}
  6. Make sure that the ${SARGE_USER} has been created on all hosts to be monitored, and that ${SARGE_USER} can access the system without being prompted for a password. A simple test as ${SARGE_USER} is a good idea ('ssh <remotehost>' is enough).

  7. Enable SAR
  8. Make sure that SAR is installed and activated on all systems to be monitored. SAR is available as part of the vendor operating system and is not provided as part of the SARGE code. SAR may be installed, but not active. The 'enable_sar'script can be used to make entries into the appropriate crontabs to enable SAR data collection.

    The RRDTool databases configured by SARGE expect data samples every 5 minutes. Use the 'enable_sar' script on each host to be monitored to properly configure the crontab.

  9. Merge the httpd.conf files.
  10. Merge the generated 'httpd.conf-sarge' file with the web server httpd.conf file, the restart the webserver. (This only needs to be done once per installation, not after every configuration.)

  11. Run loadall.sh - OPTIONAL
  12. This will load historical SAR data. Depending on the number of hosts and size of historical data, this could take a while (30 minutes plus).

    NOTE: This will only work if SAR data has been previously collected in 5 minute sample times.

    Ex. % su ${SARGE_USER}
       % ./loadall.sh

  13. Merge crontabs
  14. Merge the generated crontab with the ${SARGE_USER}'s crontab.

  15. Run webgen
  16. SARGE is unable to figure out how many disks (and therefore what to graph) before the first run. Re-run webgen after the first data collection cycle to have the graphs appear on the web pages. See our FAQ on the matter for why.

    Ex. % ./webgen

That should be it. Congrats! You now have SARGE installed. For questions and support, see our documentation page where you can get all kinds of useless helpful information, or .