5.323 Fields: Events

See the associated Events resource section for more information on how to use this resource and supported operations.

Additional references

Type	Value	Additional information
Permissions resource	events	Permissions
Hooks filename	events.groovy	Pre- and Post-Processing Hooks
Distinct query-supported	Yes	Distinct

API version 3

Event

Represents an event originating from any component in the system (MWM, MWS, MAM, etc). Events are related to, but not the same as, Notifications. See NotificationCondition for an explanation of when to use an event vs a notification.

Field Name	Type	POST	Description
id	String	No	The unique ID for this event
arguments	List<String>	Yes	The event's arguments
associatedObjects	Set<AssociatedObject>	Yes	Objects relating to the event
code	int	Yes	This is a positive, 32-bit numeric value. Source code that needs to take action on events based on which event (error) occurred can switch based on this value. The top 16 bits are determined by the severity of the event and the component that emits it. The bottom 16 bits are assigned by any arbitrary mechanism convenient to a component. Each component thus has 64k unique event codes that it can assign. Once assigned, event codes are immutable; it can never be the case that error 12345 means one thing in release A, and a different thing in release B.
eventDate	Date	Yes	The date and time the event occurred, not the date and time MWS received the event. It is up to the reporting component to report this time accurately. Required during POST.
eventType	String	Yes	Signifies what type of event. Cannot contain single quotes(') or double quotes(").
message	String	Yes	A summary of what happened that caused this event
origin	String	Yes	The origin of this event. Cannot contain single quotes(') or double quotes(").
severity	EventSeverity	Yes	Signifies the severity of an event.
tenant	Map<String, String>	No	The event's tenant (contains tenant id and name)

AssociatedObject

Represents and uniquely identifies an object associated with an event. (e.g node, job, reservation, trigger)

Field Name	Type	POST	Description
id	String	Yes	The object id (e.g. reservation.1, job.21, vm3). Cannot contain single quotes(') or double quotes(").
type	String	Yes	The type of object (e.g. node, job, reservation). Cannot contain single quotes(') or double quotes(").

EventSeverity

Value	Description
INFO
WARN
ERROR
FATAL

API version 2

EventVersion2

Field Name	Type	POST	Description
id	String	No	The unique ID for this event
details	Map<String, Map>	Yes	A map where detail name maps to detail value. (e.g. "sourceHypervisor" => "blade256", "destinationHypervisor" => "blade257", "os" => "centos-6.5-stateless)
errorMessage	ErrorMessageVersion2	Yes	Details about any errors associated with the event. If this event was not associated with any errors this field will be null
eventCategory	String	Yes	Signifies what category of event.
eventTime	Date	Yes	The time the event occurred, not the time MWS received the event. It is up to the reporting component to report this time accurately. Corresponds to eventDate in API Version 3. Required during POST.
eventType	String	Yes	Signifies what type of event.
facility	String	Yes	A categorization of how this event fits in with other events.
initiatedBy	UserDetailsVersion2	Yes	Details about the user that initiated this event
primaryObject	MoabObjectVersion2	Yes	Most events will have a "primary object" associated with it. An event can have at most ONE primary object. For example, a JobStart event will have a primary job object, so the type would be "job" and the object ID would be the ID of the job. Primary objects are, however, optional, depending on the type of event. For example, a "SchedulerCommand" event does not have a primary object.
relatedObjects	Set<MoabObjectVersion2>	Yes	Objects relating to the event that are not the primary object. Corresponds to associatedObjects in API Version 3.
severity	String	Yes	Signifies the severity of an event. Severity can be "FATAL", "ERROR", "WARN", "INFO"
sourceComponent	String	Yes	What Adaptive Computing component reported this event. Examples: "MWM", "MWS", "MAM", etc. Corresponds to origin in API Version 3.
status	String	Yes	The status of the reported event.

ErrorMessageVersion2

Field Name	Type	POST	Description
errorCode	String	Yes	The original error code generated or detected by the originator.
message	String	Yes	If an event has a status of "failure" or other non-successful operation, this field should provide a human-friendly error message Corresponds to Event.message in API Version 3 and above.
originator	String	Yes	The software component or entity that generated or detected the error (e.g. Moab, Torque, MWS, Viewpoint, RM, Database, etc).

UserDetailsVersion2

Field Name	Type	POST	Description
proxyUser	String	Yes	The proxy user that initiated the event.
user	String	Yes	The user that initiated the event.

MoabObjectVersion2

Field Name	Type	POST	Description
id	String	Yes	The moab object id (e.g. reservation.1, job.21, vm3)
serialization	String	Yes	A serialized representation of the object
type	String	Yes	The moab object type (e.g. node, job, reservation)