spong-status

• NAME
• SYNOPSIS
• DESCRIPTION
• OPTIONS
• CONFIGURATION
  • Configuration Files
  • Configuration Variables
• FILES
• EXAMPLES
• DEPENDENCIES
• BUGS
• SEE ALSO
• AUTHOR
• HISTORY

NAME

spong-status - send various type of messages to a spong-server

SYNOPSIS

 spong-status [--help]
 spong-status [--ttl #] (--file name | --message "message text") CMD HOST
              SERVICE COLOR "SUMMARY TEXT"
 spong-status [--cmd cmd] --host name --service name --color color 
              --summary text (--message text | -f filename) 
              [--ttl seconds]

DESCRIPTION

This program allows you to create your own extern spong client programs or integrate existing monitoring program or scripts in Spong. spong-status hides all of the details of the Spong Client/Server communication protocol.

OPTIONS

--help

Print the help text

--cmd status|page

Command type being sent to spong-server. Defaults to 'status'.

--host NAME

Name of the host being reported.

--service NAME

Name of the service being reported.

--color <COLOR>

Status color being reported. COLOR may be ``green'', ``yellow'', or ``red''.

--summary TEXT

Summary text to be reported.

--ttl SECONDS

Time to live of status report in seconds.

--message TEXT

Detailed message text being reported.

--file FILENAME

Detailed message info read from file FILENAME. If FILENAME is '-', text is read from stdin.

CONFIGURATION

Configuration Files

spong-cleanup reads the standard spong.conf and spong.conf.<host> configuration files.

Configuration Variables

$SPONGSERVER

The host that at least the the spong-server entry elsewhere in this document and the spong-message entry elsewhere in this document programs are running on. Typically the the spong-network entry elsewhere in this document program runs on that host as well.

$SPONG_UPDATE_PORT

This variable defines the port that the the spong-server entry elsewhere in this document update process listens on. If this variable is not defined on the $SPONGSERVER host, the the spong-server entry elsewhere in this document update process will not be started. The default value is 1998.

FILES

SPONGHOME/etc/spong.conf, SPONGHOME/etc/spong.conf.<host>

EXAMPLES

  spong-status --cmd status --host www.my-inc.com --service fping --color yellow
            --summary "Host contacted. Response time more then 30 ms"
            --file /tmp/fping.out

  spong-status --ttl 86400 --message "Backup failed for /usr,/var" page
            www.my-inc.com red backup "Backup failed"

DEPENDENCIES

Perl v5.005_03 or greater is required.

BUGS

No know bugs.

SEE ALSO

the spong-server entry elsewhere in this document, the spong.conf manpage, the developer-guide entry elsewhere in this document

AUTHOR

Stephen L Johnson <sjohnson@monsters.org>

HISTORY

Based on code/ideas from Sean MacGuire (BB), and Helen Harrison (Pong). Ed Hill original converted Big Brother (http://www.bb4.com) into Perl which diverged from Big Brother to become Spong. Ed Hill continued Spong development until version 2.1. Stephen L Johnson took over development in October, 1999 with his changes which became Spong 2.5.