sensu-plugins-victorops 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1438d310bbc76e827b3d2eafdc209185a52c248b8bb1f3dc3ae1b835c719cf6
-  data.tar.gz: a6151d40038504026eb8c719015e0f534f16fc4300c599ac3f5d185cde9fa13b
+  metadata.gz: 965908392c154eb1fd40ded196f5f184b466cb9b49246d5e7d1429e2583844f5
+  data.tar.gz: 5546257223f4b6b6a714f3119d5af80c49e2040e0dd5dea6cb4214cc626beff3
 SHA512:
-  metadata.gz: 391374de08cd4de08ac2ad4b11ddcdfa7e3bf9d4f0faf764c08cbddfb41712eb7f37706a1362caede9e08176ecd5129ae38648b09d10704451d2279743a14969
-  data.tar.gz: d214e897aeb926a9a9e3dcf23f6408140f839ed98c22fe4caac6fceb0de35d13a3f3f00a9e00ac8a70cc0c011e9da122cdb775246d15372d8eadbc6bdd617338
+  metadata.gz: c465485b0e6cb7ead4963755d3d8a4970c5081004838d5280cbbcf44dcf2891a3266dbf719b29ecf7b331edfd1ee2fc121faecbe04c408c46e6398610b8c4dca
+  data.tar.gz: ec8edb81e43e88fb5eb476771f53ef230f0c26eaea6208b30bb4ff2e4b5aae9ffa6fc242feaa82dbbf5fb1a1351611ee4c607c8a86a0daf649b7704b4d88da66

data/CHANGELOG.md

@@ -1,9 +1,14 @@
 #Change Log
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
+This CHANGELOG follows the format located [here](https://github.com/sensu-plugins/community/blob/master/HOW_WE_CHANGELOG.md)
 
 ## [Unreleased]
+
+## [2.1.0] - 2019-10-25
+### Added
+- Adds ability to use the environment variables `VICTOROPS_API_URL` & `VICTOROPS_ROUTING_KEY` for Sensu Go
+
 ## [2.0.0] - 2019-06-06
 ### Breaking Changes
 - Update minimum required ruby version to 2.3. Drop unsupported ruby versions.
@@ -46,7 +51,8 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-victorops/compare/2.0.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-victorops/compare/2.1.0...HEAD
+[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
 [0.1.0]: https://github.com/sensu-plugins/sensu-plugins-victorops/compare/0.0.3...0.1.0

data/README.md

@@ -19,6 +19,12 @@
   "victorops": {
     "api_url": "YOUR_API_URL_WHITOUT_ROUTING_KEY",
     "routing_key": "everyone"
+  },
+  "handlers": {
+    "victorops": {
+      "type": "pipe",
+      "command": "handler-victorops.rb"
+    }
   }
 }
 ```
@@ -36,4 +42,32 @@ If you have multiple VictorOps accounts and need to route alerts to different en
       "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:
+
+```
+---
+type: Handler
+spec:
+  metadata:
+    name: victorops
+    namespace: default
+    labels: 
+    annotations: 
+  type: pipe
+  command: handler-victorops.rb --map_go_event_into_ruby
+  timeout: 0
+  handlers: []
+  filters:
+  - is_incident
+  env_vars:
+  - KEEPALIVE_SLACK_WEBHOOK=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. 

data/bin/handler-victorops.rb

@@ -7,6 +7,10 @@
 # arguments:
 #   - settingsname: Sensu settings name, defaults to victorops
 #   - routingkey: VictorOps routing key
+#
+# NOTE: This plugin is Sensu Go enabled. To use this plugin with Sensu Go, add --map_go_event_into_ruby as part of the command.
+#  Example:
+#    handler-victorops.rb --map_go_event_into_ruby
 
 require 'sensu-handler'
 require 'uri'
@@ -15,6 +19,12 @@ require 'net/https'
 require 'json'
 
 class VictorOps < Sensu::Handler
+  option :api_url,
+         description: 'VictorOps API URL without routing key',
+         short: '-a APIURL',
+         long: '--api-url APIURL',
+         default: nil
+
   option :settingsname,
          description: 'Sensu settings name',
          short: '-n NAME',
@@ -28,17 +38,23 @@ class VictorOps < Sensu::Handler
          default: nil
 
   def handle
-    # validate that we have settings
+    # 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
-    unless defined? settings[config[:settingsname]]['api_url'] && !settings[config[:settingsname]]['api_url'].nil?
+
+    # 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"
     end
-    api_url = settings[config[:settingsname]]['api_url']
 
-    # validate that we have a routing key - command arguments take precedence
-    routing_key = config[: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?
 
     unless defined? routing_key && !routing_key.nil?

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

@@ -1,7 +1,7 @@
 module SensuPluginsVictorops
   module Version
     MAJOR = 2
-    MINOR = 0
+    MINOR = 1
     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.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Sensu Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-07 00:00:00.000000000 Z
+date: 2019-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -202,7 +202,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for Victorops alerting service