Sensu Handler shim for Sensu 2.0 event data. #190

jspaleta · 2018-07-24T23:10:01Z

Description

Added event_2to1 method to Utils and --enable-2.0-event option to base Handler class. New option makes it possible to use sensu-plugin based handlers with Sensu 2.0 events until handlers provide native 2.0 event support.

Motivation and Context

the event data model changed in Sensu 2.0, so to make it possible to continue to use the community managed handlers a quick mapping back into Sensu 1.4 event JSON representation can be performed.

How Has This Been Tested?

Spot checked with local rebuild of sensu-plugin-logs handler so far.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

My change requires a change to the documentation.
I have updated the documentation accordingly.
I have updated the Changelog following the conventions laid out on Keep A Changelog

…e Handler class. New option makes it possible to use sensu-plugin based handlers with Sensu 2.0 events until handlers provide native 2.0 event support.

jspaleta · 2018-07-24T23:15:28Z

i need to clean things up for rubocop. I just wanted to get the PR out for people to look at asap

portertech · 2018-07-25T04:07:55Z

lib/sensu-plugin/utils.rb

+      #    until they natively support 2.0
+      ##
+      def event_2to1
+        if @event.key?('entity') && @event['client'].empty?


Should this be @event['client'].nil?? Does empty cover nil?

for the normal use case it definitely needs to be empty... as event_read will set client to {} if client doesn't exist. I'll update to check for nil? || empty? to cover all cases.

I don't want to do this as part of event_read, as I want to control when this gets called.. for now just for handlers.

empty? does not cover .nil?

teekennedy · 2018-08-23T22:54:50Z

@jspaleta Could the 2to1 method be refactored and/or moved to its own gem so that it can be used for https://github.com/sensu/sensu-1.x-filter-wrapper ?

jspaleta · 2018-09-04T18:36:10Z

@Cyphus

okay refactoring this now as a utility function. I'm sure it makes sense as a separate gem right now. It definitely feels like something in the scope of sensu-plugin which provides nice base classes for mutators,checks and handlers.

sync with upstream repo.

majormoses · 2018-09-05T00:44:17Z

Could the 2to1 method be refactored and/or moved to its own gem

I agree with @jspaleta that this makes sense to be in the base plugin class as a util method, any GRPC service can depend on the base plugin class.

jspaleta · 2018-09-05T01:12:37Z

@Cyphus
I think have it set up now so that if you use this now so that you could for example
create a mutator instance from sensu-plugin in the GRPC and call the method like this:
event_1.x_json=mutator.event_2to1(event_2.x_json)

irb toy example:
require 'sensu-mutator'
mutator = Sensu::Mutator.new
event = JSON.parse("{}")
new_event=mutator.event_2to1(event)

CHANGELOG.md

lib/sensu-plugin/utils.rb

majormoses · 2018-09-05T01:22:55Z

lib/sensu-plugin/utils.rb

+      #      will be set to true as a hint to indicate this is a mapped event object.
+      #
+      ##
+      def event_2to1(orig_event = nil)


personally I'd opt for a longer more descriptive name, I also find that saying 2to1 aloud is confusing. It's unclear if its 221, two to one, or if its combining two events into a single event. Maybe adding the word shim would give it more context which would make it less confusing. I can't say I am coming up with a great method name either and so far only end up with a very verbose name such as shim_v2_event_data_into_v1, event_data_shim_v2, sensu2_event_compatibility, mutate_sensu2_event_data_to_v1, etc.

attempt to refactor function name into something more descriptive in later commits.

…ng issue

…tomatically

…hangelog

portertech · 2018-09-07T21:47:28Z

lib/sensu-mutator.rb

+      TRUTHY_VALUES = %w[1 t true yes y].freeze
+      automap = ENV['SENSU_MAP_V2_EVENT_INTO_V1'].to_s.downcase
+
+      if mutator.config[:map_v2_event_into_v1,] || TRUTHY_VALUES.include?(automap)


