r3 - 29 Jan 2009 - 19:49:04 - EricTYou are here: Wiki >  AppLogic27 Web > RefVme
ALERT! AppLogic 2.7/2.8 Documentation The latest production release is AppLogic 3.0.30

vme: Event Generator for AppLogic Appliances

vme is a user-mode utility that is used by AppLogic appliances to generate specifc events to AppLogic during the appliance boot process and at runtime. As long as an appliance is not unmanaged, the appliance must use vme during its boot process to tell AppLogic if the appliance started OK or not. If the appliance is unable to start due to some error (invalid property settings, not enough available memory, etc), the appliance can use vme to fail the appliance start and also to log an error message to the grid controller's system log (accessed using the grid's list log command). vme can also be used during appliance runtime to log critical error messages to the grid's dashboard.

By default when the appliance kit (APK) is installed in an appliance, vme is used to always send the appliance "started OK" event. This can be overwritten by appliance-specific scripts that are executed during the appliance boot process.

Usage: vme id=<event> [msg=<message>] [severity=<severity>] [progress=<readiness>] [cnt_name=<counter name> cnt_value=<counter value>]
Examples: vme id=started_ok
vme id=start_failed msg="Missing DNS server address"
vme id=maintenance msg="Database recovery" progress=30
vme id=log msg="SSL certificate loaded OK" severity=info
vme id=alert msg="Corrupted database file detected" severity=fatal
vme id=alert cnt_name=n_db_xact_per_min cnt_value=46 severity=fatal
Notes: <event> is one of the following:
    started_ok - appliance started OK
    start_failed - appliance failed to start, message is the reason
    maintenance - appliance is in maintenance mode (i.e., database recovery)
    log - log an event on behalf of the appliance
    alert - a critical event or error has been detected by the appliance this is also used to report a change in a counter value
<message> is a free text, escaped if spaces or special characters are needed
<severity> may be one of the following:
    debug - debug information
    info - informational event
    warn - warning event
    error - error event
    fatal - fatal and irrecoverable error
<readiness> is reported in percent, valid values are 1 through 100
Appliances in maintenance mode must report their progress periodically (no less often than 30 seconds).
<counter name> and <counter value> are only used for alerts
If a message is provided with an alert the message is logged to the grid's dashboard

-- ApoorvaKulkarni - 06 Jan 2009

 
Copyright © CA 2005-2011. All Rights Reserved.
%