| 1 | Nagiosgraph |
|---|
| 2 | ----------- |
|---|
| 3 | |
|---|
| 4 | File: $Id: README,v 1.10 2006/04/05 12:37:11 sauber Exp $ |
|---|
| 5 | Author: (c) Soren Dossing, 2005 |
|---|
| 6 | License: OSI Artistic License |
|---|
| 7 | http://www.opensource.org/licenses/artistic-license.php |
|---|
| 8 | |
|---|
| 9 | |
|---|
| 10 | Summary: |
|---|
| 11 | |
|---|
| 12 | Collects perfdata from Nagios check scripts and inserts data into rrd |
|---|
| 13 | files. Data in the rrdfiles can be displayed in html pages with cgi |
|---|
| 14 | script. |
|---|
| 15 | |
|---|
| 16 | |
|---|
| 17 | Note: |
|---|
| 18 | |
|---|
| 19 | Nagios is a registered trademark of Ethan Galstad. |
|---|
| 20 | |
|---|
| 21 | |
|---|
| 22 | Files: |
|---|
| 23 | |
|---|
| 24 | CHANGELOG - History of changes |
|---|
| 25 | INSTALL - Dcoument for how to install and use nagiosgraph |
|---|
| 26 | README - This file |
|---|
| 27 | README.map - Document for how to create map file entries |
|---|
| 28 | insert.pl - Reads perfdata log from nagios and insert into rrd |
|---|
| 29 | files. |
|---|
| 30 | show.cgi - Generates a html page for the host/sevice specified, |
|---|
| 31 | and generates graphs on-the-fly. |
|---|
| 32 | nagiosgraph.conf - paths and other configuration |
|---|
| 33 | nagiosgraph.css - CSS stylesheet |
|---|
| 34 | map - Regular expression to identify services and |
|---|
| 35 | specification for how to create rrd files. |
|---|
| 36 | testcolor.cgi - Preview of colors for keywords in each color scheme |
|---|
| 37 | testentry.pl - A script for testing new map file entries. |
|---|
| 38 | |
|---|
| 39 | |
|---|
| 40 | Usage: |
|---|
| 41 | |
|---|
| 42 | Follow the instructions in INSTALL for how to install and configure |
|---|
| 43 | nagiosgraph. |
|---|
| 44 | |
|---|
| 45 | |
|---|
| 46 | Getting Help: |
|---|
| 47 | |
|---|
| 48 | Discussions related to nagiosgraph are located in a Sourceforge help |
|---|
| 49 | forum; http://sourceforge.net/forum/forum.php?forum_id=394748 . A |
|---|
| 50 | Sourceforge account is necessary for posting. |
|---|
| 51 | |
|---|
| 52 | |
|---|
| 53 | Principles of Operation: |
|---|
| 54 | |
|---|
| 55 | nagiosgraph is basically a simple interface between Nagios and rrd data |
|---|
| 56 | files. Simplicity comes from three factors; it doesn't do much, behavior |
|---|
| 57 | is programmed rather than configurable, and automatically detects new |
|---|
| 58 | data from Nagios. |
|---|
| 59 | |
|---|
| 60 | nagiosgraphs is operating in two modes. One is to collect performance |
|---|
| 61 | data from servicechecks from nagios, and the other is to display graphs |
|---|
| 62 | of the performance data collected. |
|---|
| 63 | |
|---|
| 64 | All the data collected are stored in rrd files by using rrdtools. A file |
|---|
| 65 | called 'map' defines how identify the data from nagios and how to store |
|---|
| 66 | it in the rrd files. Nagios passes all the service data collected to a |
|---|
| 67 | nagiosgraph script called 'insert.pl'. This script will look up in |
|---|
| 68 | 'map', which rrd file to insert the data into, and how to name the data. |
|---|
| 69 | |
|---|
| 70 | In Nagios it's also possible to have extended service information pages. |
|---|
| 71 | A nagiosgraph cgi script called 'show.cgi' can be used for such service |
|---|
| 72 | information links. 'show.cgi' will look up in 'map' which performance |
|---|
| 73 | data is stored in rrd files, and display graphs of this data. |
|---|
| 74 | |
|---|
| 75 | nagiosgraph will automatically detect when new hosts or services has |
|---|
| 76 | been added in Nagios, so generally no configuration of nagiosgraph is |
|---|
| 77 | necessary when configuration of Nagios changes. |
|---|
| 78 | |
|---|
| 79 | nagiosgraph is designed to only require very little configuration. |
|---|
| 80 | Integrating with Nagios is a complicated process nevertheless. The |
|---|
| 81 | 'README' file describes how to configure nagiosgraph and integrate with |
|---|
| 82 | Nagios. |
|---|
| 83 | |
|---|
| 84 | The 'map' configuration file is actually perl code, that will be eval'ed |
|---|
| 85 | by 'insert.pl' and 'show.cgi'. Several examples of servicechecks are |
|---|
| 86 | included in the distributed 'map' file, but generally it's necessary to |
|---|
| 87 | make modifications or add entries to match the output of the particular |
|---|
| 88 | nagiosplugins in use. Knowing perl is helpful when making modifications, |
|---|
| 89 | but the examples supplied should cover most types of performance data. |
|---|
| 90 | |
|---|
| 91 | By default all available data for a servicecheck will be displayed in |
|---|
| 92 | the same graph. With extra configuration, embedded in the url, it's |
|---|
| 93 | possible to display less data or to split values into multiple graphs. |
|---|
| 94 | There is also a general method for specifying any rrd graph options. |
|---|
| 95 | |
|---|
