logApplicationEventAlarm method for application Logging / Alarming

Last Updated : May 29, 2016 |
Prolog information
Metadata
Keywords:
The logApplicationEventAlarm method can be used to issue the application events / alarms from the application to the EPM. The alarm events are sent via SNMP traps to the configured network management station but not through INADS.
This topic discusses the information you need to specify to create an application event entry.

Parameters

Parameter
Type
Description
appServerAddress
string
The hostname or IP address of the application server.
applicationID
string
The name of the application. For example: CollectTicketInfo
level
string
The logging level.
The options are:
  • Fatal
  • Error
  • Warning
reason
string
The generated message defined by the application. Internationalization must be provided by the application. The maximum length is 100 characters. If the length is over the maximum, it will be truncated.
sessionID
string
The session ID for the session.
timestamp
string
The current system time in milliseconds since January 1, 1970 00:00:00 UTC. The value of this parameter should contain a long number.
transactionName
string
Not used.
type
string
Not used.
userLog
string
Not used.
varName
string
A variable name, if one should be included with this event entry. This is optional.
varValue
string
The value of the variable named in varName. This is optional.
activityDuration
integer
Not used.
moduleIdNodeId
string
Not used.

Return values

The logApplicationEventAlarm method returns one of the following values:
  • success
  • decryption failed - error occured decrypting the password
  • Password incorrect
  • Request is out of date
  • Error storing data in database
  • Error initializing database
  • Error getting the EPID
The following table displays the log events and the associated messages to Alarm Maps:
Log Message
Message to Alarm Map
Log Level
Alarm Severity
Log Message
Alarm Message
PAPP_00001
QAPP_00001
Warning
Minor
Application {0} reported an error from {1} at {2} with message: {3} {4}
QAPP_00001: Application generated a Minor alarm
PAPP_00002
QAPP_00002
Error
Major
Application {0} reported an error from {1} at {2} with message: {3} {4}
QAPP_00002: Application generated a Major alarm
PAPP_00003
QAPP_00003
Fatal
Critical
Application {0} reported an error from {1} at {2} with message: {3} {4}
QAPP_00003: Application generated a Critical alarm
The parameter definitions for the log entries are:
  • {0} – Name of the application defined on the application configuration web page (applicationID)
  • {1} – Application server IP or host name (appServerAddress), Session ID: (sessionID)
  • {2} – Application server time of the log event (timestamp)
  • {3} – The generated message defined by the application. Internationalization must be provided by the application (reason)
  • {4} – Variable Name: (varName) Variable Value: (varValue)