, looks like a mistake

interesting that this is allowed syntax by ruby. Fixed in newer commits.

majormoses · 2018-09-08T20:59:36Z

lib/sensu-plugin/utils.rb

+        # Deep copy of orig_event
+        event = Marshal.load(Marshal.dump(orig_event))
+
+        # Trigger mapping code iff enity exists and client does not


looks like an extra f

majormoses · 2018-09-08T21:01:44Z

lib/sensu-plugin/utils.rb

+          #  action used in logs and fluentd plugins handlers
+          ##
+          state = event['check']['state'] || 'unknown::2.0_event'
+          event['action'] ||= 'flapping' if state.casecmp('flapping').zero?


I feel like this could be much simpler and less error prone with a case statement.

refactored using a hash mapping, since the states to action are 1 to 1.

majormoses · 2018-09-08T21:03:18Z

lib/sensu-plugin/utils.rb

+          if event['check']['history']
+            legacy_history = []
+            event['check']['history'].each do |h|
+              legacy_history << h['status'].to_s || '3'


hmm if we are not sure what the history is I feel like we should use nil (though that might cause issues?) as not knowing how to translate is not quite the same as the check itself returning an unknown state.

Also is history really stored as the string when really they are integers?

For the 1.4 events I have access to, the are stored as strings.
there is at least one mutator in the sensu-plugins collection that makes use of the history, and in fact makes a comment that the history is saved as an array strings.

sensu-plugins-pagerduty/bin/mutator-pagerduty-priority-override.rb

Returning nil instead of '3' may cause weird issues nil.to_i gets translated to 0 which is the 'ok' status. I think if we don't know how to translate the status in the history its better to use the 3 aka 'unknown' to make sure we flag it as a problem that needs to be investigated.

Or it may be better to throw an error here instead of providing a fallback if the status is unmappable to a string.

…llback if state is not in understood mapping

majormoses

LGTM @portertech anything else you catch I missed?

majormoses · 2018-09-09T18:10:23Z

CHANGELOG.md

@@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).

 ## [Unreleased]
+### Added
+- Added map_v2_event_into_v1 method to Utils for all plugin classes to use. 


I can add attribution for you post acceptance or you can do it prior, either way works.

majormoses · 2018-09-13T01:15:34Z

released: https://rubygems.org/gems/sensu-plugin/versions/2.7.0

Added event_2to1 method to Utils and --enable-2.0-event option to bas…

feb1b95

…e Handler class. New option makes it possible to use sensu-plugin based handlers with Sensu 2.0 events until handlers provide native 2.0 event support.

jspaleta mentioned this pull request Jul 24, 2018

Sensu 2.0 Readiness: Handler Mapping #189

Open

Jef Spaleta added 2 commits July 24, 2018 15:35

cleanup for rubocop

d0d531e

cleanup for rubocop

339ead8

jspaleta changed the title ~~Sensu Handler shim for Sensu 2.0 event data.~~ WIP: Sensu Handler shim for Sensu 2.0 event data. Jul 25, 2018

portertech reviewed Jul 25, 2018

View reviewed changes

handle case when event['client'] is nil

06dcf07

barryorourke mentioned this pull request Aug 29, 2018

Add support for Sensu 2.0 handlers sensu-plugins/sensu-plugin-python#46

Closed

Jef Spaleta and others added 5 commits September 4, 2018 15:00

Refactor event_2to1 utility function to take optional event argument

01fb9e1

Merge pull request #1 from sensu-plugins/master

c165f1e

sync with upstream repo.

Merge branch 'master' into handler_shim_for_2.0_events

bfa7433

fix bad conditional for expected integer attribute

009fb83

add test for --enable-2to1-mapping handler argument

65cc0d7

jspaleta changed the title ~~WIP: Sensu Handler shim for Sensu 2.0 event data.~~ Sensu Handler shim for Sensu 2.0 event data. Sep 5, 2018

clean up for rubocop

92cb685

