Event Header

Owned by Stonebranch (Deactivated)
Jul 03, 2023
3 min read


The following table describes the fields in an event header.
 

Field Name

Description

eventCategory

Category of the event:

  • Availability (10)
    Deals with situations reported from the component regarding its operational state and availability.
  • Configuration (20)
    Deals with components identifying configuration changes.
  • Stop (30)
    Deals with the shutdown process for a component.
  • Start (40)
    Deals with the startup process for a component.
  • Network (50)
    Deals with situations related to network errors between components.
  • Exception (60)
    Some exception has occurred within the resource not covered by any other category.
  • Security (70)
    Some security issue has been detected.
  • Heartbeat (80)
    A component has been configured to send a heartbeat event.
  • Status (90)
    Some change of status that does not affect availability or capability of the component.
  • Log (100)
    A component has been configured to report log entries.
  • Diagnostic (110)
    A component has been configured to generate diagnostic events.

This category list is ordered by priority, from highest to lowest.

eventSeverity

Severity of the event with respect to the reporting component:

  • Fatal (10)
    A condition is unrecoverable and the service is no longer available.
  • Critical (20)
    A condition affecting the service has occurred. Immediate corrective action is required.
  • Major (30)
    A problem with relatively high severity has occurred. It is likely that normal use of the service is impeded.
  • Minor (40)
    A problem with relatively low severity has occurred. It is unlikely that normal use of the service is impeded.
  • Warning (50)
    A problem with the service may occur or may have occurred. Diagnostic and corrective action is recommended.
  • Informational (60)
    A message considered purely normal and expected.

This severity list is ordered by priority, from highest to lowest.

eventTopic

Type of object to which the event pertains. Event topic values are:

  • Job
    A process created by a Universal Agent component to perform work on behalf of a client request.
  • User
    A user identity associated with work performed by a Universal Agent component.
  • UACL
    A Universal Access Control List entry.
  • Component
    A Universal Agent component, which includes a manager or server component.
  • File
    A file resource in the O/S file system.
  • Event
    A Universal Event Monitor event resource.
  • Spool
    A Universal Agent spool database resource.
  • Command
    An O/S command, an O/S API, or a component script command.

eventType

Three-digit number that uniquely identifies the event class. Events of the same type represent a specific class of events.

eventUuid

Universally Unique Identifier of each event message generated on any system at any time.

recordedTime

UTC date and time that the event was recorded by the local Broker.

recordedTimeUsec

Microsecond portion of the TIME value.

reporterGroupUuid

Universally unique identifier of the work group of which the reporter is a member. If the reporterGroupUuid and the reporterObjectUuid are the same, the component is the work group leader.

reporterIpAddr

Host name of the component that generated the event. This is the host name as reported by the operating system, typically using the gethostname() function.

reporterName

Name of the component that generated the event:

  • UBROKER
  • UCMD-MANAGER
  • UCMD-SERVER
  • UDM-MANAGER
  • UDM-SERVER
  • UEM-MANAGER
  • UEM-SERVER
  • UEC
  • USAP
  • UCTL-MANAGER
  • UCTL-SERVER

reporterObjectUuid

Universally unique identifier of the object identified as the reporter of the event.

reporterParentUuid

Universally unique identifier of the parent component of the process that reported the event.

reporterSysId

Installation system identifier of the component that generated the event. The system identifier identifies a specific Universal Agent installation on a host system.

reporterUnitUuid

Universally unique identifier of the work unit of which the reporter is a member. If the reporterUnitUuid and the reporterObjectUuid are the same value, the component is the unit leader.

sourceGroupUuid

Universally unique identifier of the work group of which the source is a member. If the sourceGroupUuid and the sourceObjectUuid are the same, the component is the work group leader.

sourceIpAddr

Host name of the component that generated the event. This is the host name as reported by the operating system, typically using the gethostname() function.

sourceName

Name of the component that generated the event. Valid names include:

  • UBROKER
  • UCMD-MANAGER
  • UCMD-SERVER
  • UDM-MANAGER
  • UDM-SERVER
  • UEM-MANAGER
  • UEM-SERVER
  • UEC
  • USAP
  • UCTL-MANAGER
  • UCTL-SERVER

sourceObjectUuid

Universally unique Identifier of the object identified as the source of the event. The type of object is represented by the eventTopic.

sourceParentUuid

Universally unique identifier of the parent component of the process that generated the event.

sourceSysId

Installation system identifier of the component that generated the event. The system identifier identifies a specific Universal Agent installation on a host system.

sourceUnitUuid

Universally unique identifier of the work unit of which the source is a member. If the sourceUnitUuid and the sourceObjectUuid are the same value, the component is the unit leader.

timeZone

Time zone in which the event was generated. The value is the number of seconds between UTC and local time.

version

Numeric value that is incremented whenever the header changes (that is, changes to the header format or header fields).