Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

msgcache(8) [debian man page]

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

NAME

       msgcache - Cache client messages for later pickup by hobbitfetch

SYNOPSIS

       msgcache [options]

DESCRIPTION

       msgcache  implements  a Xymon message cache. It is intended for use with clients which cannot deliver their data to the Xymon server in the
       normal way. Instead of having the client tools connect to the Xymon server, msgcache runs locally and the client tools then  deliver  their
       data to the msgcache daemon. The msgcache daemon is then polled regularly by the hobbitfetch(8) utility, which collects the client messages
       stored by msgcache and forwards them to the Xymon server.

       NOTE: When using msgcache, the BBDISP setting for the clients should be BBDISP=127.0.0.1 instead of pointing at the real Xymon server.

RESTRICTIONS

       Clients delivering their data to msgcache instead of the real Xymon server will in general not notice this. Specifically, the  client  con-
       figuration  data provided by the Xymon server when a client delivers its data is forwarded through the hobbitfetch / msgcache chain, so the
       normal centralized client configuration works.

       However, other commands which rely on clients communicating directly with the Xymon server will not work.  This	includes  the  config  and
       query commands which clients may use to fetch configuration files and query the Xymon server for a current status.

       The download command also does not work with msgcache.  This means that the automatic client update facility will not work for clients com-
       municating via msgcache.

OPTIONS

       --listen=IPADDRESS[:PORT]
	      Defines the IP-address and portnumber where msgcache listens for incoming connections. By default, msgcache listens for  connections
	      on all network interfaces, port 1984.

       --server=IPADDRESS[,IPADDRESS]
	      Restricts  which servers are allowed to pick up the cached messages.  By default anyone can contact the msgcache utility and request
	      all of the cached messages. This option allows only the listed servers to request the cached messages.

       --max-age=N
	      Defines how long cached messages are kept. If the message has not been picked up with N seconds after being delivered  to  msgcache,
	      it is silently discarded. Default: N=600 seconds (10 minutes).

       --daemon
	      Run as a daemon, i.e. msgcache will detach from the terminal and run as a background task

       --no-daemon
	      Run  as  a  foreground task. This option must be used when msgcache is started by hobbitlaunch(8) which is the normal way of running
	      msgcache.

       --pidfile=FILENAME
	      Store the process ID of the msgcache task in FILENAME.

       --logfile=FILENAME
	      Log msgcache output to FILENAME.

       --debug
	      Enable debugging output.

SEE ALSO

       hobbitfetch(8), xymon(7)

Xymon							    Version 4.2.3:  4 Feb 2009						       MSGCACHE(8)

Check Out this Related 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)
Man Page