org.openecomp.mso.logger

Class MsoAlarmLogger

java.lang.Object

org.openecomp.mso.logger.MsoAlarmLogger

All Implemented Interfaces:

EventListener, javax.servlet.ServletContextListener

public class MsoAlarmLogger
extends Object
implements javax.servlet.ServletContextListener

Wrapper around log4j and Nagios NRDP passive alarming for MSO. For local alarm logging, this class will look for an alarm log file name in the servlet context parameter "mso.alarms.file". If none is found, it will look for an MsoProperty of the same name. As a last resort, it will use the default path "/var/log/ecomp/MSO/alarms/alarm.log". It is expected that all alarms within an application will use the same alarm file, so there is no way to dynamically add other alarm files. Alarms are logged as a simple pipe-delimited string of the format: ||| This class also supports real-time Nagios NRDP alarming. If enabled via MsoProperties, all alarms generated and logged to the local alarm file will also be transmitted to a Nagios NRDP instance. NRDP requires 4 parameters in service alarm events (all Mso Alarms will be Service Alarms): hostname, servicename, state, detail The log file format is also intended to be compatible with Nagios NRDP for non-real-time reporting. The command-line tool for sending alarms is is "send_nrdp.php", which takes the same 4 parameters as input. It will be easy enough to translate entries from an alarm.log file to NRDP if real-time NRDP alarming is not enabled. For Nagios integration, the alarmTypes should all match "service names" configured in the receiving Nagios server. Also, the alarm state will be limited to the 4 values defined by Nagios: 0 = OK, 1 = Warning, 2 = Critical, 3 = Unknown

Field Summary

Fields

Modifier and Type	Field and Description
static int	CRITICAL
static String	DEFAULT_MSO_ALARM_FILE
static String	MSO_ALARM_CONTEXT
static int	OK
static int	UNKNOWN
static int	WARNING

Constructor Summary

Constructors

Constructor and Description
MsoAlarmLogger() Get the default MSO Alarm Logger
MsoAlarmLogger(String alarmFile)

Method Summary

Modifier and Type	Method and Description
void	contextDestroyed(javax.servlet.ServletContextEvent event)
void	contextInitialized(javax.servlet.ServletContextEvent event)
void	sendAlarm(String alarm, int state, String detail) Method to record an alarm.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_MSO_ALARM_FILE

public static final String DEFAULT_MSO_ALARM_FILE

See Also:

Constant Field Values

MSO_ALARM_CONTEXT

public static final String MSO_ALARM_CONTEXT

See Also:

Constant Field Values

OK

public static final int OK

See Also:

Constant Field Values

WARNING

public static final int WARNING

See Also:

Constant Field Values

CRITICAL

public static final int CRITICAL

See Also:

Constant Field Values

UNKNOWN

public static final int UNKNOWN

See Also:

Constant Field Values

Constructor Detail

MsoAlarmLogger

public MsoAlarmLogger()

Get the default MSO Alarm Logger

MsoAlarmLogger

public MsoAlarmLogger(String alarmFile)

Method Detail

sendAlarm

public void sendAlarm(String alarm,
                      int state,
                      String detail)

Method to record an alarm.

Parameters:

alarm - - the alarm identifier (Nagios "service")

state - - the alarm state/severity, based on Nagios service state values: 0 = OK, 1 = Warning, 2 = Critical, 3 = Unknown

detail - - detail message (may contain additional internal structure per alarm type)

contextDestroyed

public void contextDestroyed(javax.servlet.ServletContextEvent event)

Specified by:

contextDestroyed in interface javax.servlet.ServletContextListener

contextInitialized

public void contextInitialized(javax.servlet.ServletContextEvent event)

Specified by:

contextInitialized in interface javax.servlet.ServletContextListener