xymond_hostdata - xymond worker module for storing historical
client data
xymond_channel --channel=clichg xymond_hostdata
xymond_hostdata is a worker module for xymond, and as such it is
normally run via the xymond_channel(8) program. Whenever a status
column in Xymon changes to an alert state (usually red, yellow or purple),
this module receives a copy of the latest Xymon client data sent by the
host, and stores it on disk. This allows you to review all of the data
collected by the Xymon client on the server around the time that a problem
occurred. This can make troubleshooting incidents easier by providing a
snapshot of the host status shortly before a problem became apparent.
Note: This module requires that xymond(8) is launched with
the "--store-clientlogs" option enabled.
- --recent-period=N
- Sets the length of the save-throttling window, in minutes. Client
data for a host is saved at most --recent-count times within this window;
further messages are dropped. A value of 0 disables the throttle, so all
client data is saved. The value must be a plain integer number of minutes;
anything else falls back to the default. Negative values are clamped to 0.
Default: 60
- --recent-count=N
- Sets how many times a host's client data may be saved within the
--recent-period window. A value of 0 disables saving entirely. The value
must be a plain integer; anything else falls back to the default. Negative
values are clamped to 0 and values above 10000 to 10000. Default: 5
- --minimum-free=N
- Sets the minimum percentage of free filesystem space on the $CLIENTLOGS
directory. If there is less than N% free space, xymond_hostdata will not
save the data. N is a percentage between 0 and 100; 0 disables the
free-space check. The value must be a plain integer; anything else
(including a "%" suffix) falls back to the default. Out-of-range
values are clamped. Default: 5
- --debug
- Enable debugging output.
All of the host data are stored in the $CLIENTLOGS directory, by
default this is the $XYMONVAR/hostdata/ directory.
- NAME
- SYNOPSIS
- DESCRIPTION
- OPTIONS
- FILES
- SEE ALSO