sensu-plugins-signifai 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 389f49cafeacc6ce9aefefbfe382fc61e42be369
+  data.tar.gz: 30027be3978d004d694a93a0ca5f14c9fe32052c
+SHA512:
+  metadata.gz: ed36d58df46616f4279be4201ae71f425fc401d59ff3883f7ce4dffe82fb2e32df25bff2f2f170ae2c0d131a9dabb3e1f044813e804da60471ba75029b8ebdb1
+  data.tar.gz: 8be3b8031c2e26e231e73a924d4a4751c96888c2a0ffd7c75d52c7d6c8e4535e8ede900ca5e7c15dd86855f017fd23d2aa89fcf7db5205d8aade2c0948c5b4c7

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+v1.0.0
+======
+
+- Initial version.
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sensu-Plugins
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,117 @@
+This is sensu-plugin-signifai, a sensu event handler for submitting your
+metrics to SignifAi via the REST API. 
+
+Installation
+============
+
+Assuming you have [installed Sensu for your platform]
+(https://sensuapp.org/docs/latest/installation/), you should be able
+to download our gem at http://rpm.signifai.io/sensu/sensu-plugins-signifai-1.0.0.gem .
+If you elect to use the "embedded" Ruby  that comes with Sensu, you may 
+want to (at least temporarily) add their Ruby to your PATH:
+
+```
+export EMBEDDED_RUBY="true"
+export PATH="/opt/sensu/embedded/bin:$PATH"
+```
+
+Next, you'll want to download the gem at http://rpm.signifai.io/sensu/sensu-plugins-signifai-1.0.0.gem .
+
+Once the gem is downloaded to your local directory, simply run:
+
+```
+sudo -E gem install ./sensu-plugins-signifai-1.0.0.gem
+```
+
+Verify that `which handler-signifai.rb` gives you a valid path; if
+so, the plugin is installed and ready to use!
+
+Configuration
+=============
+
+The Signifai event handler is what Sensu calls a 'pipe' handler type, and you
+will need to configure it before it will forward events for you.
+
+Write out a file, /etc/sensu/conf.d/signifai.json , that looks like this:
+
+```
+{
+  "handlers": {
+    "signifai": {
+      "type": "pipe",
+      "filter": "state_change_only",
+      "command": "/opt/sensu/embedded/bin/handler-signifai.rb"
+    }
+  },
+  "signifai": {
+    "api_key": "YOUR_API_KEY"
+  },
+  "sensu_plugin": {
+    "disable_deprecated_filtering": true
+  },
+  "filters": {
+    "state_change_only": {
+      "negate": false,
+      "attributes": {
+        "occurrences": "eval: value == 1 || ':::action:::' == 'resolve'"
+      }
+    }
+  }
+}
+```
+
+If you don't want to add the sensu_plugin setting because you are currently
+relying on the deprecated filtering ([more information]
+(https://blog.sensuapp.org/deprecating-event-filtering-in-sensu-plugin-b60c7c500be3))
+you can, instead, set the `"enable_deprecated_filtering": false` per-check. 
+
+For any check whose results you want to forward to signifai, refer to this
+example:
+
+
+```
+{
+  "checks": {
+    "sleep": {
+      "command": "/opt/sensu/embedded/bin/check-process.rb -p sleep",
+      "subscribers": ["dev-sensu"],
+      "handlers": ["signifai"],
+      "interval": 60
+    }
+  }
+}
+```
+
+You can use either the `handler` attribute with just the string `"signifai"`
+or you can use `handlers` with `"signifai"` alongside any other handlers you
+may need. 
+
+Building (for developers)
+=========================
+
+You will need to install dependencies (note that you will need the `bundler` 
+gem if you are using your system's native Ruby):
+
+```
+bundle install
+```
+
+And it's always a safe bet to run tests:
+
+```
+bundle exec rake default
+```
+
+If the tests are okay, you can build your gem like so:
+
+```
+gem build sensu-plugin-signifai.gemspec
+```
+
+If you like, you can then install your newly-built gem
+using the instructions in the Installation section.
+
+For more information on the tests/procedures the sensu-plugins
+authors use when determining if a plugin is ready for release,
+check http://sensu-plugins.io/docs/testing.html -- it should be
+helpful when suggesting changes.

data/bin/handler-signifai.rb

@@ -0,0 +1,135 @@
+#!/usr/bin/env ruby
+#
+# This handler creates and resolves SignifAi incidents, refreshing
+# stale incident details every 30 minutes
+#
+# Based loosely on the PagerDuty sensu plugin.
+#
+# Copyright 2017 SignifAI, Inc <support@signifai.io>
+#
+# Released under the same terms as Sensu (the MIT license); see LICENSE
+# for details.
+#
+# Dependencies:
+#
+#   sensu-plugin >= 1.0.0
+#
+
+require 'sensu-handler'
+require 'net/http'
+
+#
+# Signifai
+#
+
+PRIORITIES = %w(low medium critical critical).freeze
+COLLECTORS_URI = URI('https://collectors.signifai.io/v1/incidents')
+
+class SignifaiHandler < Sensu::Handler
+  option :json_config,
+         description: 'Config Name',
+         short: '-j JsonConfig',
+         long: '--json_config JsonConfig',
+         required: false,
+         default: 'signifai'
+
+  def json_config
+    @json_config ||= config[:json_config]
+  end
+
+  def api_key
+    @api_key ||= settings[json_config]['api_key']
+  end
+
+  def proxy_settings
+    proxy_settings = {}
+
+    proxy_settings['proxy_host']     = settings[json_config]['proxy_host']     || nil
+    proxy_settings['proxy_port']     = settings[json_config]['proxy_port']     || 3128
+    proxy_settings['proxy_username'] = settings[json_config]['proxy_username'] || ''
+    proxy_settings['proxy_password'] = settings[json_config]['proxy_password'] || ''
+
+    proxy_settings
+  end
+
+  def incident_with_state(state, time)
+    priority_index = if @event['check']['status'].nil? || PRIORITIES[@event['check']['status']].nil?
+                       2
+                     else
+                       @event['check']['status']
+                     end
+
+    incident = {
+      event_source: 'sensu',
+      host: @event['check']['source'] || @event['client']['name'],
+      service:  @event['client']['name'],
+      timestamp: time,
+      event_description: @event['check']['output'],
+      value: PRIORITIES[priority_index],
+      attributes: { state: state }
+    }
+
+    JSON.dump(incident)
+  end
+
+  def _http_client(http_client = nil)
+    proxy = proxy_settings
+    http = if http_client
+             http_client
+           elsif proxy['proxy_host']
+             Net::HTTP.new(COLLECTORS_URI.host, COLLECTORS_URI.port,
+                           p_addr: proxy['proxy_host'],
+                           p_port: proxy['proxy_port'],
+                           p_user: proxy['proxy_username'],
+                           p_pass: proxy['proxy_password'])
+           else
+             Net::HTTP.new(COLLECTORS_URI.host, COLLECTORS_URI.port)
+           end
+    http.use_ssl = true
+    http
+  end
+
+  def handle(http_client = nil, time = Time.now.to_i)
+    # "Redundant begin" -- the rescue retries the whole function
+    # so it's not redundant
+    begin # rubocop:disable Style/RedundantBegin
+      tries ||= 3
+      Timeout.timeout(10) do
+        http = _http_client(http_client)
+
+        incident = case @event['action']
+                   when 'create', 'flapping'
+                     incident_with_state('alarm', time)
+                   when 'resolve'
+                     incident_with_state('ok', time)
+                   end
+
+        begin
+          log_host = @event['check']['source'] || @event['client']['name'] || '(none)'
+          log_svc = @event['client']['name'] || '(none)'
+          http_request = Net::HTTP::Post.new(COLLECTORS_URI)
+          http_request.body = incident
+          http_request.content_type = 'application/json'
+          http_request['Authorization'] = "Bearer #{api_key}"
+
+          http.request(http_request)
+
+          puts 'signifai -- ' + @event['action'].capitalize + 'd incident: ' + log_host + ' / ' + log_svc
+        rescue Net::HTTPServerException => error
+          if (tries -= 1) > 0
+            retry
+          else
+            puts 'signifai -- failed to ' + @event['action'] + ' incident -- ' + log_host + ' / ' + log_svc + ' -- ' +
+                 error.response.code + ' ' + error.response.message + ': ' + error.response.body
+          end
+        end
+      end
+    rescue Timeout::Error
+      if (tries -= 1) > 0
+        retry
+      else
+        puts 'signifai -- timed out while attempting to ' + @event['action'] + ' a incident -- ' + incident_key
+      end
+    end
+  end
+end

data/lib/sensu-plugins-signifai.rb

@@ -0,0 +1 @@
+require 'sensu-plugins-signifai/version'

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

@@ -0,0 +1,9 @@
+module SensuPluginsSignifai
+  module Version
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 0
+
+    VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-signifai
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sensu-Plugins and contributors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: This plugin provides a Sensu handler for SignifAi
+email: "<zcarlson@signifai.io>"
+executables:
+- handler-signifai.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/handler-signifai.rb
+- lib/sensu-plugins-signifai.rb
+- lib/sensu-plugins-signifai/version.rb
+homepage: https://github.com/signifai/sensu-plugins-signifai
+licenses:
+- MIT
+metadata:
+  maintainer: sensu-plugin
+  development_status: active
+  production_status: stable - production ready
+  release_draft: 'false'
+  release_prerelease: 'false'
+post_install_message: You can use the embedded Ruby by setting EMBEDDED_RUBY=true
+  in /etc/default/sensu
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Sensu plugins for SignifAi
+test_files: []