sensu-plugins-victorops 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 965908392c154eb1fd40ded196f5f184b466cb9b49246d5e7d1429e2583844f5
-  data.tar.gz: 5546257223f4b6b6a714f3119d5af80c49e2040e0dd5dea6cb4214cc626beff3
+  metadata.gz: f107aa23da5952e367c157267f700e78869668c8af37ab518050524dab9451d5
+  data.tar.gz: 9823e387a5394e4c0923b162d28688393b0925e46b995828ad4d89f23d19cb92
 SHA512:
-  metadata.gz: c465485b0e6cb7ead4963755d3d8a4970c5081004838d5280cbbcf44dcf2891a3266dbf719b29ecf7b331edfd1ee2fc121faecbe04c408c46e6398610b8c4dca
-  data.tar.gz: ec8edb81e43e88fb5eb476771f53ef230f0c26eaea6208b30bb4ff2e4b5aae9ffa6fc242feaa82dbbf5fb1a1351611ee4c607c8a86a0daf649b7704b4d88da66
+  metadata.gz: 51b4996bc1c53266ce88d25eda1e8a79d09a1e8bb42d34551d89cf95902a643da07b32a3609ecbe246e43a2a1def38b692c3b4e645e62f205cafb0ad2f453ca9
+  data.tar.gz: 5e35a6c01f6f5e69f215fcd10dc2ad0661fe406d9d42e50f7dc6d41634a742e5f5c6e475472a4836dd4f38050612b9d847856cca5b923852a9385de92a03dca4

data/CHANGELOG.md

