sensu-plugins-outlyer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9d39213feb78b60d5374d32eda1ad3020e11fda
+  data.tar.gz: 84a8a8cb10cfdbfe8e28280219e04b880244d6a2
+SHA512:
+  metadata.gz: 416334263bc3660066faa32db08ce55ea2102591f458145398944de8af8896d50f3764a23c028b253fd3d96249e45f9c993b1036f0408e86c73d4cd1d8b1032d
+  data.tar.gz: 9e0c2857294938983196546d18fc94fc296157f1e507a685cc72d7dbc129af3bf43a0aefa3bab6c4f59608171b62ce590b28574e11605418a84a8e4db41f1d36

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+#Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
+
+## 0.0.1 - 2018-07-12
+### Added
+- initial release

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2018 Dataloop Software, INC. Trading as Outlyer
+
+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,102 @@
+Outlyer Sensu Handler Integration
+=================================
+
+== Description ==
+
+This integration provides instructions to install and use the Outlyer Sensu Handler Integration
+to push all your check event metrics and check status's from Sensu checks into Outlyer. It supports
+both Nagios checks and Graphite Metric check outputs from Sensu.
+
+Once installed and enabled you should see all your check metrics and check status's in Outlyer to
+use on custom dashboards and alerts.
+
+== Metrics Collected ==
+
+The Sensu integration will push any metric collected by your Sensu checks with metric
+names namespaced to the check name as follows:
+
+```
+<check_name>.<metric_name>
+```
+
+In addition the status code of each check is sent as the `service.status` metric
+to Outlyer with the label `service: <check_name>`. You will be able to use this
+metric to configure dashboad status widgets and service check alerts in Outlyer.
+
+For Nagios checks, the timestamp of when the check was executed is used for all the
+metric data points. For Graphite metric checks the timestamp of each metric data
+point is used, apart from the service.status which uses the check execution time
+like Nagios checks.
+
+== Installation ==
+
+Firstly install the Outlyer Sensu plugin on your Sensu machine(s) using the following
+command:
+
+```bash
+sensu-install outlyer
+```
+
+Next, we’ll enable the handlers by adding it to `/etc/sensu/conf.d/outlyer-handlers.json`:
+
+```json
+{
+  "handlers": {
+    "outlyer-graphite": {
+       "type": "pipe",
+       "command": "/opt/sensu/embedded/bin/outlyer-metrics.rb"
+    },
+    "outlyer-nagios": {
+       "type": "pipe",
+       "command": "/opt/sensu/embedded/bin/outlyer-metrics.rb -f nagios"
+    }
+  }
+}
+```
+
+Two handlers have been configured, one for your Nagios checks `outlyer-nagios` and
+one for your Graphite metric checks `outlyer-graphite`. You can refer to these handlers
+in your check configurations to ensure they are handled by the Outlyer handler with
+the correct check output parsing. 
+
+You can also add the optional `-t` parameter to the handler command to change the default
+timeout for Outlyer API requests from 5 seconds. This is useful if you notice the handler
+timing out as your checks send more metrics creating larger payloads.
+
+Finally add your Outlyer API configuration at /etc/sensu/conf.d/outlyer.json:
+
+```json
+{
+    "outlyer": {
+       "api_key": "<API_KEY>",
+       "account": "<ACCOUNT_NAME>",
+       "tags": []
+    }
+}
+```
+
+Where:
+
+* **api_key**: Your user's API key generated under user settings
+* **account**: The unique account name of the account you want to push metrics too (you will see this in the URL when using the app)
+* **tags**: An array of tags you want to add to all your metrics from Sensu, i.e. region: us-west-1
+
+Finally restart your Sensu server so the new handler is enabled:
+
+```bash
+sudo systemctl restart sensu-{server,api}
+```
+
+You will need to add the handler to all the checks you want metrics sent to Outlyer for by adding
+`outlyer-nagios` or `outlyer-graphite` to your check handlers configuration as appropriate. Once
+your checks have been configured to use the Outlyer handler you should start seeing all your
+metrics from your configured Sensu checks appearing in Outlyer shortly afterwards.
+
+Please read the Metrics Collected section of this guide to understand how your check metrics
+are sent to Outlyer.
+
+== Changelog ==
+
+|Version|Release Date|Description                                          |
+|-------|------------|-----------------------------------------------------|
+|1.0    |12-Jul-2018 |Initial version of the Outlyer Sensu Handler.        |

data/bin/outlyer-metrics.rb

