The HTML server status page

Samhain
Prev | Chapter 6. Configuring yule, the log server | Next

# 6.8. The HTML server status page

yule writes the current status to a HTML file. The default name of this file is `samhain.html`, and by default it is placed in `/var/log`.

The file contains a header with the current status of the server (starting time, current time, open connections, total connections since start), and a table that lists the status of all registered clients.

There are a number of pre-defined events that may occur for a client:

Inactive

  The client has not connected since server startup.

Started

  The client has started. This message may be missing if the client was already running at server startup.

Exited

  The client has exited.

Message

  The client has sent a message.

File transfer

  The client has fetched a file from the server.

ILLEGAL

  Startup without prior exit. May indicate a preceding abnormal termination.

PANIC

  The client has encountered a fatal error condition.

FAILED

  An unsuccessful attempt to set up a session key or transfer a message.

POLICY

  The client has discovered a policy violation.

TIME_EXCEEDED

  No message (e.g. timestamp) has been received from the client for a defined amount of time (default 1 day, option SetClientTimeLimit).

For each client, the latest event of each given type is listed. Events are sorted by time. Events that have not occurred (yet) are not listed.

It is possible to specify templates for (i) the file header, (ii) a single table entry, and (iii) the file end. Templates must be named `head.html`, `entry.html`, and `foot.html`, respectively, and must be located in the data directory (i.e. `localstatedir/lib/yule/`, see Section A.5>). The distribution package includes two sample files `head.html` and `foot.html`.

The following replacements will be made in the head template:

Placeholder | Significance
--- | ---
%T | Current time.
%S | Startup time.
%L | Time of last connection.
%O | Open connections.
%A | Total connections since startup.
%M | Maximum simultaneous connections.

The following replacements will be made in the entry template:

Placeholder | Significance
--- | ---
%H | Host name.
%S | Event.
%T | Time of event.

| Tip
| A literal '%' in the HTML output must be represented by a '% ' ('%' followed by space) in the template.

Prev | Home | Next
Detecting 'dead' clients | Up | Chroot