Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updated docs re removed action_required property

...

Event Property

Description

Example

eventid (_id)

A globally unique Event ID

 

time

Unix time of the event (seconds since 1970).

1385076573

date

The event time in human readable format

2013-11-11T13:39:41

node

The name of the node in question. Normally the same as the NMIS node name.

 

host

The DNS hostname or IP address of the node in question, as extracted from the input data.
See section on Node vs. Host below for details.

 

event

Name of the event

Node Down, Node Up

element

What element of the node the event refers to. Optional.

FastEthernet1, Neighbor 1.2.4.5

state

Is the state good or bad, up or down.
Optional, but always present if stateful is present.

up/down, open/closed, etc

stateful

Name of the stateful object. Optional, but always present if state is present.

Node, Interface, OSPF Neighbor

details

Other event details

 

type

Where did the event originate?

cisco_syslog, trap, NMIS, (remote) API

escalate

Has the event been marked for escalation?
This is set if an action policy sets the event up for escalation,
and cleared once the event is acknowledged.

0 or 1
priorityopEvents priority level, see opEvents priority levels vs. NMIS and Syslog levels0 to 10

acknowledged

Has the event been acknowledged?

0 or 1

flap

Is this event a flap?

0 or 1

action_requiredShould the GUI show the event as open?
Only present in opEvents versions up to (and including) 2.0.3.
0 or 1

Optional but Common Properties

...

Event PropertyDescriptionExample
interface_descriptionThe ifAlias (or Description) of the interface in question
  • only available with opEvents versions 2.0 and newer,
  • only for interface-related stateful events (i.e. element is an interface), 
  • and only if the node was refreshed or imported from NMIS with opEvents  2.0 or newer
 
authorityThe server name of the system that originated the event;
Optional, only relevant for remotely/API-generated events.
 
locationThe URI for this event at the originating server.
Optional, only relevant for remotely/API-generated events.
 
duplicateoflist of Event IDs that this one is a duplicate of 
nodeslists nodes that caused this synthetic event 
eventidslist of Event IDs that were involved in causing this synthetic event.
In opEvents 2.0.3 and newer this is also set for relationships between events,
e.g. for auto-acknowledged events the up event lists the down event's id here and vice versa
 

delayedaction

Unix time, until then the event is held back from processing for actions and policies1385079231
action_checkedHas the event been processed wrt. actions and policies?0 or 1
<scriptname>.outputIf an event triggered a script action that is set to save,
then the script output is stored in this property.
 
syntheticwhether this event was created by a correlation policy action,
or because a watchdog expired
0 or 1
watchdogwhether this is a watchdog expiration event0 or 1
escalation_ageIf the event is or was subject to escalation, then this property indicates the
event's most recent escalation threshold. Note that this property is not cleared when
the event is acknowledged and escalation terminates.
60, 900 etc.
escalation_policyIf the event is or was subject to escalation, then this property lists the
event's most recently active escalation policy name.
Like the previous property, this one persists after escalation terminates.
 
notesa list of originator- and time-tagged comments for this event
(optional, supported in opEvents 2.0 and newer)
 
tag_<anything>These enrichment tags are controlled by your action policy, and have no special meaning
- with the exception of tag_kb_topic, which controls linking to online sources
(in opEvents 2.0.2 and up),
- and tag_servicePriority, which is shown with the event priority if present
(only in opEvents 2.0.4 and up)
 
status_historyA structured record of changes and activities related to the event. 

 

Node vs. Host, and how opEvents handles inconsistent input data

...