Performance and Fault Events and Definitions

3 Performance and Fault Events and Definitions

The Performance and Fault events provide an event-driven architecture for creating, updating, and deleting Alarms and Performance Threshold Violations on the devices that are maintained in the Topology model. The Performance and Fault events are listed as follows and are available as messages in the ora-fault-topology topic.

Table 3-1 Topology Events

Event	Definition
TopologyFaultEventCreate	This event supports the creation of a Fault (Alarm) on a Device, Port or Interface that is maintained in the Topology model.
TopologyFaultEventUpdate	This event supports updates of a Fault (Alarm) maintained in the Topology model.
TopologyPerformanceEventCreate	This event supports the creation of a Performance Threshold Violation on a Device, Port or Interface that is maintained in the Topology model.
TopologyPerformanceEventUpdate	This event supports updates of a Performance Threshold Violation on a Device, Port or Interface that is maintained in the Topology model.

TopologyFaultEventCreate

The following table provides the TopologyFaultEventCreate event details and the corresponding values:

Table 3-2 TopologyFaultEventCreate

Event Details	Value
Summary	Receives messages for creating Faults (Alarms) for devices, ports, and interfaces.
Message Header (with examples)	eventType: “TopologyFaultEventCreate” sourceSystemId: “XXX” (must be unique) transactionId: “xxx-topology-nnnnnn”
Topic	ora-fault-topology
Producer	Any Assurance System or Alarm Management System
Consumer	UTIA
URL	Provided during the deployment.
Schemas	Event

Example Payload:

{
        "eventType" : "TopologyFaultEventCreate",
        "message" : {
            "businessObjectClass" : "EventDAO",
            "eventDate" : "2023-01-19T03:32:17.235Z",
            "eventStatus" : "raised",
            "alarmType" : "deviceAlarm",
            "perceivedSeverity" : "major",
            "probableCause" : "port malfunction",
            "specificProblem" : "indeterminate",
            "sourceSystemID" : "tel.mad.mob.id_10_211_55_10",
            "alarmDetails" : "voltage=95",
            "referenceId" : 300040,
            "href" : "/alarmManagement/v4/alarm/300040",
            "relationships" : {
                "device" : 4949
            }
        }
}

Valid Relationships (for finding the device):

Table 3-3 Valid Relationships

Name	Definition
device	The entityId of the device
deviceId	The ID of the device
deviceIdentifier	The deviceIdentifier of the device
ipv4	The IPV4 address of the device, can also include zoneId to find the unique device.
name	The name of the device, can also include zoneId to find the unique device.

TopologyFaultEventUpdate

The following table provides the TopologyFaultEventUpdate event details and the corresponding values:

Table 3-4 TopologyFaultEventUpdate

Event Details	Value
Summary	Receives messages for updating Faults (Alarms) for devices, ports, and interfaces.
Message Header (with examples)	eventType: “TopologyFaultEventUpdate” sourceSystemId: “XXX” (must be unique) transactionId: “xxx-topology-nnnnnn”
Topic	ora-fault-topology
Producer	Any Assurance System or Alarm Management System
Consumer	UTIA
URL	Provided during the deployment.
Schemas	Event

Example Payload:

{
        "eventType" : "TopologyFaultEventUpdate",
        "message" : {
            "entityId" : "1369",
            "eventStatus" : "updated"
        }
}

Note:

The entityId is the entityId of the Event.

TopologyPerformanceEventCreate

The following table provides the TopologyPerformanceEventCreate event details and the corresponding values:

Table 3-5 TopologyPerformanceEventCreate

Event Details	Value
Summary	Receives messages for creating Performance Threshold violations for devices, ports, and interfaces.
Message Header (with examples)	eventType: “TopologyPerformanceEventCreate” sourceSystemId: “XXX” (must be unique) transactionId: “xxx-topology-nnnnnn”
Topic	ora-fault-topology
Producer	Any Assurance System or Alarm Management System
Consumer	UTIA
URL	Provided during the deployment.
Schemas	Event

Example Payload:

{
        "eventType" : "TopologyPerformanceEventCreate",
        "message" : {
            "businessObjectClass" : "EventDAO",
            "eventStatus" : "RAISED",
            "thresholdName" : "Latency High",
            "perceivedSeverity" : "MAJOR",
            "thresholdTypeName" : "Standard Threshold",
            "thresholdMessage" : "Performance threshold violation: Latency High",
            "sourceSystemID" : "tel.mad.mob.id_10_211_55_10",
            "measurement" : "metrictype_Interface_Latency_High",
            "thresholdSeverity" : 3,
            "thresholdTimeRange" : 900,
            "metricValue" : 85.240994544,
            "thresholdOperator" : ">=",
            "thresholdValue" : 50,
            "referenceId" : 300051,
            "href" : "/alarmManagement/v4/alarm/300051",
            "relationships" : {
                "device" : 5179
            }
        }
    }

Valid Relationships (for finding the device):

Table 3-6 Valid Relationships

Name	Definition
device	The entityId of the device
deviceId	The ID of the device
deviceIdentifier	The deviceIdentifier of the device
ipv4	The IPV4 address of the device, can also include zoneId to find the unique device.
name	The name of the device, can also include zoneId to find the unique device.

TopologyPerformanceEventUpdate

The following table provides the TopologyPerformanceEventUpdate event details and the corresponding values:

Table 3-7 TopologyPerformanceEventUpdate

Event Details	Value
Summary	Receives messages for updating Performance Threshold violations for devices, ports, and interfaces.
Message Header (with examples)	eventType: “TopologyPerformanceEventUpdate” sourceSystemId: “XXX” (must be unique) transactionId: “xxx-topology-nnnnnn”
Acknowledgement Strategy	Manual
Accepts	KafkaMessage<String, String>
Returns	java.util.concurrent.CompletionStage
Topic	ora-fault-topology
Producer	Any Assurance System or Alarm Management System
Consumer	UTIA
URL	Provided during the deployment.
Schemas	Event

Example Payload:

{
        "eventType" : "TopologyPerformanceEventUpdate",
        "message" : {
            "entityId" : "1373",
            "eventStatus" : "updated"
        }
}

Note:

The entityId is the entityId of the Event.