@@ -5,6 +5,18 @@ This CHANGELOG follows the format located [here](https://github.com/sensu-plugin
 
 ## [Unreleased]
 
+## [3.0.0] - 2020-03-13
+### Added
+- Adds dryrun option to help diagnose settings being used.
+- Extends usages information to include envvar note
+
+### Changed
+- Update dev dependancies
+- Updated Readme with corrected Sensu Go instructions
+
+### Breaking Changes
+- Update runtime dependancy for json to 2.3.0
+
 ## [2.1.0] - 2019-10-25
 ### Added
 - Adds ability to use the environment variables `VICTOROPS_API_URL` & `VICTOROPS_ROUTING_KEY` for Sensu Go
@@ -51,7 +63,8 @@ This CHANGELOG follows the format located [here](https://github.com/sensu-plugin
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-victorops/compare/2.1.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-victorops/compare/3.0.0...HEAD
+[3.0.0]: https://github.com/sensu-plugins/sensu-plugins-victorops/compare/2.1.0...3.0.0
 [2.1.0]: https://github.com/sensu-plugins/sensu-plugins-victorops/compare/2.0.0...2.1.0
 [2.0.0]: https://github.com/sensu-plugins/sensu-plugins-victorops/compare/1.0.0...2.0.0
 [1.0.0]: https://github.com/sensu-plugins/sensu-plugins-victorops/compare/0.1.0...1.0.0

data/README.md

@@ -13,39 +13,21 @@
  * bin/handler-victorops.rb
 
 ## Usage
-
-```
-{
-  "victorops": {
-    "api_url": "YOUR_API_URL_WHITOUT_ROUTING_KEY",
-    "routing_key": "everyone"
-  },
-  "handlers": {
-    "victorops": {
-      "type": "pipe",
-      "command": "handler-victorops.rb"
-    }
-  }
-}
 ```
-## Installation
-
-[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
-
+bin/handler-victorops.rb --help
+Usage: bin/handler-victorops.rb (options)
+    -a, --api-url APIURL             VictorOps API URL without routing key. Or use envvar VICTOROPS_API_URL.
+        --dryrun                     Report settings, and take no action
+        --map-go-event-into-ruby     Enable Sensu Go to Sensu Ruby event mapping. Alternatively set envvar SENSU_MAP_GO_EVENT_INTO_RUBY=1.
+    -r, --routingkey KEY             Routing key. Or use envvar VICTOROPS_ROUTING_KEY.
 
-## Notes
-If you have multiple VictorOps accounts and need to route alerts to different endpoints, specifying the handler name in the config is necessary otherwise, the handler will attempt to route to the default `victorops`.  You will therefore need to use the `-name` switch to specify the API endpoint as noted below.
-
-```
-"victorops_enpoint1": {
-      "type": "pipe",
-      "command": "/opt/sensu/embedded/bin/handler-victorops.rb -name victorops_endpoint1"
-    },
 ```
 
 ### Sensu Go Enabled
 
-This plugin is also Sensu Go enabled. You can map events into ruby by using the flag `--map_go_event_into_ruby` as part of your command. Practically, this might look like:
+Plugin versions 2.0 and higher are now Sensu Go enabled. You can map Sensu Go events into Sensu Classic events by using the flag `--map_go_event_into_ruby` as part of your command. Now that Sensu Classic is now EOL, a future version of this plugin will drop support for Sensu Classic and will assume Sensu Go event structuring.
+
+Here is an example Sensu Go handler resource definition for reference.  Please note, this plugin's Sensu Asset should be used in conjunction with the Sensu Ruby runtime asset.
 
 ```
 ---
@@ -63,11 +45,43 @@ spec:
   filters:
   - is_incident
   env_vars:
-  - KEEPALIVE_SLACK_WEBHOOK=https://alert.victorops.com/integrations/generic/01234567/alert/0123456789101112
+  - VICTOROPS_API_URL=https://alert.victorops.com/integrations/generic/01234567/alert/0123456789101112
   - VICTOROPS_ROUTING_KEY=testing
   runtime_assets:
   - sensu-plugins-victorops
   - sensu-ruby-runtime
 ```
 
-You'll also note that the plugin also supports environment variables. You can use these without having to have a file locally to load in those values. 
+You'll note that the plugin supports environment variables for both routing key and api url. You can define this in the Sensu Go handler resource definition.  You can support multiple VictorOps accounts by having a different handler definition, each with appropriate environment variables defined.
+
+
+# Sensu Classic Support
+Here is an example handlers configuration for Sensu Classic. Please note, Sensu Classic has now reached EOL, and support for Sensu Classic events is planned to be removed in a future version of this plugin. 
+
+```
+{
+  "victorops": {
+    "api_url": "YOUR_API_URL_WHITOUT_ROUTING_KEY",
+    "routing_key": "everyone"
+  },
+  "handlers": {
+    "victorops": {
+      "type": "pipe",
+      "command": "handler-victorops.rb"
+    }
+  }
+}
+```
+
+If you have multiple VictorOps accounts and need to route alerts to different endpoints, specifying the handler name in the config is necessary otherwise, the handler will attempt to route to the default `victorops`.  You will therefore need to use the `-name` switch to specify the API endpoint as noted below.
+
+```
+"victorops_enpoint1": {
+      "type": "pipe",
+      "command": "/opt/sensu/embedded/bin/handler-victorops.rb -name victorops_endpoint1"
+    },
+```
+
+## Installation
+
+[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)

data/bin/handler-victorops.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 # This handler creates and resolves victorops incidents
 #
 # Released under the same terms as Sensu (the MIT license); see LICENSE
@@ -20,7 +22,7 @@ require 'json'
 
 class VictorOps < Sensu::Handler
   option :api_url,
-         description: 'VictorOps API URL without routing key',
+         description: 'VictorOps API URL without routing key. Or use envvar VICTOROPS_API_URL.',
          short: '-a APIURL',
          long: '--api-url APIURL',
          default: nil
@@ -32,34 +34,103 @@ class VictorOps < Sensu::Handler
          default: 'victorops'
 
   option :routing_key,
-         description: 'Routing key',
+         description: 'Routing key. Or use envvar VICTOROPS_ROUTING_KEY.',
          short: '-r KEY',
          long: '--routingkey KEY',
          default: nil
 
-  def handle
-    # validate that we have a settings name
-    unless defined? settings[config[:settingsname]] && !settings[config[:settingsname]].nil?
-      raise "victorops.rb sensu setting '#{config[:settingsname]}' not found or empty"
-    end
+  option :dryrun,
+         description: 'Report settings, and take no action',
+         long: '--dryrun',
+         boolean: true,
+         default: false
 
+  def set_api_url
     # validate that we have an api url - environment variables take precedence
     api_url = ENV['VICTOROPS_API_URL']
     api_url = config[:api_url] if api_url.nil?
-    api_url = settings[config[:settingsname]]['api_url'] if api_url.nil?
-
-    unless defined? api_url && !api_url.nil?
-      raise "victorops.rb sensu setting '#{config[:settingsname]}.api_url' not found or empty"
+    if api_url.nil?
+      # validate that we have a settings name
+      if defined?(settings[config[:settingsname]]) && !settings[config[:settingsname]].nil?
+        api_url = settings[config[:settingsname]]['api_url']
+      else
+        raise "victorops.rb sensu setting '#{config[:settingsname]}' not found or empty" unless config[:dryrun]
+      end
     end
+    return api_url if defined?(api_url) && !api_url.nil?
+
+    raise "victorops.rb sensu setting '#{config[:settingsname]}.api_url' not found or empty" unless config[:dryrun]
+  end
 
+  def set_routing_key
     # validate that we have a routing key - environment variables take precedence
     routing_key = ENV['VICTOROPS_ROUTING_KEY']
     routing_key = config[:routing_key] if routing_key.nil?
-    routing_key = settings[config[:settingsname]]['routing_key'] if routing_key.nil?
+    if routing_key.nil?
+      # validate that we have a settings name in the config
+      if defined?(settings[config[:settingsname]]) && !settings[config[:settingsname]].nil?
+        routing_key = settings[config[:settingsname]]['routing_key']
+      else
+        raise "victorops.rb sensu setting '#{config[:settingsname]}' not found or empty" unless config[:dryrun]
+      end
+    end
+    return routing_key if defined?(routing_key) && !routing_key.nil?
+
+    raise 'routing key not defined, should be in Sensu settings or passed via command arguments' unless config[:dryrun]
+  end
+
+  def dry_run(api_url, routing_key, uri, payload)
+    return unless config[:dryrun]
 
-    unless defined? routing_key && !routing_key.nil?
-      raise 'routing key not defined, should be in Sensu settings or passed via command arguments'
+    puts 'Dryrun: reporting settings and exiting'
+    puts "  option settingsname set: #{config[:settingsname]}"
+    puts 'Determing API_URL to use:'
+    if ENV['VICTOROPS_API_URL']
+      puts "  envvar VICTOROPS_API_URL set: #{ENV['VICTOROPS_API_URL']}"
+    else
+      puts '  envvar VICTOROPS_API_URL not set'
+    end
+    if config[:api_url]
+      puts "  option api-url set: #{config[:api_url]}"
+    else
+      puts '  option api-url not set'
+    end
+    if settings[config[:settingsname]]
+      puts "  settings api_url set: #{settings[config[:settingsname]]['api_url']}" if settings[config[:settingsname]]['api_url']
+    else
+      puts "  setting name: #{config[:settingsname]} does not exist"
+    end
+    puts "  using: #{api_url}"
+    puts 'Determing ROUTING_KEY to use:'
+    if ENV['VICTOROPS_ROUTING_KEY']
+      puts "  envvar VICTOROPS_ROUTING_KEY set: #{ENV['VICTOROPS_ROUTING_KEY']}"
+    else
+      puts '  envvar VICTOROPS_ROUTING_KEY not set'
+    end
+    if config[:routing_key]
+      puts "  option routingkey set: #{config[:routing_key]}"
+    else
+      puts '  option routingkey not set'
     end
+    if settings[config[:settingsname]]
+      puts "  settings routing_key set: #{settings[config[:settingsname]]['routing_key']}" if settings[config[:settingsname]]['routing_key']
+    else
+      puts "  setting name: #{config[:settingsname]} does not exist"
+    end
+    puts "  using: #{routing_key}"
+    puts " #{@event['action']}"
+    puts "VictorOps Message URI: #{uri}"
+    puts "  Message type: #{payload[:message_type]}"
+  end
+
+  def handle
+    # validate that we have a client defined
+    unless defined?(@event['client']) && !@event['client']['name'].nil?
+      raise 'victorops.rb sensu client not found or has no name. If using with Sensu Go please ensure you have enabled event mapping'
+    end
+
+    api_url = set_api_url
+    routing_key = set_routing_key
 
     incident_key = @event['client']['name'] + '/' + @event['check']['name']
 
@@ -68,36 +139,39 @@ class VictorOps < Sensu::Handler
     host = @event['client']['name']
     entity_id = incident_key
     state_message = description
-    begin
-      timeout(10) do
-        case @event['action']
-        when 'create'
-          message_type = case @event['check']['status']
-                         when 1
-                           'WARNING'
-                         else
-                           'CRITICAL'
-                         end
-        when 'resolve'
-          message_type = 'RECOVERY'
-        end
-
-        payload = {}
-        payload[:message_type] = message_type
-        payload[:state_message] = state_message.chomp
-        payload[:entity_id] = entity_id
-        payload[:host_name] = host
-        payload[:monitoring_tool] = 'sensu'
-
-        # Add in client data
-        payload[:check] = @event['check']
-        payload[:client] = @event['client']
-
-        uri   = URI("#{api_url.chomp('/')}/#{routing_key}")
-        https = Net::HTTP.new(uri.host, uri.port)
-
-        https.use_ssl = true
+    case @event['action']
+    when 'create'
+      message_type = case @event['check']['status']
+                     when 1
+                       'WARNING'
+                     else
+                       'CRITICAL'
+                     end
+    when 'resolve'
+      message_type = 'RECOVERY'
+    end
+    payload = {}
+    payload[:message_type] = message_type
+    payload[:state_message] = state_message.chomp
+    payload[:entity_id] = entity_id
+    payload[:host_name] = host
+    payload[:monitoring_tool] = 'sensu'
+
+    # Add in client data
+    payload[:check] = @event['check']
+    payload[:client] = @event['client']
+
+    uri   = URI("#{api_url.chomp('/')}/#{routing_key}")
+    https = Net::HTTP.new(uri.host, uri.port)
+
+    https.use_ssl = true
+    if config[:dryrun]
+      dry_run(api_url, routing_key, uri, payload)
+      return
+    end
 
+    begin
+      Timeout.timeout(10) do
         request      = Net::HTTP::Post.new(uri.path)
         request.body = payload.to_json
         response     = https.request(request)

data/lib/sensu-plugins-victorops.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'sensu-plugins-victorops/version'

data/lib/sensu-plugins-victorops/version.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module SensuPluginsVictorops
   module Version
-    MAJOR = 2
-    MINOR = 1
+    MAJOR = 3
+    MINOR = 0
     PATCH = 0
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-victorops
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Sensu Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-26 00:00:00.000000000 Z
+date: 2020-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.8.5
+        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.8.5
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
   requirement: !ruby/object:Gem::Requirement
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: github-markup
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -128,42 +142,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.80.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.80.1
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.20
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.20
 description: Sensu plugins for Victorops alerting service
 email: "<sensu-users@googlegroups.com>"
 executables: