evheartbeat

This command checks the status of an ExtraView database, to indicate whether it is functioning correctly.

SYNOPSIS

evheartbeat [-r] [-m]

DESCRIPTION

This command checks the status of several components of the ExtraView installation, and provides immediate feedback to the user. Additionally, this command is designed to send optional email output, so that a system administrator can be automatically notified if there is a system outage.

The command may be configured with several entries in the evconfig.txt file as shown in this example:

HB_SMTP_SERVER = .com
HB_TO = you@<your-domain>.com[,your-buddy@<your-domain>.com]
HB_FROM = someone@thisplace.com

• The -r option outputs the results from the command in raw XML format. Note: The XML returned also includes tags named DB_DATETIME, FREE_MEMORY, TOTAL_MEMORY, SERVICE_COUNT and HEARTBEAT_EXEC_TIME along with values. This information is useful if you are developing scripts that need to accurately know the current time of the server or scripts that monitor the performance of ExtraView running on the server. The time returned is the time on the database server. The memory statistics are in megabytes and the execution time is in milliseconds
• The -m option signifies that email is to be sent when the command is run, and the command detects an error condition in the ExtraView installation. In this case, the above evconfig.txt options must have been set. No email is sent if the ExtraView installation returns a success code. The intention is that evheartbeat -m is used on a job, to monitor the health of the ExtraView installation. It is suggested that this script is run at least every 15 minutes throughout the day and night.

If the configuration file has not been set correctly, then a message or warning is displayed on the screen, informing the user of the error.

When sending email, evheartbeat places a header into the email message, entitled ExtraView-Audit.

ExtraView-Audit:
Sent by system user <login-name-of-sender>,
from host <name-of-host-running-evheartbeat> (<ip-address-of-host>),
on Tue Sep 30 17:04:17 2003, client program == evheartbeat.

EXAMPLE 1

$ evheartbeat
Heartbeat Results
-----------------
ExtraView status : EXTRAVIEW ALIVE
DataBase status : DB CONNECTION CONFIRMED
DataBase Timestamp: 2004-10-11 22:15:09.000 -0700
$

 

EXAMPLE 2

$ evheartbeat -r
<?xml version="1.0" encoding="UTF-8"?>
<EV_HEARTBEAT>
  <EV_STATUS>EXTRAVIEW ALIVE</EV_STATUS>
  <DB_STATUS>DB CONNECTION CONFIRMED</DB_STATUS>
  <DB_DATETIME>2004-10-11 22:15:22.000 -0700</DB_DATETIME>
  <FREE_MEMORY>106</FREE_MEMORY>
  <TOTAL_MEMORY>128</TOTAL_MEMORY>
  <SERVICE_COUNT>1</SERVICE_COUNT>
  <HEARTBEAT_EXEC_TIME>396</HEARTBEAT_EXEC_TIME>
</EV_HEARTBEAT>
$