hobbitd_channel(8) [debian man page]

HOBBITD_CHANNEL(8)					      System Manager's Manual						HOBBITD_CHANNEL(8)

NAME

       hobbitd_channel - Feed a hobbitd channel to a worker module

SYNOPSIS

       hobbitd_channel --channel=CHANNEL [options] workerprogram [worker-options]

DESCRIPTION

       hobbitd_channel	hooks  into  one  of  the  hobbitd(8)  channels  that  provide information about events occurring in the Xymon system.	It
       retrieves messages from the hobbitd daemon, and passes them on to the workerprogram on the STDIN (file descripter 1) of the worker program.
       Worker programs can then handle messages as they like.

       A number of worker programs are shipped with hobbitd, e.g.  hobbitd_filestore(8) hobbitd_history(8) hobbitd_alert(8) hobbitd_rrd(8)

       If you want to write your own worker module, a sample worker module is provided as part of the hobbitd distribution in the hobbitd_sample.c
       file. This illustrates how to easily fetch and parse messages.

OPTIONS

       hobbitd_channel accepts a few options.

       --channel=CHANNELNAME
	      Specifies the channel to receive messages from, only one channel can be used.  This option is required. The following  channels  are
	      available:
	      "status" receives all Xymon status- and summary-messages
	      "stachg" receives information about status changes
	      "page" receives information about statuses triggering alerts
	      "data" receives all Xymon "data" messages
	      "notes" receives all Xymon "notes" messages
	      "enadis" receives information about hosts being disabled or enabled.

       --daemon
	      hobbitd_channel  is normally started by hobbitlaunch(8) as a task defined in the hobbitlaunch.cfg(5) file. If you are not using hob-
	      bitlaunch, then starting hobbitd_channel with this option causes it to run as a stand-alone background task.

       --pidfile=FILENAME
	      If running as a stand-alone daemon, hobbitd_channel will save the proces-ID of the daemon in FILENAME. This is useful for  automated
	      startup- and shutdown- scripts.

       --env=FILENAME
	      Loads  the  environment variables defined in FILENAME before starting hobbitd_channel.  This is normally used only when running as a
	      stand-alone daemon; if hobbitd_channel is started by hobbitlaunch, then the environment is controlled by the task definition in  the
	      hobbitlaunch.cfg(5) file.

       --log=FILENAME
	      Redirect output to this log-file.

       --debug
	      Enable debugging output.

FILES

       This program does not use any configuration files.

SEE ALSO

       hobbitd(8), xymon(7)

Xymon							    Version 4.2.3:  4 Feb 2009						HOBBITD_CHANNEL(8)

HOBBITD_FILESTORE(8)					      System Manager's Manual					      HOBBITD_FILESTORE(8)

NAME

       hobbitd_filestore - hobbitd worker module for storing Xymon data

SYNOPSIS

       hobbitd_channel --channel=status hobbitd_filestore --status [options]
       hobbitd_channel --channel=data	hobbitd_filestore --data [options]
       hobbitd_channel --channel=notes	hobbitd_filestore --notes [options]
       hobbitd_channel --channel=enadis hobbitd_filestore --enadis [options]

DESCRIPTION

       hobbitd_filestore  is  a  worker module for hobbitd, and as such it is normally run via the hobbitd_channel(8) program. It receives hobbitd
       messages from a hobbitd channel via stdin, and stores these in the filesystem in a manner that is compatible with the Big  Brother  daemon,
       bbd.

       This program can be started multiple times, if you want to store messages for more than one channel.

OPTIONS

       --status
	      Incoming	messages  are  "status" messages, they will be stored in the $BBLOGS/ directory. If you are using xymon(7) throughout your
	      Xymon server, you will not need to run this module to save status messages, unless you have a third-party add-on that reads the sta-
	      tus-logs directly.  This module is NOT needed to get trend graphs, you should run the hobbitd_rrd(8) module instead.

       --data Incoming	messages  are  "data" messages, they will be stored in the $BBDATA directory. This module is not needed, unless you have a
	      third-party module that processes the data-files. This module is NOT needed to get trend graphs, you should run  the  hobbitd_rrd(8)
	      module instead.

       --notes
	      Incoming	messages  are  "notes" messages, they will be stored in the $BBNOTES directory. This modules is only needed if you want to
	      allow people to remotely update the notes-files available on the Xymon webpages.

       --enadis
	      Incoming messages are enable/disable messages, they will update files in the $BBDISABLED directory. This is only needed if you  have
	      third-party add-ons that use these files.

       --dir=DIRECTORY
	      Overrides the default output directory.

       --html Used together with "--status". Tells hobbitd_filestore to also save an HTML version of the status-log. Should not be used unless you
	      must run with "BBLOGSTATUS=static".

       --htmldir=DIRECTORY
	      The directory where HTML-versions of the status logs are stored.	Default: $BBHTML

       --htmlext=.EXT
	      Set the filename extension for generated HTML files. By default, HTML files are saved with a ".html" extension.

       --multigraphs=TEST1[,TEST2]
	      This causes hobbitd_filestore to generate HTML status pages with links to service graphs that are split  up  into  multiple  images,
	      with at most 5 graphs per image. If not specified, only the "disk" status is split up this way.

       --only=test[,test,test]
	      Save status messages only for the listed set of tests. This can be useful if you have an external script that needs to parse some of
	      the status logs, but you do not want to save all status logs.

       --debug
	      Enable debugging output.

FILES

       This module does not rely on any configuration files.

SEE ALSO

       hobbitd_channel(8), hobbitd_rrd(8), hobbitd(8), xymon(7)

Xymon							    Version 4.2.3:  4 Feb 2009					      HOBBITD_FILESTORE(8)