sensu-plugins-xmatters 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: badb87db7fe359954ae2c26cf30512876bcb7b1a
+  data.tar.gz: 39fcd32e76ca645d231dfbba91c8e1d8e8009edc
+SHA512:
+  metadata.gz: de6e564757688bf229bcb869956beb7a0f9b24018f09342fcc0f042239240964529f3a9ba992947dadce6ab626e4e3d60e238225a6dfae1d2b15af17bebef6ed
+  data.tar.gz: 5de15d28d6285b9c125ce011c7d2046bf6da69e46e2db1a8592a043788650b550b0abd21939f93220b8fb119a3a7664ffba4a0346b42122f2afe41d5a0b7de11

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dan Reich
+
+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,85 @@
+# Sensu-Plugins-xMatters
+
+## What is it?
+
+This version of the integration is a simple sensu plugin with a single handler, found at [bin/handler-xmatters.rb](bin/handler-xmatters.rb). The handler will create a new event in xMatters via an inbound integration in the included Sensu Communication Plan.
+
+## How does it work?
+
+### Installation
+
+Before installing the Sensu plugin, import the Sensu communication plan into your xMatters instance. You will need the URLs for the inbound and outbound integrations from the imported plan.
+
+To install the integration, run the following command:
+
+```sh
+sensu-install -p xmatters
+```
+
+### Configuration
+
+#### Configuring a handler:
+
+To configure a handler, use the following syntax:
+
+```json
+{
+  "handlers": {
+    "xmatters_handler": {
+      "type": "pipe",
+      "command": "handler-xmatters.rb"
+    }
+  }
+}
+```
+#### Create a default settings file:
+
+To create a default settings file, use the following syntax, and replace the inbound_integration_url with the URL of the inbound integration in the Sensu communication plan:
+
+```json
+{
+  "xmatters": {
+     "inbound_integration_url": "https://company.instance.xmatters.com/api/integration/1/functions/uuid/triggers"
+   }
+}
+```
+
+To create multiple handlers that point to different integration URLS, use the following syntax:
+
+```json
+
+{
+  "handlers": {
+    "xmatters_handler": {
+      "type": "pipe",
+      "command": "handler-xmatters.rb -c xmatters_custom"
+    }
+  }
+}
+
+{
+  "xmatters_custom": {
+     "inbound_integration_url": "https://company.instance.xmatters.com/api/integration/1/functions/uuid/triggers"
+   }
+}
+
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Development and Publishing
+
+During development, to execute tests and perform additional linting and validation run the following command:
+
+```sh
+  rake
+```
+
+When ready to release a new version, run the following commands:
+
+```sh
+  gem build sensu-plugins-xmatters.gemspec
+  gem push sensu-plugins-xmatters-x.y.z.gem
+```

data/bin/handler-xmatters.rb

@@ -0,0 +1,85 @@
+#! /usr/bin/env ruby
+#
+#   handler-xmatters.rb
+#
+# DESCRIPTION:
+#   This handler creates events in xMatters based on the Sensu event input.
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux, Windows, BSD, Solaris, etc
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#
+# USAGE:
+#   handler-xmatters.rb -c xmatters
+#
+# NOTES:
+#
+# LICENSE:
+#   xMatters  alderaan@xmatters.com
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-handler'
+require 'xmatters-sensu'
+
+#
+# xMatters
+#
+class XMattersHandler < Sensu::Handler
+  option :pattern,
+         description: 'Used to allow tests to run only, ignored in code',
+         long: '--pattern pattern',
+         required: false
+  option :config_name,
+         description: 'The name of the configuration',
+         short: '-c ConfigName',
+         long: '--config_name ConfigName',
+         required: false,
+         default: 'xmatters'
+
+  #
+  # The name of the configuration that will be used to find xMatters Settings
+  #
+  def config_name
+    @config_name ||= config[:config_name]
+  end
+
+  #
+  # The xMatters Settings object
+  #
+  def xm_settings
+    @xm_settings ||= settings[config_name]
+  end
+
+  #
+  # The integration url that will be used to create an xMatters Event
+  #
+  def integration_url
+    @integration_url ||= xm_settings['inbound_integration_url']
+  end
+
+  #
+  # Override
+  # If the action type is create, we will create an event in xMatters
+  # with the default properties payload to the configured inbound
+  # integration url in xMatters
+  #
+  def handle
+    xm_client = XMSensu::XMClient.new(integration_url)
+    payload = xm_client.get_default_properties(@event)
+    begin
+      case @event['action']
+      when 'create'
+        xm_client.send_event(payload)
+      when 'resolve'
+        puts 'xMatters Handler bypassing resolve'
+      end
+    end
+  end
+end

data/lib/xmatters-sensu/version.rb

@@ -0,0 +1,27 @@
+#
+# XMSensu
+#
+module XMSensu
+  #
+  # XMSensu::Version
+  #
+  module Version
+    #
+    # MAJOR Version
+    #
+    MAJOR = 0
+    #
+    # MINOR Version
+    #
+    MINOR = 0
+    #
+    # PATCH Version
+    #
+    PATCH = 4
+
+    #
+    # Formatted Version String
+    #
+    VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

data/lib/xmatters-sensu.rb

@@ -0,0 +1,58 @@
+require 'xmatters-sensu/version'
+
+#
+# XMSensu
+#
+# Holder for common functionality
+#
+module XMSensu
+  #
+  # XMSensu::XMClient
+  #
+  # A class used for common xMatters logic
+  #
+  class XMClient
+    #
+    # Constructor
+    #
+    # integration_url is an inbound integration url from an xMatters Communication Plan
+    #
+    def initialize(integration_url, user = nil, pass = nil)
+      @user = user
+      @pass = pass
+      @uri = URI(integration_url)
+      @header = {
+        'Content-Type' => 'text/json'
+      }
+    end
+
+    #
+    # Sends the properties to the configured integration url in the correct json format
+    #
+    def send_event(properties)
+      http = Net::HTTP.new(@uri.hostname, @uri.port)
+      request = Net::HTTP::Post.new(@uri.path, @header)
+      request.body = { properties: properties }.to_json
+      http.use_ssl = true
+      http.request(request)
+    end
+
+    #
+    # Gets a default set of properties from the event
+    #
+    def get_default_properties(event)
+      client = event['client']
+      check = event['check']
+      {
+        server_name: client['name'],
+        server_ip: client['address'],
+        subscriptions: client['subscriptions'].join(';'),
+        environment: client['environment'],
+        check_name: check['name'],
+        check_command: check['command'],
+        check_output: check['output'],
+        timestamp: event['timestamp'].inspect
+      }
+    end
+  end
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-xmatters
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- xMatters
+- Dan Reich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-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.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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'
+- !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'
+- !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: 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'
+description: Provides a default xMatters handler and library that can be used to create
+  xMatters Events when events occur in Sensu
+email:
+- alderaan@xmatters.com
+- dreich@xmatters.com
+executables:
+- handler-xmatters.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/handler-xmatters.rb
+- lib/xmatters-sensu.rb
+- lib/xmatters-sensu/version.rb
+homepage: https://github.com/xmatters/sensu-plugins-xmatters
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: A Sensu plugin for xMatters
+test_files: []