File: configfile-availability.pod

package info (click to toggle)
remstats 1.00a4-8woody1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 4,576 kB
  • ctags: 1,020
  • sloc: perl: 11,706; ansic: 2,776; makefile: 944; sh: 869
file content (56 lines) | stat: -rw-r--r-- 1,731 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
=cut

TITLE=configuration - availability
DESCRIPTION=configuring availability for remstats
KEYWORDS=configuration,availability
DOCTOP=index
DOCPREV=configfile-alerts
DOCNEXT=configfile-colors

=pod

=head1 Configuration - Availability


There are two types of availability definitions: for an RRD or for an 
RRD on a particular host.  The RRD may also be a wildcard RRD, like
"df-*" or an instance of an RRD, like "df-/home".  The definitions
look like:

	rrd RRDNAME VARNAME CF RELATION THRESHOLD
and
	host HOSTNAME RRDNAME VARNAME CF RELATION THRESHOLD

The CF is one of LAST, MIN, MAX or AVERAGE, with rrdtool's usual
meaning.  The RELATION can be any one of: <, <=, >, >=, or =.  
The THRESHOLD is the number to which the value of VARNAME must be 
in the correct RELATION.  (Clear as mud.)  

As an example, take the following definition:

	rrd ping rcvd MINIMUM > 0

This means that the variable 'rcvd' in the ping rrd must be greater 
than zero for it to be considered "available".  All time intervals 
where it isn't, or for which no data is available, are considered 
"unavailable".

There are also two other record types: colors and thresholds.  A colors
record looks like:

	colors COLOR1 ...

A thresholds line looks like:

	thresholds NUMBER ...

and must have the same number of values as the colors line.  Only one of
each.  Here's an example to make the use clear (I hope):

	colors avail1 avail2 avail3 avail4
	thresholds 99 98 95 90

The C<colors> line above requires that the colors 'avail1', ... be defined in the
L<colors|configfile-colors> config-file.  The C<thresholds> line above specifies 
that if an availability is 99% or above, it should be colored 'avail1' color, 
98% to 99%, use 'avail2' color, etc.