source: branches/fc13-dev/noc/ng/README @ 1613

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