Remstats Files
This is a reference to the various kinds of files remstats uses and
creates.
The simple ones really don't need explanation, and are included here
for completeness:
-
/usr/lib/remstats/bin
- contains executables provided with remstats
-
/usr/lib/remstats/lib
- contains "libraries" required at run-time by the
executables. So far, it's only .pl
files.
-
/etc/remstats
- contains configuration information. Immediately after
a new installation, it will only contain a single sub-directory -
config-base
. new-config will create configuration directories
under /etc/remstats
containing a mix of symlinks to files and sub-directories
of config-base
and copies of those files and sub-directories, according
to whether an installation is likely to want to change them.
-
/var/lib/remstats/cgi
- (FIXME this will have to be re-written for
page-maker)
contains the created web-pages to display status and
graph information. At the top level, there are the index pages and a
sub-directory for each host, named with that host's name. The host
sub-directories contain all the index pages and graph images for that host.
In addition, there are a few special files and sub-directories
of /var/lib/remstats/cgi
:
-
MOTD.html
- The graph-writer will create this file if it doesn't
exist, but no remstats programs will place anything there. It's purpose it
to contain site-specific information of importance, similar to the
unix /etc/motd
file.
-
IMAGES
- This contains remstats-supplied static images for
various things, mostly logos.
-
CUSTOM
- This subdirectory contains the web-pages and images
associated with customgraphs, graphs of
information which don't relate to a single host. There is a sub-directory
for each customgraph, to hold its index pages and images and a top-level
index page.
-
VIEWS
- This directory contains view information created by the
view-writer. There will be an overall index page and a sub-directory
for each view to conain its index page and images.
-
MOVIES
- This directory is used by collect-movie-image to
take snapshots of the netflow dataimage, to be assembled
into a "movie". There will be files there called snap-DDHHMM.png
.
This will not be usefull to you unless you write your own netflow datapage.
-
backup
- This directory is used by remstats-backup to contain
two tar-files: data.tar.gz
and <config.tar.gz>.
-
data
- This directory contains the data collected and maintained
by remstats. There is a sub-directory for each host and a few other
special-purpose files and sub-directories:
-
ALERTS
- This file contains the alert status of all variables
which have an alert associated with them, for all RRDs and hosts. It is
maintained by the alert-monitor and will be re-created if it is missing.
-
IP_CACHE
- This is a cached mapping between IP numbers and host-names
created by the routine get_ip
via read_ip_cache
and write_ip_cache
.
In normall use of remstats, it will be created by ping-collector and used by
subsequent programs invoked during a run of run-remstats. It exists
to reduce DNS queries and to provide consistency during a run-remstats run.
-
LAST
- This directory contains a file for each collector, named
for the collector, containing the data collected on it's last invocation.
It's mainly intended for debugging, but could be used for other purposes.
It also contains the file CONFIGCHANGE
which tracks when the configuration
directory tree last changed.
-
LOGS
- This directory contains the event-logs, updated by various
programs which call the routine logit
, and displayed by
showlog.cgi.
-
NT
- This directory contains information collected by nt-discover,
specifically: nthostinfo (which contains SRVINFO data from the
nt-status-collector), nthosts (which contains a list of discovered NT
hosts), and ntusers (which contains login information about NT users).
-
TRACEROUTES
- This contains information collected by
do-traceroutes. Each file (PATH-yyyymmdd-hhmmss) within it is the
output of make-path run on the output of traceroute for all the
hosts. There are also two other files: PATHS
contains the latest
available path for each host, and NAME
contains the name of the latest
PATH-* file.
-
tmp
- Temporary files not needed over the long term. There are
lock-files (LOCK-programname
) and files used to create the lock-files
(LOCK-programname.pid
). There are logs from the current and previous
runs of run-remstats (LOG-run-remstats
and LOG-run-remstats.old
).
STATUS-run-remstats
is updated by run-remstats to show its status while
running, to be displayed by remstats-monitor. Nt-discover creates
some files here prefixed with its name. The most important file here is
uphosts
, created by the ping-collector to contain a list of hosts which
were responding to a ping on this run. This is used by the various
collectors unless they are invoked without the "-u
" flag, to allow
them to skip querying hosts which aren't up.
[