@@ -0,0 +1,196 @@
+#! /usr/bin/env ruby
+#
+#   outlyer-metrics
+#
+# DESCRIPTION:
+#   Pushes metrics from Sensu Nagios Checks and Sensu Graphite Metric Checks
+#   to Outlyer. Will also send the check status as an additional `service.status`
+#   metric with label `check: sensu.<check_name>` so you can create status alerts and
+#   dashboard widgets for the check in Outlyer.
+#
+# OUTPUT:
+#   metric data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-handler
+#
+# USAGE:
+#   Takes the following optional parameters:
+#   
+#     -f: set the Handler's check output format to parse. Can either be `graphite` (default) or `nagios`.
+#     -t: Set the timeout in seconds for the Outlyer API requests
+#   
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2018 Dataloop Software, INC. trading as Outlyer (https://www.outlyer.com)
+#   Released under the same terms as Sensu (the MIT license); see LICENSE for details.
+#
+
+require 'sensu-handler'
+require 'net/https'
+require 'uri'
+require 'json'
+
+#
+# Outlyer Metrics
+#
+class OutlyerMetrics < Sensu::Handler
+  
+  option :output_format,
+         description: 'Output format of checks to process: graphite (default) or nagios',
+         short: '-f FORMAT',
+         long: '--format FORMAT',
+         default: 'graphite'
+  
+  option :api_timeout,
+         description: 'The timeout in seconds for Outlyer API Requests',
+         short: '-t TIMEOUT',
+         long: '--timeout TIMEOUT',
+         default: '5'
+  
+  # Override filters from Sensu::Handler.
+  # They are not appropriate for metric handlers
+  #
+  def filter
+  end
+    
+  # Create a handle and event set
+  #
+  def handle
+    
+    output = @event['check']['output']
+    check_status = @event['check']['status'].to_f
+    @check_name = @event['check']['name']
+    @host = @event['client']['name']
+    @environment = @event['client']['environment']
+    timestamp = @event['check']['executed'].to_i * 1000
+    
+    # Uncomment this line for local testing outside Sensu
+    #@settings = { "outlyer" => {"account" => "", "api_key" => ""}}
+
+    # Parse output for metric data
+    metrics = if config[:output_format] == 'nagios' then
+             parse_nagios_output(output, timestamp)
+          else
+             parse_graphite_output(output)
+          end 
+    
+    # Add a service status metric
+    metrics.push(create_datapoint('service.status', check_status, timestamp, {service: "sensu.#{@check_name}"}))
+    puts metrics
+    # Post metrics to Outlyer
+    push_metrics(metrics)
+  end
+  
+  # Create a single data point
+  #
+  # @param name     [String] metric name
+  # @param value    [Float] metric value
+  # @param time     [Integer] epoch timestamp of metric in milliseconds
+  # @param labels   [HashMap] (Optional) Additional labels to append to data point
+  #
+  def create_datapoint(name, value, time, labels = nil)
+    datapoint = {
+                  host: @host,
+                  labels: {
+                            environment: @environment,
+                          },
+                  name: name,
+                  timestamp: time,
+                  type: 'gauge',
+                  value: value
+                }
+    datapoint[:labels].merge!(labels) unless labels.nil?
+    datapoint
+  end
+
+  # Parse the Nagios output format:
+  #   <message> | <metric path 1>=<metric value 1>, <metric path 2>=<metric value 2>...
+  #
+  # @param output   [String] The full check output
+  # @param timestamp[Integer] The epoch timestamp in milliseconds the check was executed
+  #
+  def parse_nagios_output(output, timestamp)
+    data = []
+    parts = output.strip.split('|')
+    
+    if parts.length < 2
+      # No performance data
+      return data
+    end
+    
+    parts[1].strip.split.each do |metric|
+      metric_parts = metric.strip.split('=')
+      begin
+        name = metric_parts[0]
+        value = metric_parts[1].split(";")[0].to_f
+        data.push(create_datapoint(@check_name + '.' + name, value, timestamp))
+      rescue => error
+        # Raised when any metrics could not be parsed
+        puts "[OutlyerHandler] The Nagios metric '#{metric}' could not be parsed: #{error.message}"
+      end 
+    end
+    data
+  end
+  
+  # Parse the graphite output format:
+  #   <metric path> <metric value> <metric timestamp>\n
+  #
+  # Each metric is separated by a newline character in the body
+  #
+  # @param output   [String] The full check output
+  #
+  def parse_graphite_output(output)
+    data = []
+    output.split("\n").each do |metric|
+      m = metric.split
+      next unless m.count == 3
+      name = m[0].split('.', 2)[1]
+      value = m[1].to_f
+      time = m[2].to_i * 1000
+      point = create_datapoint(@check_name + '.' + name, value, time)
+      data.push(point)
+    end
+    data
+  end
+
+  # Post check metrics to Outlyer's Series API:
+  #   
+  #   POST https://api2.outlyer.com/v2/accounts/{account}/series
+  #
+  # @param datapoints     [Object] Array of data points
+  #
+  def push_metrics(datapoints)
+    Timeout.timeout(config[:api_timeout].to_i) do
+      uri = URI.parse("https://api2.outlyer.com/v2/accounts/#{settings['outlyer']['account']}/series")
+
+      # Create the HTTP objects
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.add_field("Authorization", "Bearer #{settings['outlyer']['api_key']}")
+      request.add_field("accept", "application/json") 
+      request.add_field("Content-Type", "application/json")
+      request.body = {samples: datapoints}.to_json
+
+      # Send the request
+      response = http.request(request)
+      if response.code.to_i != 200
+        puts "[OutlyerHandler] Outlyer API Error -- API responded with status code " + response.code
+        puts response.body
+      end
+    end
+  # Raised when any metrics could not be sent
+  #
+  rescue Timeout::Error
+    puts '[OutlyerHandler] Outlyer API Error -- timed out while sending metrics'
+  rescue => error
+    puts "[OutlyerHandler] Outlyer API Error -- failed to send metrics: #{error.message}"
+    puts " #{error.backtrace.join("\n\t")}"
+  end
+end

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

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

data/lib/sensu-plugins-outlyer.rb

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

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-outlyer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dataloop Software, INC. Trading as Outlyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-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.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !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: 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !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: Sensu plugins for Outlyer
+email: "<support@outlyer.com>"
+executables:
+- outlyer-metrics.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/outlyer-metrics.rb
+- lib/sensu-plugins-outlyer.rb
+- lib/sensu-plugins-outlyer/version.rb
+homepage: https://www.outlyer.com
+licenses:
+- MIT
+metadata:
+  maintainer: outlyer
+  development_status: unmaintained
+  production_status: unstable - testing recommended
+  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.5.2
+signing_key: 
+specification_version: 4
+summary: Sensu plugins for Outlyer
+test_files: []