Following is the
VMware Telco Cloud Service Assurance event data model and the corresponding UI validation schema:
Event Model | UI Validation Schema |
---|---|
{ "Source": "<String>", "Name": "<String>", "InstanceName": "<String>", "State": "<String>", "Severity": "<String>", "ProcessedTimeStamp": "<Long>", "Timestamp": "<Long>", "DisplayName": "<String>", "EventDisplayName": "<String>", "ClassName": "<String>", "ClassDisplayName": "<String>", "InstanceDisplayName": "<String>", "ElementClassName": "<String>", "ElementName": "<String>", "EventName": "<String>", "EventState": "<String>", "EventText": "<String>", "EventType": "<String>", "Acknowledged": "<String>", "Active": "<String>", "Category": "<String>", "Certainty": "<String>", "ClearOnAcknowledge": "<String>", "Impact": "<String>", "InMaintenance": "<String>", "IsProblem": "<String>", "IsRoot": "<String>", "PollingID": "<Long>", "PollingState": "<String>", "SourceDomainName": "<String>", "SourceEventType": "<String>", "SourceInfo": "<String>", "SourceSpecific": "<String>", "TroubleTicketID": "<String>", "Owner": "<String>", "ToolInfo": "<String>", "OccurrenceCount": "<Long>", "FirstNotifiedAt": "<Long>", "LastChangedAt": "<Long>", "LastNotifiedAt": "<Long>", "LastClearedAt": "<Long>", "AcknowledgmentTime": "<Long>", "tags":{ "<String>":"<String>" }, "properties":{ "<String>":"<String>" } } |
{ "Source":{ "type":"string" }, "InstanceName":{ "type":"string" }, "Timestamp":{ "type":"string" }, "ProcessedTimeStamp":{ "type":"string" }, "Name":{ "type":"string" }, "State":{ "type":"string" }, "Severity":{ "type":"string" } } |
Following table lists the JSON definition table for the standard parameters within each event:
Field | Context | Format | Description |
---|---|---|---|
Acknowledged | All | String | Indicates if this event has been acknowledged. |
AcknowledgmentTime | All | Long | The time in epoch milliseconds, when this Notification was acknowledged. A time of '0' means that the Notification has not been acknowledged. |
Active | All | String | Indicates if this event is ACTIVE currently. |
Category | All | String | Category of this event. The event category represents a broad categorization of the event, e.g. availability vs. performance. |
Certainty | All | String | The certainty of this event. |
ClassDisplayName | All | String | Display name for the event class. |
ClassName | All | String | Class name of the object where this event occurred. This attribute along with InstanceName and EventName uniquely identify this event. |
ClearOnAcknowledge | All | String | Indicates if this event should be cleared when it is acknowledged. Set this to TRUE only for events that do not expire nor have sources that generate a clear. |
DisplayName | All | String | The string shown in the UI when this Event's name is displayed. |
ElementClassName | All | String | The class name of the topology element associated with the event in the repository where this event resides. This may or may not have the same value as ClassName. |
ElementName | All | String | The name of the topology element associated with the event in the repository where this event resides. This may or may not have the same value as InstanceName. The string is empty if there is no related element. |
EventDisplayName | All | String | Display name for the event Name. |
EventName | All | String | Name of the event. This attribute along with ClassName and InstanceName uniquely identify this event. |
EventState | All | String | The current state of this event. ACTIVE: The event is currently active. WAS_ACTIVE: The event was active, but we lost contact with the event source. INACTIVE: The event is inactive. UNINITIALIZED: The event has not been notified yet; the object does not yet represent a notified event. |
EventText | All | String | The textual representation or description of the event. |
EventType | All | String | Indicates the nature of the event. A MOMENTARY event has no duration. An authentication failure is a good example. A DURABLE event has a period during which the event is active and after which the event is no longer active. An example of a durable event is a link failure. |
FirstNotifiedAt | All | Long | First event notification time in epoch milliseconds. |
Impact | All | String | A quantification of the impact of this event on the infrastructure and/or business processes. There are no pre-defined semantics to the value of this attribute other than a larger numeric value indicates a larger impact. |
InMaintenance | All | String | Did this event occur during maintenance? |
InstanceDisplayName | All | String | Display name for the event instance. |
InstanceName | All | String | Instance name of the object where this event occurred. This attribute along with ClassName and EventName uniquely identify this event. |
IsProblem | All | String | A notification is a problem when all of the original event types are 'PROBLEM' or 'UNKNOWN'. There must be at least one 'PROBLEM', i.e. 'UNKNOWN' by itself is not a problem. |
IsRoot | All | String | Indicates if this event is a root cause event. |
LastChangedAt | All | Long | Time in epoch milliseconds of last event change. |
LastClearedAt | All | Long | Last clear time in epoch milliseconds. |
LastNotifiedAt | All | Long | Last notification time in epoch milliseconds. |
Name | All | String | Name of Event |
OccurrenceCount | All | Long | The number of occurrences of this event starting from FirstNotifiedAt until LastNotifiedAt. |
Owner | All | String | The name of the user that is responsible for handling this event. |
PollingID | All | String | ID assigned in case the event is part of polling batch from the underlying source. |
PollingState | All | String | State assigned to differentiate, if the event is part of polling batch or subscription. |
ProcessedTimeStamp | All | Long | Timestamp in epoch milliseconds when the event from the underlying source was processed. |
Properties | All | Object | JSON Object or HashMap with flexible key value pairs of type String, that represents the property names and its corresponding values. |
Severity | All | String | An enumerated value that describes the severity of the event from the notifier's point of view: 1 - Critical is used to indicate action is needed NOW and the scope is broad, e.g. an outage to a critical resource. 2 - Major is used to indicate action is needed NOW. 3 - Minor should be used to indicate action is needed, but the situation is not serious at this time. 4 - Unknown indicates that the element is unreachable, disconnected or in an otherwise unknown state. 5 - Normal is used when an event is purely informational. |
Source | All | String | The name(s) of the domain(s)or domainGroups that have originally diagnosed and notified - directly or indirectly - current occurrences of this event. If there are more than one original domain, the attribute lists each separated by a comma. When the notification is cleared, the last clearing domain stays in the value. |
SourceDomainName | All | String | The name(s) of the domain(s)or domainGroups that have originally diagnosed and notified - directly or indirectly - current occurrences of this event. If there are more than one original domain, the attribute lists each separated by a comma. When the notification is cleared, the last clearing domain stays in the value. |
SourceEventType | All | String | The type(s) of the events(s), i.e. 'PROBLEM', 'EVENT', 'AGGREGATE' in the source domains that have notified current occurrences of this event. If there is more than one domain the attribute lists each separated by a comma, in the same order as SourceDomainName. |
SourceInfo | All | String | This table maps an original source to corresponding immediate sources.It also maintains domain groups corresponding to immediate sources. |
SourceSpecific | All | String | This indicates additional information related to the events source. |
State | All | String | The current state of this event. ACTIVE: The event is currently active. WAS_ACTIVE: The event was active, but we lost contact with the event source. INACTIVE: The event is inactive. UNINITIALIZED: The event has not been notified yet; the object does not yet represent a notified event. |
Tags | All | Object | JSON Object or HashMap with flexible key value pairs of type String, that represents the tag names and its corresponding values. |
Timestamp | All | Long | Timestamp in epoch milliseconds when the event was notified to the source. |
ToolInfo | All | String | Place holder for data related to other tools. |
TroubleTicketID | All | String | Trouble ticket ID |