Name

rrd — system parameter watching

Synopsis

rrd [-v] { time | class | list | values | create | update | monitor | proxy | lsgraph }

rrd [-v] graph class.instance.graph.time ...

Description

Utility rrd provides a command line interface to the online system parameter watching facilities of the Kernun Firewall. The history of values of various parameters is stored in a RRD (Round-Robin Database) and can be displayed in the form of graphs on demand.

Program rrd categorizes available parameters into named classes (for example, netif for network interface parameters, proxy for proxies, or sys for system). Each class can have several instances (individual network interfaces for class netif, proxies for class proxy, or single instance named by hostname for class sys. In order to be able to watch proxy parameters, monitoring must be enabled for the proxy, see monitoring(7).

For each instance, one or more parameters can be watched and stored in an RRD file. Graphical presentation of data can be generated in various time scales, for example, last day or month.

Options

-v

Verbose output for debugging and help

time

Lists identifiers of available time scales of graphs. The identifiers are usable in graph command. If called with -v, a short description of each time scale is displayed.

class

Lists all classes of parameters that can be watched. The identifiers are usable in graph command. If called with -v, a short description of each parameter is displayed.

list

Lists all existing instances of all parameter classes. Each line is prefixed by two characters, which are either '-', 'A' (the instance is active, that is, currently existing in the system), or 'D (there is a RRD file for the instance). RRD files for inactive instances are not removed automatically, which makes it possible to display graphs for removed proxies or network interfaces.

values

Displays the current values of all watched parameters.

create

Creates RRD files for all active instances.

update

Obtains the current values of all watched parameters and stores them in the RRD. This should be called periodically, for example, once a minute by cron.

monitor

Updates the RRD continuously. Periodically calls update, waits for some time (1 minute by default) and updates again.

proxy

Deletes monitoring files of terminated proxies and stores data from them in /data/rrd/proxy.sum. This should be called periodically to delete obsolete monitoring files if periodic update is not performed and monitoring is switched on in at least one proxy.

lsgraph

Lists available graph types. If called with -v, a short description of each graph is displayed.

graph

Generates graphs. Each argument following graph defines one graph to generate by specifying data class, instance, graph type, and graph time scale (delimited by periods).

Files

/data/rrd

Directory used to store RRD database files and generated graphs

.

The current directory is used if /data/rrd does not exist.

/data/rrd/*.rrd

A RRD database file for a single instance

/data/rrd/*.png

A graph generated from RRD data

/data/rrd/proxy.sum

Values of parameters taken from monitoring files of terminated proxies

Bugs

RRD database files are not portable between architectures. If you migrate a Kernun system from i386 to amd64 or vice versa, you cannot copy your RRD files. If you do, they will not be updated and graphs will not be generated from them. It is possible to move a RRD file from one architecture to another in a portable XML format. Export the binary data to XML by command rrdtool dump on the original architecture, then import XML data into the binary format by command rrdtool restore on the target architecture.

See Also

monitoring(7)

Authors

This man page is a part of Kernun Firewall.
Copyright © 2000–2021 Trusted Network Solutions, a. s.
All rights reserved.