majormoses reviewed Sep 5, 2018

View reviewed changes

Jef Spaleta added 9 commits September 4, 2018 17:27

fix unreleased changelog entry format

ac18b2e

remove unneeded cornercase mapping due to now resolved attribute nami…

c0f891b

…ng issue

fix for handle 2to1 test

40ba5b8

Refactor function name from awkward 2to1 as per pr review

953b1d2

return orig_event if already mapped

68152d2

fix argument to match refactor

5be70d9

make it possible to set env variable to attempt v2 into v1 mapping au…

a160133

…tomatically

rubocop fix ups

fd160df

update changelog with more detail on added v2 -> v1 mapping support

2a39832

Jef Spaleta added 4 commits September 5, 2018 10:00

add support for v2 -> v1 event mapping to mutator class, and update c…

6203e84

…hangelog

small fix for rubocop

f4a7d68

remove unneeded confusing unless conditional

a6d8b07

fix for rubocop

b951c11

portertech reviewed Sep 7, 2018

View reviewed changes

majormoses reviewed Sep 8, 2018

View reviewed changes

Jef Spaleta added 5 commits September 8, 2018 16:01

fix for stray comma

acb27c3

refactor state to action mapping to a use a 1:1 hash lookup with a fa…

0af1f41

…llback if state is not in understood mapping

refactor history handling, save original history as history_v2.

7ef0723

fix for rubocop

38d5a97

extend 2to1 test coverage to include history

21fca96

majormoses added Status: Awaiting Response Type: Enhancement Area: Handler Area: Mutator Priority: High and removed Status: Awaiting Response labels Sep 9, 2018

majormoses approved these changes Sep 9, 2018

View reviewed changes

majormoses merged commit 552f5fa into sensu-plugins:master Sep 13, 2018

barryorourke mentioned this pull request Sep 14, 2018

Sensu Handler shim for Sensu 2.0 event data. sensu-plugins/sensu-plugin-python#63

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sensu Handler shim for Sensu 2.0 event data. #190

Sensu Handler shim for Sensu 2.0 event data. #190

jspaleta commented Jul 24, 2018

jspaleta commented Jul 24, 2018

portertech Jul 25, 2018

jspaleta Jul 25, 2018 •

edited

Loading

majormoses Sep 5, 2018 •

edited

Loading

teekennedy commented Aug 23, 2018

jspaleta commented Sep 4, 2018

majormoses commented Sep 5, 2018

jspaleta commented Sep 5, 2018

majormoses Sep 5, 2018 •

edited

Loading

jspaleta Sep 6, 2018

portertech Sep 7, 2018

jspaleta Sep 9, 2018

majormoses Sep 8, 2018

jspaleta Sep 9, 2018

majormoses Sep 8, 2018

jspaleta Sep 9, 2018

majormoses Sep 8, 2018

majormoses Sep 8, 2018

jspaleta Sep 9, 2018

majormoses left a comment

majormoses Sep 9, 2018

majormoses commented Sep 13, 2018

Sensu Handler shim for Sensu 2.0 event data. #190

Sensu Handler shim for Sensu 2.0 event data. #190

Conversation

jspaleta commented Jul 24, 2018

Description

Motivation and Context

How Has This Been Tested?

Types of changes

Checklist:

jspaleta commented Jul 24, 2018

Choose a reason for hiding this comment

jspaleta Jul 25, 2018 • edited Loading

Choose a reason for hiding this comment

majormoses Sep 5, 2018 • edited Loading

Choose a reason for hiding this comment

teekennedy commented Aug 23, 2018

jspaleta commented Sep 4, 2018

majormoses commented Sep 5, 2018

jspaleta commented Sep 5, 2018

majormoses Sep 5, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

majormoses left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

majormoses commented Sep 13, 2018

jspaleta Jul 25, 2018 •

edited

Loading

majormoses Sep 5, 2018 •

edited

Loading

majormoses Sep 5, 2018 •

edited

Loading