Alarm Record Syntax
The alarm log and the history files are ASCII (i.e. text) files, where each line contains one alarm record.
The generic alarm record syntax is:
Time stamp, Syslog location, Alarm key|
NE type|
Localisation|
Alarm text|
Alarm severity|
Alarm on date and time|
Alarm off date and time|
Ack on date and time|
Ack on user id|
Ack off date and time|
Ack off user id|
Comment|
NE type|
Localisation|
Alarm text|
Alarm severity|
Alarm on date and time|
Alarm off date and time|
Ack on date and time|
Ack on user id|
Ack off date and time|
Ack off user id|
Comment|
The above information is on a single one line.
The above entry is written when a cleared alarm is acknowledged and flushed from the database.
In general, an alarm record consists of a number of fields separated by the “|” character. The various fields are described below.
• Time Stamp and Syslog location, Alarm Key
− Syslog location
The hostname of the workstation where the core is installed, and the name of the daemon that reported the alarm.
− Alarm key
For NE alarms, the alarm key is a string of the form X:Y, where X is the NE name and Y is an index number for the alarms of that particular NE. For system alarms X is the name of the workstation containing the core. The number Y is incremented for each new alarm that is detected by the FOX515.
For example, Paris:12 refers to the 12th alarm recorded on the FOX515 with the name Paris.
In general, every NE alarm key is unique. The exception to this is if the NE is deleted and re-created. In this case the alarm index (Y) starts counting from 1 again.
• NE type
This field identifies the source of the alarm, which can be an Hitachi Energy NE, a foreign object (Foreign) or the system (System).
• Localization
For NE alarms and internal alarms, the 3rd field of an alarm record is the “localization” of the form “unit_name <slot layer or distribution frame text”.
Examples:
− LOMIF <17> 2 Mbit/s-3 FOX515_A<->B / E12
− SYNAC <6> Link-1 (<2 STM1-1-Paris K111) 2Mbit/s
− SIFOX <8>Traffic-2
For system restarts and foreign object alarms, this field is empty.
• Alarm text
For NE alarms the 4th field of an alarm record is the alarm text.
Examples
− SYNAC_Remote loss of CAS MF
− SIFOX_No DTE signal T
For internal alarms and system restarts, this field is empty.
• Alarm Severity
For NE alarms the 5th field of an alarm record is the alarm severity.
Examples
− “Critical”
− “Warning”
Please note:
This is the alarm severity that was active when the alarm was registered in the FOXMAN‑UN. This could be different than the alarm severity that is in the current alarm criteria if this was modified before or after the alarm was registered.
• Alarm on date and time
For NE alarms the 6th field of an alarm record is the date and time at which the alarm on event was recorded by the NE.
For internal alarms this field records the date and time at which the alarm was recorded by the NE.
For system restarts this field records the date and time at which the NE restarted.
The date and time is of the form “mm/dd/yyyy hh:mm:ss”
− e.g. 17/05/2012 03:08:40
The remaining fields are present for NE alarms only. For internal alarms and system restarts, these fields are missing.
• Alarm off date and time
The 7th field of an alarm record is the date and time at which the alarm off event was recorded by the NE.
The date and time is of the form “mm/dd/yyyy hh:mm:ss”.
The date and time is of the form “mm/dd/yyyy hh:mm:ss”.
• Alarm on acknowledge date and time
The 8th field of an alarm record is the date and time at which the alarm on event was acknowledged using the FOXMAN‑UN.
The date and time is of the form “mm/dd/yyyy hh:mm:ss”.
• Alarm on acknowledge user name
The 9th field of an alarm record is the username of the person who acknowledged the alarm on event.
• Alarm off acknowledge date and time
The 10th field of an alarm record is the date and time at which the alarm off event was acknowledged using the FOXMAN‑UN.
The date and time is of the form “mm/dd/yyyy hh:mm:ss”.
• Alarm off acknowledge user name
The 11th field of an alarm record is the username of the person who acknowledged the alarm off event.
• Comment
If you have added a comment to the alarm via the “Alarm Details” dialog, this is written into the 12th field of the alarm record. If there is no comment, this field is empty.
To maintain compatibility with Excel, the comment is truncated to 255 characters, with carriage returns converted to spaces.
The following lines show some examples of typical alarm records. Note that the NE alarm record has been split into separate lines so that it fits onto the page. In practice the NE alarm record is written on a single line of approximately 150 characters.
Example of BP alarm.txt records:
May 9 13:33:48 nemsrv bpalarmmgrd: NE_172.31.38.208:71|FOX615|/unit-19/port-8 (E12)|Loss Of Signal|Major|2017/05/07 11:47:40|2017/05/08 10:44:42|2017/05/09 13:33:48|nemadmin|2017/05/09 13:33:48|nemadmin||
May 9 13:33:48 nemsrv bpalarmmgrd: NE_172.31.38.209:12|FOX615|/unit-18/port-1 (STM4)|Loss Of Signal|Major|2017/05/07 11:48:48|2017/05/07 18:03:24|2017/05/09 13:33:48|nemadmin|2017/05/09 13:33:48|nemadmin||
Example of NP specific alarm.txt records:
Mar 5 14:06:12 picard syslog: NP Alarms:8|FOX-U|NP|Desynchronization on NE NE1 via LAN |Critical|05/03/2012 13:55:54|05/03/2012 14:06:12|05/03/2012 14:05:22|FOXMAN‑UN|05/03/2012 14:06:12|FOXMAN‑UN|
Mar 5 14:06:12 picard syslog: NP Alarms:9|FOX-U|NP|Process notification failed, received the internal error : Database object not found|Critical|05/03/2012 13:57:57|05/03/2012 14:06:12|05/03/2012 14:05:22|FOXMAN‑UN|05/03/2012 14:06:12|FOXMAN‑UN|
The default delimiter for the individual fields in the alarms.txt file is the bar “|” symbol.