TMF688 Event Processor
The TMF688 Event Processor microservice takes events from the assure1/event/canal Pulsar topic, filters them for relevant alarms and thresholds, transforms the filtered events into JSON format compliant with TMF688 and TMF642 specifications, and publishes them to an Apache Pulsar topic. It lets you filter the stream of event data from Oracle Communications Unified Assurance, convert events to standardized format, and share them with external products, such as Oracle Communications Unified Inventory Management (UIM).
Note:
The TMF688 Event Processor does not include a TM Forum REST API interface in Unified Assurance, it simply converts internal Unified Assurance events into the event format defined in the TMF standard.
This microservice is part of Event microservice pipeline. See Understanding the Event Pipeline in Unified Assurance Concepts for conceptual information, including the default flow of events through Unified Assurance, from devices all the way to external Kafka topics in TMF688 and TMF642 compliant format.
You can enable redundancy for this microservice when you deploy it. See Configuring Microservice Redundancy for general information.
This microservice provides additional Prometheus monitoring metrics. See TMF688 Event Processor Self-Monitoring Metrics.
TMF688 Event Processor Prerequisites
Before deploying the microservice, confirm that the following prerequisites are met:
-
A microservice cluster is set up. See Microservice Cluster Setup.
-
The Apache Pulsar microservice is deployed. See Pulsar.
-
Filters must be set up in the filter.json rules file, located in the following folder in the Rules UI:
Core Rules (core)/Default read-write branch (default)/processing/event/tmf688
See Configuring Filters for TMF688 Events for details.
Deploying TMF688 Event Processor
To deploy the microservice, run the following commands:
su - assure1
export NAMESPACE=<namespace>
export WEBFQDN=<WebFQDN>
a1helm install <microservice-release-name> assure1/tmf688-event-processor -n $NAMESPACE --set global.imageRegistry=$WEBFQDN
In the commands:
-
<namespace> is the namespace where you are deploying the microservice. The default namespace is a1-zone1-pri, but you can change the zone number and, when deploying to a redundant cluster, change pri to sec.
-
<WebFQDN> is the fully-qualified domain name of the primary presentation server for the cluster.
-
<microservice-release-name> is the name to use for the microservice instance. Oracle recommends using the microservice name (tmf-688-event-processor) unless you are deploying multiple instances of the microservice to the same cluster.
You can also use the Unified Assurance UI to deploy microservices. See Deploying a Microservice by Using the UI for more information.
Changing TMF688 Event Processor Configuration Parameters
When running the install command, you can optionally change default configuration parameter values by including them in the command with additional --set arguments. You can add as many additional --set arguments as you need.
For example:
-
Set a parameter described in Default TMF688 Event Processor Configuration by adding --set configData.<parameter_name>=<parameter_value>. For example, --set configData.LOG_LEVEL=DEBUG.
-
Enable redundancy for the microservice by adding --set redundancy.enabled=true.
Default TMF688 Event Processor Configuration
The following table describes the default configuration parameters found in the Helm chart under configData for the microservice.
| Name | Default Value | Possible Values | Notes |
|---|---|---|---|
| LOG_LEVEL | INFO | FATAL, ERROR, WARN, INFO, DEBUG | The logging level used by the microservice. |
| STREAM_INPUT | persistent://assure1/event/canal | Text, 255 characters | The path to the Apache Pulsar topic to subscribe to. By default, this is the Event Canal topic, but you can update it if needed. |
| STREAM_OUTPUT | persistent:///assure1/event/tmf688-event | Text, 255 characters | The path to the Apache Pulsar topic to publish to. By default, this is the TMF688 topic, but you can update it if needed. |
| REDUNDANCY_POLL_PERIOD | 5 | Integer | The number of seconds between status checks from the secondary microservice to the primary microservice. |
| REDUNDANCY_FAILOVER_THRESHOLD | 4 | Integer | The number of times the primary microservice must fail checks before the secondary microservice becomes active. |
| REDUNDANCY_FALLBACK_THRESHOLD | 1 | Integer | The number of times the primary microservice must succeed checks before the secondary microservice becomes inactive. |
Configuring Filters for TMF688 Events
You can configure filters in the microservice so that only relevant events are transformed and published.
To update filters:
-
In a browser, log in to the Unified Assurance UI.
-
From the Configuration Menu, select Rules, then expand the following folders:
Core Rules (core)/Default read-write branch (default)/processing/event/tmf688
-
Select the filter.json file.
-
Edit the filters as needed. See JSON Schema for Filters for the required schema.
-
Click Submit.
-
Enter a commit message and click OK.
-
If you already deployed the TMF688 Event Processor microservice, restart its pod by running the following command in the command line as the assure1 user:
a1k delete pod <pod_name> -n <namespace>Tip:
If you don't know the pod name or namespace, run the following command to see a list:
a1k get pods --all-namespacesKubernetes automatically restarts the pod.
JSON Schema for Filters
Filters must conform to the following JSON schema:
{
"filterType": "<filter_type>",
"Filters": [
{
"conjunction": "<conjunction>",
"conditions": [
{
"field": "<field_path>",
"operator": "<operator>",
"value": "<value>"
}
]
}
]
}
The following table describes the placeholders in the schema.
| Component | Description | Valid Values |
|---|---|---|
| <filter_type> | Whether to keep or discard events that match the filter. |
|
| <conjunction> | The conjunction to use to link conditions in the array. |
|
| <field_path> | The JSON path to the field to filter by. You can also filter by items in arrays. | string |
| <operator> | The operator for the field and value. |
|
| <value> | The value to filter by. | string or integer |
Filter Example: Simple Keep Filter
The following example keeps events with severities greater than or equal to 3:
{
"filterType": "keep",
"filters": [
{
"conditions": [
{
"field": "$.event.Severity",
"operator": ">=",
"value": "3"
}
]
}
]
}
Filter Example: Filter with a Sub-Field
The following example keeps events with the CORBA object type of OT_MANAGED_ELEMENT, which is in a sub-field:
{
"filterType": "keep",
"filters": [
{
"conjunction": "and",
"conditions": [
{
"field": "$.event.Details.corba.objectType",
"operator": "=",
"value": "OT_MANAGED_ELEMENT"
}
]
}
]
}
Filter Example: Keep Filter with Array Fields
The following example keeps CORBA events when the value of the EMS parameter in the ObjectName array is ExampleEMS:
{
"filterType": "keep",
"Filters": [
{
"conjunction": "and",
"conditions": [
{
"field": "$.event.Corba.event.ObjectName[].name",
"operator": "=",
"value": "EMS"
},
{
"field": "$.event.Corba.event.ObjectName[].value",
"operator": "=",
"value": "ExampleEMS"
}
]
}
]
}
Filter Example: Discard Filter with Multiple Conjunctions
The following example discards events:
-
With severity equal to 2 that have unidentified probably causes
-
With severity 3 or lower
-
With a probable cause of EMS
{
"filterType": "discard",
"Filters": [
{
"conjunction": "and",
"conditions": [
{
"field": "$.event.Severity",
"operator": "=",
"value": "2"
},
{
"field": "$.event.ProbableCause",
"operator": "=",
"value": "UNIDENTIFIED"
}
]
},
{
"conjunction": "or",
"conditions": [
{
"field": "$.event.Severity",
"operator": "<=",
"value": "3"
},
{
"field": "$.event.ProbableCause",
"operator": "=",
"value": "EMS"
}
]
}
]
}
TMF688 Event Processor Self-Monitoring Metrics
The TMF688 Event Processor microservice exposes the following self-monitoring metrics to Prometheus.
| Metric Name | Type | Description |
|---|---|---|
| total_events_received | Counter | The total number of events received. |
| total_events_processed | Counter | The total number of events processed. |
| processing_time_per_event | Gauge | The processing time for each event from receiving it to sending it to acknowledging it. |
| total_fault_events | Counter | The number of fault events received. |
| total_threshold_events | Counter | The number of threshold events received. |
| total_events_discarded | Counter | The number of events discarded. |
Supported Event Types
The TMF688 Event Processor microservice accepts events for the following types of event:
-
Fault alarms generated by devices and collected by the various poller and collector microservices.
-
Threshold crossing alarms (TCAs) generated internally by Unified Assurance, or as Common Object Request Broker Architecture (CORBA) NT_TCA events from external Element Management Systems (EMS), collected by the CORBA Collector microservice.
The microservice does not accept TCA events from other protocols, such as Simple Network Management Protocol (SNMP) and Multi-Technology Operations Systems Interface (MTOSI).
Both types of event move into the assure1/event/canal through the Event microservice pipeline. See Understanding the Event Pipeline in Unified Assurance Concepts for details.
The TMF688 Event Processor microservice transforms events to the following TMF642 event types:
-
AlarmCreateEvent: An event for creating an alarm.
-
AlarmAttributeValueChangeEvent: An event for updating an alarm.
-
ClearAlarmCreateEvent: An event for clearing an alarm.
-
AlarmDeleteEvent: An event for deleting an alarm.
About TMF JSON Schemas and Payloads
The JSON payloads produced by the TMF688 Event Processor microservice conform to the TMF688 specification, with embedded schemas from the TMF642 specification. The payloads use a subset of the TMF688 schemas and include extensions for custom attributes in the TMF642 schemas.
To download and review these Oracle-specific JSON schemas, see:
-
OracleTMF688Schema.json: Defines the subset of TMF688 schemas that map to Unified Assurance event fields.
-
OracleTMF642Schema.json: Includes the OracleAlarm definition, which contains the customAttributes property. When transforming events, the TMF688 Event Processor microservice adds any custom fields that have been added to the Event database into the array for this property. See Adding Custom Fields to the Event Database for information about how to add custom fields and update the related rules files.
To help correlate alarms with inventory entities in your external inventory system, the microservice includes any node and subnode affected by the alarm in the TMF payload. The node and subnode are mapped to the id property of the alarmedObject schema in this format: node : subnode.
For example, in the alarmedObject schema from Sample AlarmCreateEvent Payloads, the node is node1/51118 and the subnode is subnode1/51118:
"alarmedObject": {
"@referredType": "",
"name": null,
"id": "node1/51118 : subnode1/51118"
},
Sample AlarmCreateEvent Payloads
The following example shows a fault alarm AlarmCreateEvent payload generated by the TMF688 Event Processor microservice.
{
"_domain": "fault",
"@timestamp": "2024-07-16T08:53:43.608317357Z",
"_type": "event",
"_agents": [
{
"app": "event-canal",
"output": "persistent://assure1/event/canal",
"input": "mysql:///Event",
"@timestamp": "2024-07-04T10:05:34.596550216Z",
"host": "host.example.com",
"id": "event-canal-1234"
},
{
"app": "tmf688-event-processor",
"output": "persistent://assure1/event/tmf688-event",
"input": "persistent://assure1/event/canal",
"@timestamp": "2024-07-16T08:53:43.608317357Z",
"host": "host.example.com",
"id": "tmf688-event-processor-1234"
}
],
"message": {
"_type": "json",
"json": {
"eventId": "421044",
"@type": "AlarmCreateEvent",
"eventTime": "2024-07-16T08:53:43.608Z",
"eventType": "AlarmCreateEvent",
"event": {
"alarm": {
"reportingSystemId": "host.example.com",
"alarmRaisedTime": "",
"alarmedObjectType": "",
"@type": "OracleAlarm",
"alarmReportingTime": "2024-06-19T05:41:02.000Z",
"alarmedObject": {
"@referredType": "",
"@type": "AlarmedObjectRef",
"name": "",
"id": "node1/51118:subnode1/51118"
},
"alarmEscalation": true,
"alarmChangedTime": "2024-06-19T09:45:26.495Z",
"perceivedSeverity": "major",
"probableCause": "ALARM_UC05 Ext-Alm2(Battery Discharge)",
"affectedService": [
{
"@type": "ServiceRef",
"id": "OT_EQUIPMENT"
}
],
"ackSystemId": "",
"id": "421044",
"state": "raised",
"place": [
{
"@type": "RelatedPlace",
"name": ""
}
],
"externalAlarmId": "3743573",
"parentAlarm": [
{
"@type": "AlarmRef",
"id": "0"
}
],
"isRootCause": false,
"ackUserId": "",
"serviceAffecting": false,
"ackState": "unacknowledged",
"alarmType": "processingErrorAlarm",
"specificProblem": "",
"comment": [
{
"@type": "Comment",
"comment": "Manual: Event List Edit (API)"
}
],
"alarmDetails":
"{
\"corba\":
{
\"rcaiIndicator\":\"false\",
\"probableCauseQualifier\":\"51118@@0@@-1@@-1@@-1@@357\",
\"serviceAffecting\":\"SA_NON_SERVICE_AFFECTING\",
\"additionalText\":\"No Info\",
\"neTime\":\"20230828123441.0\",
\"emsTime\":\"20230828123505.8\",
\"corbaEventType\":\"VENDOR\",
\"objectType\":\"OT_EQUIPMENT\",
\"perceivedSeverity\":\"PS_CRITICAL\",
\"probableCause\":\"ENV\",
\"nativeEMSName\":\"External Alarm Unit\",
\"layerRate\":\"0\",
\"nativeProbableCause\":\"ALARM_UC05 Ext-Alm2(Battery Discharge)\",
\"additionalInfo\":
{
\"LSNExt_GroupName\":\"ExampleEMS\",
\"LSNExt_MEName\":\"ExampleEMSName\",
\"LSNExt_ALCV\":\"Unknown\",
\"LSNExt_AckStatus\":\"ALM_UNACKNOWLEDGED\",
\"LSNExt_AlarmUniqueString\":\"EMS DN=node1, EMS notifId=2949292, CAM ID=3939953\"
},
\"objectName\":
{
\"EquipmentHolder\":\"/shelf=1/slot=1\",
\"Equipment\":\"1\",
\"ManagedElement\":\"node1/51118\",
\"EMS\":\"ExampleEMS\"
},
\"notificationId\":\"3743573\",
\"isClearable\":\"true\",
\"affectedTPList\":\"\"
}
}",
"customAttributes": [
{
"name": "Category",
"type": "",
"value": "category"
},
{
"name": "TestEventField",
"type": "",
"value": "Test Field Value"
},
{
"name": "SubCategory",
"type": "",
"value": "sub-category"
}
]
}
}
}
},
"_version": "5.0.0"
}
The following example shows a TCA AlarmCreateEvent payload generated by the TMF688 Event Processor microservice.
{
"_domain": "fault",
"@timestamp": "2024-08-07T08:29:59.407706554Z",
"_type": "event",
"_agents": [
{
"app": "tmf688-event-processor",
"output": "persistent://assure1/event/tmf688-event",
"node": "host.example.com",
"input": "persistent://assure1/event/canal",
"cluster": "cluster-2",
"@timestamp": "2024-08-07T08:29:59.407706554Z",
"host": "tmf688-event-processor-786455f486-9nhsz",
"id": "tmf688-event-processor-786455f486-9nhsz"
}
],
"message": {
"_type": "json",
"json": {
"eventId": "33",
"@type": "AlarmCreateEvent",
"eventTime": "2024-08-07T08:29:59.407Z",
"eventType": "AlarmCreateEvent",
"event": {
"alarm": {
"reportingSystemId": "host.example.com",
"alarmRaisedTime": "",
"alarmedObjectType": "OT_AID",
"CrossedThresholdInformation": {
"indicatorName": " TCA_UC05 LSNEXT_PKTS_ERROR : TWM_HIGH",
"granularity": "15min",
"observedValue": "-32768.0",
"direction": "up",
"indicatorUnit": ""
},
"@type": "OracleAlarm",
"alarmReportingTime": "2024-08-07T08:29:59.000Z",
"alarmedObject": {
"@referredType": "OT_AID",
"@type": "AlarmedObjectRef",
"name": "",
"id": "EMS_XDM_33/948"
},
"alarmEscalation": false,
"alarmChangedTime": "2024-08-07T08:29:59.000Z",
"perceivedSeverity": "minor",
"probableCause": "TCA_UC05 LSNEXT_PKTS_ERROR",
"affectedService": [],
"ackSystemId": "",
"id": "33",
"state": "raised",
"place": [],
"externalAlarmId": "3731539",
"parentAlarm": [
{
"@type": "AlarmRef",
"id": "0"
}
],
"isRootCause": false,
"ackUserId": "",
"serviceAffecting": false,
"ackState": "unacknowledged",
"alarmType": "qualityOfServiceAlarm",
"specificProblem": "TWM_HIGH",
"comment": [],
"alarmDetails":
"{
\"corba\":
{
\"neTime\":\"20230828114505.0\",
\"emsTime\":\"20230828114522.8\",
\"corbaEventType\":\"EMS_type\",
\"objectType\":\"OT_AID\",
\"unit\":\"\",
\"perceivedSeverity\":\"PS_MINOR\",
\"granularity\":\"15min\",
\"nativeEMSName\":\"DCC-Snk-8\",
\"layerRate\":\"1\",
\"objectName\":
{
\"ManagedElement\":\"EMS_XDM_33/948\",
\"EMS\":\"EMS_name\",
\"AID\":\"73:12295\"
},
\"eventTypeName\":\"NT_TCA\",
\"notificationId\":\"3731539\",
\"pmParameterName\":\"TCA_UC05 LSNEXT_PKTS_ERROR\",
\"pmLocation\":\"PML_NEAR_END_Rx\",
\"value\":\"-32768.0\",
\"thresholdType\":\"TWM_HIGH\",
\"isClearable\":\"true\"
}
}"
}
}
}
},
"_version": "5.0.0"
}
Sample AlarmAttributeValueChangeEvent Payload
The following example shows a fault alarm AlarmAttributeValueChangeEvent payload generated by the TMF688 Event Processor microservice. Note that the value for the eventType attribute is AlarmAttributeValueChangeEvent and the value for the alarm state attribute is updated.
{
"_domain": "fault",
"@timestamp": "2024-07-16T09:12:31.545130958Z",
"_type": "event",
"_agents": [
{
"app": "event-canal",
"output": "persistent://assure1/event/canal",
"input": "mysql:///Event",
"@timestamp": "2024-07-04T10:05:34.596550216Z",
"host": "host.example.com",
"id": "event-canal-1234"
},
{
"app": "tmf688-event-processor",
"output": "persistent://assure1/event/tmf688-event",
"input": "persistent://assure1/event/canal",
"@timestamp": "2024-07-16T09:12:31.545130958Z",
"host": "host.example.com",
"id": "tmf688-event-processor-1234"
}
],
"message": {
"_type": "json",
"json": {
"eventId": "421044",
"@type": "AlarmAttributeValueChangeEvent",
"eventTime": "2024-07-16T09:12:31.544Z",
"eventType": "AlarmAttributeValueChangeEvent",
"event": {
"alarm": {
"reportingSystemId": "host.example.com",
"alarmRaisedTime": "",
"alarmedObjectType": "",
"@type": "OracleAlarm",
"alarmReportingTime": "2024-06-19T05:41:02.000Z",
"alarmedObject": {
"@referredType": "",
"@type": "AlarmedObjectRef",
"name": "",
"id": "node1/51118:subnode1/51118"
},
"alarmEscalation": true,
"alarmChangedTime": "2024-06-19T09:45:26.495Z",
"perceivedSeverity": "major",
"probableCause": "ALARM_UC05 Ext-Alm2(Battery Discharge)",
"affectedService": [
{
"@type": "ServiceRef",
"id": "OT_EQUIPMENT"
}
],
"ackSystemId": "",
"id": "421044",
"state": "updated",
"place": [
{
"@type": "RelatedPlace",
"name": ""
}
],
"externalAlarmId": "3743573",
"parentAlarm": [
{
"@type": "AlarmRef",
"id": "0"
}
],
"isRootCause": false,
"ackUserId": "",
"serviceAffecting": false,
"ackState": "unacknowledged",
"alarmType": "processingErrorAlarm",
"specificProblem": "",
"comment": [
{
"@type": "Comment",
"comment": "Manual: Event List Edit (API)"
}
],
"alarmDetails":
"{
\"corba\":
{
\"rcaiIndicator\":\"false\",
\"probableCauseQualifier\":\"51118@@0@@--1@@357\",
\"serviceAffecting\":\"SA_NON_SERVICE_AFFECTING\",
\"additionalText\":\"No Info\",
\"neTime\":\"20230828123441.0\",
\"emsTime\":\"20230828123505.8\",
\"corbaEventType\":\"VENDOR\",
\"objectType\":\"OT_EQUIPMENT\",
\"perceivedSeverity\":\"PS_CRITICAL\",
\"probableCause\":\"ENV\",
\"nativeEMSName\":\"External Alarm Unit\",
\"layerRate\":\"0\",
\"nativeProbableCause\":\"ALARM_UC05 Ext-Alm2(Battery Discharge)\",
\"additionalInfo\":
{
\"LSNExt_GroupName\":\"ExampleEMS\",
\"LSNExt_MEName\":\"ExampleEMSName\",
\"LSNExt_ALCV\":\"Unknown\",
\"LSNExt_AckStatus\":\"ALM_UNACKNOWLEDGED\",
\"LSNExt_AlarmUniqueString\":\"EMS DN=node1, EMS notifId=2949292, CAM ID=393\"
},
\"objectName\":
{
\"EquipmentHolder\":\"/shelf=1/slot=1\",
\"Equipment\":\"1\",
\"ManagedElement\":\"node1/51118\",
\"EMS\":\"ExampleEMS\"
},
\"notificationId\":\"3743573\",
\"isClearable\":\"true\",
\"affectedTPList\":\"\"
}
}",
"customAttributes": [
{
"name": "TestEventField",
"type": "",
"value": "Test Field Value"
}
]
}
}
}
},
"_version": "5.0.0"
}
The following example shows a TCA AlarmAttributeValueChangeEvent payload generated by the TMF688 Event Processor microservice.
{
"_domain": "fault",
"@timestamp": "2024-08-07T08:30:25.347989614Z",
"_type": "event",
"_agents": [
{
"app": "tmf688-event-processor",
"output": "persistent://assure1/event/tmf688-event",
"node": "host.example.com",
"input": "persistent://assure1/event/canal",
"cluster": "cluster-2",
"@timestamp": "2024-08-07T08:30:25.347989614Z",
"host": "tmf688-event-processor-786455f486-9nhsz",
"id": "tmf688-event-processor-786455f486-9nhsz"
}
],
"message": {
"_type": "json",
"json": {
"eventId": "33",
"@type": "AlarmAttributeValueChangeEvent",
"eventTime": "2024-08-07T08:30:25.347Z",
"eventType": "AlarmAttributeValueChangeEvent",
"event": {
"alarm": {
"reportingSystemId": "host.example.com",
"alarmRaisedTime": "",
"alarmedObjectType": "OT_AID",
"CrossedThresholdInformation": {
"indicatorName": " TCA_UC05 LSNEXT_PKTS_ERROR : TWM_HIGH",
"granularity": "15min",
"observedValue": "-32768.0",
"direction": "up",
"indicatorUnit": ""
},
"@type": "OracleAlarm",
"alarmReportingTime": "2024-08-07T08:29:59.000Z",
"alarmedObject": {
"@referredType": "OT_AID",
"@type": "AlarmedObjectRef",
"name": "",
"id": "EMS_XDM_33/948"
},
"alarmEscalation": false,
"alarmChangedTime": "2024-08-07T08:30:25.000Z",
"perceivedSeverity": "minor",
"probableCause": "TCA_UC05 LSNEXT_PKTS_ERROR",
"affectedService": [],
"ackSystemId": "",
"id": "33",
"state": "updated",
"place": [],
"externalAlarmId": "3731539",
"parentAlarm": [
{
"@type": "AlarmRef",
"id": "0"
}
],
"isRootCause": false,
"ackUserId": "",
"serviceAffecting": false,
"ackState": "unacknowledged",
"alarmType": "qualityOfServiceAlarm",
"specificProblem": "TWM_HIGH",
"comment": [],
"alarmDetails":
"{
\"corba\":
{
\"neTime\":\"20230828114505.0\",
\"emsTime\":\"20230828114522.8\",
\"corbaEventType\":\"EMS_type\",
\"objectType\":\"OT_AID\",
\"unit\":\"\",
\"perceivedSeverity\":\"PS_MINOR\",
\"granularity\":\"15min\",
\"nativeEMSName\":\"DCC-Snk-8\",
\"layerRate\":\"1\",
\"objectName\":
{
\"ManagedElement\":\"EMS_XDM_33/948\",
\"EMS\":\"EMS_name\",
\"AID\":\"73:12295\"
},
\"eventTypeName\":\"NT_TCA\",
\"notificationId\":\"3731539\",
\"pmParameterName\":\"TCA_UC05 LSNEXT_PKTS_ERROR\",
\"pmLocation\":\"PML_NEAR_END_Rx\",
\"value\":\"-32768.0\",
\"thresholdType\":\"TWM_HIGH\",
\"isClearable\":\"true\"
}
}"
}
}
}
},
"_version": "5.0.0"
}
Sample ClearAlarmCreateEvent Payloads
The following example shows a fault alarm ClearAlarmCreateEvent payload generated by the TMF688 Event Processor microservice. Note that the value for the eventType attribute is ClearAlarmCreateEvent and the event contains the clearAlarm schema.
{
"_domain": "fault",
"@timestamp": "2024-08-08T10:10:06.673955721Z",
"_type": "event",
"_agents": [
{
"app": "tmf688-event-processor",
"output": "persistent://assure1/event/tmf688-event",
"node": "host.example.com",
"input": "persistent://assure1/event/canal",
"cluster": "cluster-2",
"@timestamp": "2024-08-08T10:10:06.673955721Z",
"host": "tmf688-event-processor-786455f486-9nhsz",
"id": "tmf688-event-processor-786455f486-9nhsz"
}
],
"message": {
"_type": "json",
"json": {
"eventId": "35",
"@type": "ClearAlarmCreateEvent",
"eventTime": "2024-08-08T10:10:06.673Z",
"eventType": "ClearAlarmCreateEvent",
"event": {
"clearAlarm": {
"alarmClearedTime": "2024-08-08T10:09:25.000Z",
"clearUserId": "admin",
"alarmPattern": [
{
"@type": "AlarmRef",
"id": "35"
}
],
"@type": "ClearAlarm",
"clearedAlarm": [
{
"reportingSystemId": "host.example.com",
"alarmRaisedTime": "",
"alarmedObjectType": "OT_PHYSICAL_TERMINATION_POINT",
"@type": "OracleAlarm",
"alarmReportingTime": "2024-08-08T10:08:35.000Z",
"alarmedObject": {
"@referredType": "OT_PHYSICAL_TERMINATION_POINT",
"@type": "AlarmedObjectRef",
"name": "",
"id": "EMS_BG-40_81/136:/shelf=1/slot=9/ebtype=TMSE1_8/port=1"
},
"alarmEscalation": false,
"alarmChangedTime": "2024-08-08T10:10:06.648Z",
"perceivedSeverity": "cleared",
"probableCause": "UNIDENTIFIED",
"affectedService": [],
"ackSystemId": "",
"id": "35",
"state": "cleared",
"place": [],
"externalAlarmId": "3745195",
"parentAlarm": [
{
"@type": "AlarmRef",
"id": "0"
}
],
"isRootCause": false,
"ackUserId": "",
"serviceAffecting": false,
"ackState": "unacknowledged",
"alarmType": "processingErrorAlarm",
"specificProblem": "ALARM_UC01 Communication-Fail",
"comment": [
{
"@type": "Comment",
"comment": "SQL Tool: Clear"
}
],
"alarmDetails": "{
\"corba\":
{
\"rcaiIndicator\":\"false\",
\"probableCauseQualifier\":\"13625@@8@@-1@@148@@0@@19@@0@@658\",
\"serviceAffecting\":\"SA_UNKNOWN\",
\"additionalText\":\"No Info\",
\"neTime\":\"20230828130321.0\",
\"emsTime\":\"20230828130343.8\",
\"corbaEventType\":\"EMS\",
\"objectType\":\"OT_PHYSICAL_TERMINATION_POINT\",
\"perceivedSeverity\":\"PS_CRITICAL\",
\"probableCause\":\"UNIDENTIFIED\",
\"nativeEMSName\":\"EMS_name\",
\"layerRate\":\"0\",
\"nativeProbableCause\":\"ALARM_UC01 Communication-Fail\",
\"additionalInfo\":
{
\"LSNExt_GroupName\":\"GGN NEs\",
\"LSNExt_MEName\":\"MAIN1\",
\"LSNExt_ALCV\":\"Unknown\",
\"LSNExt_AckStatus\":\"ALM_UNACKNOWLEDGED\",
\"LSNExt_AssignedPortLabel\":\"E1 port 1\",
\"LSNExt_AlarmUniqueString\":\"EMS DN=EMS_BG-40_8, EMS notifId=295, CAM ID=394\"
},
\"objectName\":
{
\"ManagedElement\":\"EMS_BG-40_8/13625\",
\"EMS\":\"EMS_example\",
\"PTP\":\"/shelf=1/slot=9/ebtype=TMSE1_8/port=1\"
},
\"eventTypeName\":\"NT_ALARM\",
\"notificationId\":\"3745195\",
\"isClearable\":\"true\",
\"affectedTPList\":\"\"
}
}"
}
],
"state": "done",
"clearSystemId": "host.example.com"
}
}
}
},
"_version": "5.0.0"
}
The following example shows a TCA ClearAlarmCreateEvent payload generated by the TMF688 Event Processor microservice.
{
"_domain": "fault",
"@timestamp": "2024-08-07T08:31:04.767622531Z",
"_type": "event",
"_agents": [
{
"app": "tmf688-event-processor",
"output": "persistent://assure1/event/tmf688-event",
"node": "host.example.com",
"input": "persistent://assure1/event/canal",
"cluster": "cluster-2",
"@timestamp": "2024-08-07T08:31:04.767622531Z",
"host": "tmf688-event-processor-786455f486-9nhsz",
"id": "tmf688-event-processor-786455f486-9nhsz"
}
],
"message": {
"_type": "json",
"json": {
"eventId": "33",
"@type": "ClearAlarmCreateEvent",
"eventTime": "2024-08-07T08:31:04.767Z",
"eventType": "ClearAlarmCreateEvent",
"event": {
"clearAlarm": {
"alarmClearedTime": "2024-08-07T08:30:25.000Z",
"clearUserId": "admin",
"alarmPattern": [
{
"@type": "AlarmRef",
"id": "33"
}
],
"@type": "ClearAlarm",
"clearedAlarm": [
{
"reportingSystemId": "host.example.com",
"alarmRaisedTime": "",
"alarmedObjectType": "OT_AID",
"CrossedThresholdInformation": {
"indicatorName": " TCA_UC05 LSNEXT_PKTS_ERROR : TWM_HIGH",
"granularity": "15min",
"observedValue": "-32768.0",
"direction": "up",
"indicatorUnit": ""
},
"@type": "OracleAlarm",
"alarmReportingTime": "2024-08-07T08:29:59.000Z",
"alarmedObject": {
"@referredType": "OT_AID",
"@type": "AlarmedObjectRef",
"name": "",
"id": "EMS_XDM_33/948"
},
"alarmEscalation": false,
"alarmChangedTime": "2024-08-07T08:31:04.742Z",
"perceivedSeverity": "cleared",
"probableCause": "TCA_UC05 LSNEXT_PKTS_ERROR",
"affectedService": [],
"ackSystemId": "",
"id": "33",
"state": "cleared",
"place": [],
"externalAlarmId": "3731539",
"parentAlarm": [
{
"@type": "AlarmRef",
"id": "0"
}
],
"isRootCause": false,
"ackUserId": "",
"serviceAffecting": false,
"ackState": "unacknowledged",
"alarmType": "qualityOfServiceAlarm",
"specificProblem": "TWM_HIGH",
"comment": [
{
"@type": "Comment",
"comment": "SQL Tool: Clear"
}
],
"alarmDetails":
"{
\"corba\":
{
\"neTime\":\"20230828114505.0\",
\"emsTime\":\"20230828114522.8\",
\"corbaEventType\":\"EMS_type\",
\"objectType\":\"OT_AID\",
\"unit\":\"\",
\"perceivedSeverity\":\"PS_MINOR\",
\"granularity\":\"15min\",
\"nativeEMSName\":\"DCC-Snk-8\",
\"layerRate\":\"1\",
\"objectName\":
{
\"ManagedElement\":\"EMS_XDM_33/948\",
\"EMS\":\"EMS_name\",
\"AID\":\"73:12295\"
},
\"eventTypeName\":\"NT_TCA\",
\"notificationId\":\"3731539\",
\"pmParameterName\":\"TCA_UC05 LSNEXT_PKTS_ERROR\",
\"pmLocation\":\"PML_NEAR_END_Rx\",
\"value\":\"-32768.0\",
\"thresholdType\":\"TWM_HIGH\",
\"isClearable\":\"true\"
}
}"
}
],
"state": "done",
"clearSystemId": "host.example.com"
}
}
}
},
"_version": "5.0.0"
}
Sample AlarmDeleteEvent Payload
The following example shows a fault alarm AlarmDeleteEvent payload generated by the TMF688 Event Processor microservice. Note that the value for the eventType attribute is AlarmDeleteEvent and the comment is DeleteExpired.
{
"_domain": "fault",
"@timestamp": "2024-07-16T12:14:22.845949554Z",
"_type": "event",
"_agents": [
{
"app": "event-canal",
"output": "persistent://assure1/event/canal",
"input": "mysql:///Event",
"@timestamp": "2024-07-04T10:05:34.596550216Z",
"host": "host.example.com",
"id": "event-canal-1234"
},
{
"app": "tmf688-event-processor",
"output": "persistent://assure1/event/tmf688-event",
"input": "persistent://assure1/event/canal",
"@timestamp": "2024-07-16T12:14:22.845949554Z",
"host": "host.example.com",
"id": "tmf688-event-processor-1234"
}
],
"message": {
"_type": "json",
"json": {
"eventId": "421044",
"@type": "AlarmDeleteEvent",
"eventTime": "2024-07-16T12:14:22.845Z",
"eventType": "AlarmDeleteEvent",
"event": {
"alarm": {
"reportingSystemId": "host.example.com",
"alarmRaisedTime": "",
"alarmedObjectType": "",
"@type": "Alarm",
"alarmReportingTime": "2024-06-19T05:41:02.000Z",
"alarmedObject": {
"@referredType": "",
"@type": "AlarmedObjectRef",
"name": "",
"id": "node1/51118:subnode1/51118"
},
"alarmEscalation": true,
"alarmChangedTime": "2024-06-19T09:45:26.495Z",
"perceivedSeverity": "major",
"probableCause": "ALARM_UC05 Ext-Alm2(Battery Discharge)",
"affectedService": [
{
"@type": "ServiceRef",
"id": "OT_EQUIPMENT"
}
],
"ackSystemId": "",
"id": "421044",
"state": "",
"place": [
{
"@type": "RelatedPlace",
"name": ""
}
],
"externalAlarmId": "3743573",
"parentAlarm": [
{
"@type": "AlarmRef",
"id": "0"
}
],
"isRootCause": false,
"ackUserId": "",
"serviceAffecting": false,
"ackState": "unacknowledged",
"alarmType": "processingErrorAlarm",
"specificProblem": "",
"comment": [
{
"@type": "Comment",
"comment": "DeleteExpired"
}
],
"alarmDetails":
"{
\"corba\":
{
\"rcaiIndicator\":\"false\",
\"probableCauseQualifier\":\"51118@@0@@--1@@357\",
\"serviceAffecting\":\"SA_NON_SERVICE_AFFECTING\",
\"additionalText\":\"No Info\",
\"neTime\":\"20230828123441.0\",
\"emsTime\":\"20230828123505.8\",
\"corbaEventType\":\"VENDOR\",
\"objectType\":\"OT_EQUIPMENT\",
\"perceivedSeverity\":\"PS_CRITICAL\",
\"probableCause\":\"ENV\",
\"nativeEMSName\":\"External Alarm Unit\",
\"layerRate\":\"0\",
\"nativeProbableCause\":\"ALARM_UC05 Ext-Alm2(Battery Discharge)\",
\"additionalInfo\":
{\
"LSNExt_GroupName\":\"ExampleEMS\",
\"LSNExt_MEName\":\"ExampleEMSName\",
\"LSNExt_ALCV\":\"Unknown\",
\"LSNExt_AckStatus\":\"ALM_UNACKNOWLEDGED\",
\"LSNExt_AlarmUniqueString\":\"EMS DN=node1, EMS notifId=2949292, CAM ID=3939953\"
},
\"objectName\":
{
\"EquipmentHolder\":\"/shelf=1/slot=1\",
\"Equipment\":\"1\",
\"ManagedElement\":\"node1/51118\",
\"EMS\":\"ExampleEMS"},
\"notificationId\":\"3743573\",
\"isClearable\":\"true\",
\"affectedTPList\":\"\"
}
}"
}
}
}
},
"_version": "5.0.0"
}
The following example shows a TCA AlarmDeleteEvent payload generated by the TMF688 Event Processor microservice.
{
"_domain": "fault",
"@timestamp": "2024-08-07T08:33:01.613636323Z",
"_type": "event",
"_agents": [
{
"app": "tmf688-event-processor",
"output": "persistent://assure1/event/tmf688-event",
"node": "host.example.com",
"input": "persistent://assure1/event/canal",
"cluster": "cluster-2",
"@timestamp": "2024-08-07T08:33:01.613636323Z",
"host": "tmf688-event-processor-786455f486-9nhsz",
"id": "tmf688-event-processor-786455f486-9nhsz"
}
],
"message": {
"_type": "json",
"json": {
"eventId": "33",
"@type": "AlarmDeleteEvent",
"eventTime": "2024-08-07T08:33:01.613Z",
"eventType": "AlarmDeleteEvent",
"event": {
"alarm": {
"reportingSystemId": "host.example.com",
"alarmRaisedTime": "",
"alarmedObjectType": "OT_AID",
"CrossedThresholdInformation": {
"indicatorName": " TCA_UC05 LSNEXT_PKTS_ERROR : TWM_HIGH",
"granularity": "15min",
"observedValue": "-32768.0",
"direction": "up",
"indicatorUnit": ""
},
"@type": "Alarm",
"alarmReportingTime": "2024-08-07T08:29:59.000Z",
"alarmedObject": {
"@referredType": "OT_AID",
"@type": "AlarmedObjectRef",
"name": "",
"id": "EMS_XDM_33/948"
},
"alarmEscalation": false,
"alarmChangedTime": "2024-08-07T08:33:01.567Z",
"perceivedSeverity": "cleared",
"probableCause": "TCA_UC05 LSNEXT_PKTS_ERROR",
"affectedService": [],
"ackSystemId": "",
"id": "33",
"state": "",
"place": [],
"externalAlarmId": "3731539",
"parentAlarm": [
{
"@type": "AlarmRef",
"id": "0"
}
],
"isRootCause": false,
"ackUserId": "",
"serviceAffecting": false,
"ackState": "unacknowledged",
"alarmType": "qualityOfServiceAlarm",
"specificProblem": "TWM_HIGH",
"comment": [
{
"@type": "Comment",
"comment": "DeleteExpired"
}
],
"alarmDetails":
"{
\"corba\":
{
\"neTime\":\"20230828114505.0\",
\"emsTime\":\"20230828114522.8\",
\"corbaEventType\":\"VENDOR\",
\"objectType\":\"OT_AID\",
\"unit\":\"\",
\"perceivedSeverity\":\"PS_MINOR\",
\"granularity\":\"15min\",
\"nativeEMSName\":\"I11-ETY-SnA-DCC-Snk-8\",
\"layerRate\":\"1\",
\"objectName\":
{
\"ManagedElement\":\"EMS_XDM_33/948\",
\"EMS\":\"EMS_name\",
\"AID\":\"73:12295\"
},
\"eventTypeName\":\"NT_TCA\",
\"notificationId\":\"3731539\",
\"pmParameterName\":\"TCA_UC05 LSNEXT_PKTS_ERROR\",
\"pmLocation\":\"PML_NEAR_END_Rx\",
\"value\":\"-32768.0\",
\"thresholdType\":\"TWM_HIGH\",
\"isClearable\":\"true\"
}
}"
}
}
}
},
"_version": "5.0.0"
}