SmokePing takes it configuration from a single central configuration file. Its location must be hardcoded in the smikeping script and smokeping.cgi.
The contents of this manual is generated directly from the configuration file parser.
The Parser for the Configuration file is written using David Schweikers ParseConfig module. Read all about it in the ISG::ParseConfig manpage.
The Configuration file has a tree like structure with section headings at various levels. It also contains variable assignements and tables.
The text below describes the syntax of the SmokePing configuration file.
General configuration values valid for the whole SmokePing setup.
The following variables can be set in this section:
Describes the properties of the round robin database for storing the SmokePing data. Note that it is not possible to edit existing RRDs bychangeing the entries in the cfg file.
The following variables can be set in this section:
This section also contains a table describing the setup of the SmokePing database. Below are reasonable defaults. Only change them if you know rrdtool and its workings. Each row in the table describes on e RRA.
# cons xff steps rows AVERAGE 0.5 1 1008 AVERAGE 0.5 12 4320 MIN 0.5 12 4320 MAX 0.5 12 4320 AVERAGE 0.5 144 720 MAX 0.5 144 720 MIN 0.5 144 720
Defines how the SmokePing data should be presented.
The following variables can be set in this section:
The following sections are valid on level 1:
The following variables can be set in this section:
The detailed display can contain several graphs of different resolution. In this table you can specify the resolution of each graph.
Example:
"Last 3 Hours" 3h "Last 30 Hours" 30h "Last 10 Days" 10d "Last 400 Days" 400d
The Probes Section configures Probe modules. Probe modules integrate an external ping command into SmokePing. Check the documentation of the Ping module for configuration details.
The following sections are valid on level 1:
The following variables can be set in this section:
The Target Section defines the actual work of SmokePing. It contains a hirarchical list of hosts which mark the endpoints of the network connections the system should monitor. Each section can contain one host as well as other sections.
The following variables can be set in this section:
The following sections are valid on level 1:
The following variables can be set in this section:
In the second case, the target machine has a dynamic IP address and thus is required to regularly contact the SmokePing server to verify its IP address. When starting SmokePing with the commandline argument --email it will add a secret password to each of the DYNAMIC host lines and send a script to the owner of each host. This script must be started regularly on the host in quetion to make sure SmokePing monitores the right box. If the target machine supports SNMP SmokePing will also query the hosts sysContact, sysName and sysLocation properties to make sure it is still the same host.
The following sections are valid on level 2:
Copyright (c) 2001 by Tobias Oetiker. All right reserved.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
Tobias Oetiker <tobi@oetiker.ch>