Default language.

MonitorEvent event class


The MonitorEvent event class is a subclass of the EVENT base event class. The ALARM class, ANOMALY class, PATROL_EV class, and the HELIX_SM_EV classes are subclasses of this class. To understand the event class hierarchy and class inheritance, see Event-classification-and-formatting

This class includes all the common purpose slots that can be used across all the other subclasses. 

Similar slots are also available in other subclasses such as ALARM, PATROL_EV, and so on. While these old slots are still usable, we recommend that you instead use the common slots described in the following table.   

Hidden slots

The hidden slots are internal slots that must not be changed.

Slot

Slot display name

Type

Description

Hidden?

object 

Object

String

Subcomponent of the host to which the event is related.
For example, this slot could be the name of the disk on which the event is reporting the problem.

No

object_class 

Object Class

String

Class of an object. If the object class cannot be derived from the original event, it must be filled in during enrichment.

No

object_id 

Object ID

String

Combination of Agent uuid, monitor type, and instance name.

No

agent_name 

Monitor Agent Name

String

Name of the agent.

No

agent_port 

Monitor Agent Port

String

Port number of the agent.

No

agent_address 

Monitor Agent IPAddress

String

IP address of the agent host.

Yes

metric_name 

Metric

String

Name of the metric or parameter that triggered the event.

 

No

metric_value 

Parameter Value

String

Value of the metric or parameter.

No

metric_unit 

Metric Unit

String

Unit description of the metric or parameter.

No

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*