xenial (1) wulf2html.1.gz

Provided by: wulf2html_2.6.0-0ubuntu3_all bug

NAME

       wulfweb - A script to create an html table of cluster node statistics

SYNOPSIS

       wulfweb [-d delay] [-f wulfhosts] [-i include] [-p path] [-t type] [-h] [-v level] filename

WULFWEB OPTIONS

         filename (required) is the name of the web page created (e.g. mycluster.html)
         -d delay sets the delay used for both wulflogger and page updates
         -f wulfhosts to specify a particular wulfhosts file
         -i  include  file  (which  must  contain  html  intended to go after <html> and before the table in the
       created web page).
         -t type to control wulflogger "type" of display.
         -h displays help/usage
         -v level controls verbosity and debugging output

DESCRIPTION

       wulfweb is a script that creates a web page containing an optional inclusion (described in detail  below)
       followed  by  an  html table formatted to contain automatically updated cluster statistics collected from
       xmlsysd's running on the cluster nodes by wulflogger.  Note that wulflogger is therefore required by  the
       wulfweb program.

       A typical invocation might be:

       $ wulfweb -f /usr/share/wulfweb/wulfhosts -d 60 -t 1 \
            -i myheader.html mycluster.html &

       to  create a page with the header myheader.html in front of the "load averages" table that auto-refreshes
       every 60 seconds.  The cluster is described in the wulfhosts file (see wulfstat(1) or  wulflogger(1)  for
       details). Run in the background, wulfweb will keep this page current indefinitely.

INCLUDED FILE

       The  included file must contain valid html for material that you might wish to precede the table.  It can
       be empty (or no include file may be given on the command line) in which case the raw table and the <meta>
       tag that causes automatic refresh are the sole contents of the output file.

       The included header file can be as fancy as you like, but I'd strongly urge that if you want to embed the
       tables in a complex document you consider using php and including the table in a php-generated  page,  as
       otherwise I think you'll find this simple inclusion mechanism limiting.

       Be warned!  Check the resulting documents produced carefully for errors!  The most that wulfweb can do is
       produce the table (hopefully correctly).  Obviously it cannot be blamed for bad html in any inclusion.

       The following is an example of a reasonable inclusion that should work:

       <html>
        <head>
          <title>MyCluster Stats</title>
        </head>

        <body>

        <h2>MyCluster Load Average</h2>

        <hr>

DISPLAY TYPES

       The following display types are supported by wulflogger:

         0 - a "vmstat-like" display of stats from all cluster hosts.  Probably
             the most useful single display.
         1 - load average only
         2 - memory utilization (similar to running "free" on each host)
         3 - network rates
         4 - time displays system clocks, uptime, cpu type and clock
         5 - pids interface for monitoring running distributed tasks.
         6 - pids interface for monitoring running distributed tasks with
             full command line displayed.

       The pids interface (with or without the full command line displayed) is a bit quirky. It  will  generally
       ignore  root-owned  tasks,  for  example,  presuming  that  the  tool  is  intended  to monitor userspace
       applications.  There exist wulfhosts controls for  these  properties;  eventually  they  will  likely  be
       controllable at the command line of this tool as well.

SEE ALSO

       xmlsysd(8), wulfstat(1), wulflogger(1)

WARNING WARNING WARNING

       Trust  No  One.   Your Mileage May Vary.  Use With Caution.  Void Where Prohibited.  Use Your Head.  I am
       NOT RESPONSIBLE for losses you sustain based on the use of this software, which comes  with  NO  WARRANTY
       concerning suitability for any purpose and in fact may be quite useless and misleading.

       You Have Been Warned.

ACKNOWLEDGEMENT

       Blessings  on any and all who've ever contributed to the perl programming language, from its inventors on
       down.