xit
Table of Contents |
---|
General
opEvents versions 2.0 and newer provide a REST-style API for limited event management, e.g. creation and retrieval of single events, and lookup of events.
This version also comes with a simple client (both source and compiled), /usr/local/omk/bin/create_remote_event.pl
(and .exe
).
...
The body of the request must be a valid JSON document, containing the desired event properties. See opEvents Normalised Event Properties for a description of all the properties. Some properties (e.g. date
, time
) can be omitted and will be filled in automatically. As an absolute minimum, a node
or a host
property, and an event
property must be present. If (and only if!) node
is not present, then opEvents looks up host
and attempts to find the canonical node for the hostname or IP address from the host
property - this heuristic is described in more detail here. The resulting node
must be known to opEvents and must not be disabled for opEvents.
...
Parameter | Description |
---|---|
o_start , o_end | Start and end of the period you are interested in. Note, you should pass o_summarise=1 to make sure UNIX time is not rounded. |
o_node_name | Name of the node you are interested in. You can use " regex:<regular expression> " or a plain text string. |
ev_event_name | Name of the event you are interested in. You can use " regex:<regular expression> " or a plain text string. |
ev_event_type | Type of the event, i.e. what source it came from. e.g: nmis_eventlog , api . |
ev_event_element | Element in question. Not present for all events. Regex or plain text string. |
| Details that were supplied with the event. Not present for all events. Regex or plain text string. |
...