Table of Contents
...
Code Block | ||||
---|---|---|---|---|
| ||||
package Event_State_Example; our $VERSION="0.0.0"; use lib "/usr/local/omk/lib"; use strict; use OMK::Common; use OMK::opEvents; use OMK::Log; # arguments: the line (currently being parsed), # and reference to the live event properties # returns: (status-or-error) # # zero or undef: parsing for this event is aborted, # and no event is created. # 1: indicates success, event is created and changed event # properties are incorporated. # any other value: treated as error message, changed event # properties are NOT incorporated but event parsing continues. sub parse_enrich { my ($line, $event) = @_; my $confCommon = loadOmkConfTable(conf=> "opCommon", dir=> "/usr/local/omk/conf"); my $logger = OMK::Log->new(level => $confCommon->{"omkd_log_level"} || 'info', path => $confCommon->{'<omk_logs>'}."/opEvents.log"); my $OPE = OMK::opEvents->new(config => $confCommon, logprefix => "Plugin::Event_State_Example", log => $logger); $OPE->getDb(); $event->{Plugin_Used} = "Event_State_Example"; return 1; } |
opEvents 3.2.4 Changes
From 3.2.4 opEvents sends an opEvents objects so all the resources can be reused in the plugin.
Following changes should be applied in the plugin:
Code Block | ||||
---|---|---|---|---|
| ||||
package Event_State_Example;
our $VERSION="0.0.0";
use lib "/usr/local/omk/lib";
use strict;
use OMK::Common;
use OMK::opEvents;
use OMK::Log;
# arguments: the line (currently being parsed),
# and reference to the live event properties
# returns: (status-or-error)
#
# zero or undef: parsing for this event is aborted,
# and no event is created.
# 1: indicates success, event is created and changed event
# properties are incorporated.
# any other value: treated as error message, changed event
# properties are NOT incorporated but event parsing continues.
sub parse_enrich
{
my ($line, $event, $OPE) = @_;
$event->{Plugin_Used} = "Event_State_Example";
return 1;
}
|
Much more clean and simple!
Getting events: getEventLogsModel
...
Code Block | ||
---|---|---|
| ||
'_id' => $arg{id}, 'time' => { '$gte' => $time_start, '$lt' => $time_end }, 'event' => $arg{event}, 'node_uuid' => $arg{node_uuid}, 'type' => $arg{type}, 'element' => $arg{element}, 'details' => $arg{details}, 'eventid' => $arg{event_id}, # only useful in actionlog 'action' => $arg{action}, # only useful in actionlog 'archive' => $arg{archive}, # only useful in archive log 'entry' => $arg{entry}, # only in raw log 'state' => $arg{state}, 'nodeinfo.configuration.location' => {'$regex' => $arg{'nodeinfo.configuration_location'} || $arg{location}}, 'nodeinfo.configuration.group' => {'$regex' => $arg{'nodeinfo.configuration_group'} || $arg{group}}, 'acknowledged' => numify($arg{acknowledged}), 'escalate' => numify($arg{escalate}), 'priority' => numify($arg{priority}), }); |
Creating Events
opEvents object provides an easy way to create an event:
Code Block |
---|
# Tell opEvents object to create the event my ($error, $eventid) = $OPE->createEvent(event => $event); |
...
Code Block |
---|
# Create Event Object my $event = {}; my @maybeprops = grep($_ !~ /^(act|debug|quiet|conf|confdir|baseurl|username|password)$/, keys %$Q); if (@maybeprops) { my @rawinputs; for my $key (@maybeprops) { next if ($Q->{$key} eq ''); # supress empty properties die "argument $key cannt be set multiple times!\n" if (ref($Q->{$key}) eq "ARRAY"); # ensure numeric values for anything numeric, or mongo comparison ops will # fail badly (especially true for time, which breaks the gui) $event->{$key} = numify($Q->{$key}); push @rawinputs, "'$key=$Q->{$key}'"; } $event->{entry} = join(" ", @rawinputs); } |
Updating Events
opEvents object also provides an easy way to update an event. We will need to pass the following arguments:
- _id: for identify the event to be updated
- _constraints: to disable db key munging
Everything else will be recorded as content, as-is, except "status_history" and "trigger_eventids":
- status_history: optional but special: must be array and this array will be ADDED to an existing status_history array.
- trigger_eventids: always saved as array, and a new value is ADDED.
- buttons: always saved as array, and a new value is ADDED.
returns undef if ok, error message otherwise (also logged)
As an example:
Code Block |
---|
my $failure = $OPE->updateEvent( "_id" => $e->{_id}, priority => 5, status_history => [ $now, $thisuser, "priority", 5 ], ); |
...