3.4 Setting Custom Properties for Alarm Server Connectivity and Alarm Server Functions

3.4.1 Creating a Custom Properties File

To create a custom properties file:

  1. Create a file named Eve.custom.properties and save it in the /OperationsCenter_install_path/config directory.

    • Do not add an extension to the file name.

    • If the same property is in both the Eve.custom.properties file and the Eve.properties file, the Event Manager uses the value as specified in the Eve.custom.properties file.

    • When the Operations Center Configuration Manager runs, it does not overwrite the Eve.custom.properties file. The Operations Center Configuration Manager overwrites the Eve.properties file.

  2. Modify existing properties to meet requirements and add properties as necessary.

    For information to make these modifications, see Section 3.4.2, Properties Related to Alarm Server Connectivity and Section 3.4.3, Custom Properties Related to Alarm Server Functions.

3.4.2 Properties Related to Alarm Server Connectivity

Add any of the following properties to the Eve.custom.properties file to help manage data streams after losing Alarm server connectivity.

The Event Manager Server controls the alarm queue based on the percentage of free memory available. Otherwise, supply a value with the com.mosol.Eve.Agent.Xmx property. Using the Xmx value, the server queues events until the VM has 10 percent or less free space available. To increase or decrease this minimum free memory ratio, use the com.mosol.Eve.Agent.storeAndForwardAlarmsMinFreeMemoryRatio property.

The following lists AlarmServer connectivity custom properties:

  • com.mosol.Eve.Agent.storeAndForwardAlarms: This property enables/disables storage and forwarding of alarms to managed data streams. The default is True. To disable storage and forwarding, set it to False.

  • com.mosol.Eve.Agent.storeAndForwardAlarmsMax: This property is only used if it cannot discover the ‑Xmx setting for the VM. It sets the maximum number of alarms to store while the managed data stream is down.

    Set the value to a number that equals the maximum number of alarms that are queued when Alarm server connectivity is lost. When it reaches the specified number of alarms, it discards the oldest alarm and keeps the newest alarm until the managed data stream can be contacted again. To queue all alarms, set the value to ‑1. To not queue any events, set to 0. The default is 10000 alarms.

  • com.mosol.Eve.Agent.storeAndForwardAlarmsMinFreeMemoryRatio: This property controls the alarm queue based on the percentage of free space in the VM.

    The calculation used is: actual memory used divided by maximum memory available. If that percentage is greater than the supplied value, it queues the alarm; otherwise, it discards the oldest alarm and queues the alarm.

    The default is 10 percent. The maximum value allowed is 51. If a larger value is specified, it is automatically reset to 10.

  • com.mosol.Eve.Agent.alarmQueueSize: This property sets the maximum number of alarms an Agent Container can hold in its outbound queue. The default value is 4000.

3.4.3 Custom Properties Related to Alarm Server Functions

Add any of the following properties to the Eve.custom.properties file to help manage Alarm server functions.

WARNING:The following settings in the Eve.properties file control the flow of events between the Alarm server and the Event Manager adapter. Do not change or try to override these values.

  • Eve.Max.Dispatch.Events.Block.Size=1000

  • Eve.Max.Dispatch.Events.Pause.In.Millis=100

The following lists the Alarm server function custom properties:

  • com.mosol.Eve.AlarmServer.usedatetime: If True, the event date and time stamps are taken from alarm data versus the current date/time when the event is processed. The default is False. When True, you must:

  • com.mosol.Eve.AlarmServer.delayedAlarmsPreCloseRules: If True, events that create a delayed alarm perform Close Rule functions as soon as the event arrives in the alarm server. If False, Close Rule functions are not performed until the delayed alarm becomes active. The default is True.

  • com.mosol.Eve.AlarmServer.resetDelayedAlarmsTime: If True, a delayed alarm’s initial date and time, and its most recent date and time are set to the date and time that the alarm became active. If False, a delayed alarm’s initial date and time is set to the date and time the event arrived in the alarm server and its most recent date and time is set to the date and time that the alarm became active. In both cases, the alarm’s date and time in Operations Center is the most recent date and time. The default is False.

  • com.mosol.Eve.AlarmServer.useEMSClassToClose: If True, alarms are closed across the EMS_class as defined in the agent as the hierarchy class. If False, alarms are closed using the EMS as defined in the agent as the agent’s name. (Note: Setting EMS in the rule set does not work at this time). The default is False.

  • com.mosol.Eve.AlarmServer.updateAllFieldsOnAccumulation: If True, updates all the alarm’s properties on accumulation. This includes, but is not limited to, severity, priority, and alarm text. If False, only the accumulation counter, the most recent date and time, and the alarm’s timeout value are updated. The default is True.

    Accumulated alarms that have escalated or de-escalated will not have their severity or priority properties updated.

  • com.mosol.Eve.AlarmServer.journalInactive Events: If True, pending delayed and threshold alarms are stored in the external Event Data Store database. The default is True.

  • com.mosol.Eve.AlarmServer.timeout.schedule: The scheduled time, in milliseconds, to check for alarm timeouts. The default is 30000 (30 seconds).

  • com.mosol.Eve.AlarmServer.delay.schedule: The scheduled time, in milliseconds, to evaluate delayed events. The default is 30000 (30 seconds).

  • com.mosol.Eve.AlarmServer.escalation.schedule: The scheduled time, in milliseconds, to evaluate time escalated alarms. The default is 30000 (30 seconds).

  • com.mosol.Eve.AlarmServer.maxActiveAlarms: The maximum number of active alarms that signals the Event Manager adapter to set the severity state and warnings about the number of active Event Manager alarms. This is not the maximum number of alarms for the Alarm server. The Alarm server holds as many alarms as machine resources allow. The default is 100000.

For additional explanations of these properties and examples, see Section 7.4.9, Configuring Alarms.