sensu-plugins-influxdb-handoff 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 54c87fe342ff71e94053eeb9b5566f2a30c0f464
+  data.tar.gz: 803f1a5ee8529dda5904cd19ffeab850acdb58da
+SHA512:
+  metadata.gz: 57b9a500ec47f40cb81b0d5dcf64544ec8ca6009699cbc1876cf6647da363984a105add4df7852e3ba62559d214f289a1ed9b79da06bca541695a3bbf66e1355
+  data.tar.gz: 49ab6415674551198a326a3d3a94681df1b185451ef349eb4f90cdf0197d5c9b4d721ff77f3608b1d67a2bb0b7baa47ac19f365058e4998480d2b64677c01341

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+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.1.0] - 2017-03-06
+### Added
+- initial release
+
+[0.1.0]: https://github.com/ve-interactive/sensu-plugins-influxdb-handoff/compare/0.1.0...HEAD

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Andy Royle
+
+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,50 @@
+## sensu-plugins-influxdb-handoff
+
+[ ![Build Status](https://travis-ci.org/ve-interactive/sensu-plugins-influxdb-handoff.svg?branch=master)](https://travis-ci.org/ve-interactive/sensu-plugins-influxdb-handoff)
+[![Gem Version](https://badge.fury.io/rb/sensu-plugins-influxdb-handoff.svg)](http://badge.fury.io/rb/sensu-plugins-influxdb-handoff)
+[![Code Climate](https://codeclimate.com/github/ve-interactive/sensu-plugins-influxdb-handoff/badges/gpa.svg)](https://codeclimate.com/github/ve-interactive/sensu-plugins-influxdb-handoff)
+[![Test Coverage](https://codeclimate.com/github/ve-interactive/sensu-plugins-influxdb-handoff/badges/coverage.svg)](https://codeclimate.com/github/ve-interactive/sensu-plugins-influxdb-handoff)
+
+## Functionality
+
+## Files
+ * bin/handler-influxdb-handoff.rb
+
+## Usage
+
+**example config:**
+```json
+{
+  "handlers": {
+    "influxdb-handoff": {
+      "command": "/opt/sensu/embedded/bin/handler-influxdb-handoff.rb",
+      "type": "pipe",
+      "filters": [],
+      "severities": ["critical"]
+    }
+  },
+  "influxdb-handoff": {
+    "user": "myuser",
+    "keyfile": "/home/user/.ssh/id_rsa",
+    "handoff_dir": "/var/lib/influxdb/hh/*",
+    "lockfile": "/var/run/influxdb/handoff.lock",
+    "quiet_period": "300"
+  }
+}
+```
+
+**options:**
+
+- `user`: ssh user to connect as
+- `keyfile`: private key file to use for ssh, cannot be used with `password`
+- `password`: password for ssh authentication, cannot be used with `keyfile`
+- `handoff_dir`: directory where handoff data is stored
+- `lockfile`: local lockfile to prevent multiple concurrent runs
+- `quiet_period`: period (in seconds) between runs of the handler
+
+## Installation
+
+[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
+
+## Notes
+The ruby executables are installed in a path similar to `/opt/sensu/embedded/lib/ruby/gems/2.3.0/gems/sensu-plugins-influxdb-handoff-0.1.0/bin`

data/bin/handler-influxdb-handoff.rb

@@ -0,0 +1,96 @@
+#!/usr/bin/env ruby
+
+require 'sensu-handler'
+require 'net/ssh'
+require 'net/http'
+require 'time'
+require 'sensu-plugins-influxdb-handoff'
+
+class InfluxDBHandoff < Sensu::Handler
+  def filter; end
+
+  def handle
+    puts 'handoff dir handler starting'
+
+    config = settings['influxdb-handoff']
+
+    ssh_user = config['user']
+    ssh_password = config['password']
+    ssh_keyfile = config['keyfile']
+    ssh_keydata = config['keydata']
+    handoff_dir = config['handoff_dir']
+
+    lockfile = config['lockfile']
+    quiet_period = config['quiet_period'].to_i
+
+    ssh_options = {}
+    ssh_options[:password] = ssh_password unless ssh_password.nil?
+    ssh_options[:keys] = ssh_keyfile.nil? ? [] : [ssh_keyfile]
+    ssh_options[:key_data] = ssh_keydata unless ssh_keydata.nil?
+    ssh_options[:auth_methods] = ssh_password.nil? ? ['publickey'] : ['password']
+
+    host = @event['client']['name']
+    executed = @event['check']['executed'].to_i
+    action = @event['action']
+
+    if action == 'resolve'
+      puts 'action = resolve, nothing to do'
+      return
+    end
+
+    if File.exist?(lockfile)
+      lockfile_time = IO.readlines(lockfile)[0].to_i
+      puts "lockfile_time: #{lockfile_time}"
+
+      if (executed - lockfile_time) < quiet_period
+        puts 'influxdb-handoff: exiting because lockfile is too new'
+        return
+      end
+    end
+
+    File.open(lockfile, 'w') { |file| file.write(Time.now.to_i) }
+
+    Net::SSH.start(host, ssh_user, ssh_options) do |ssh|
+      result = ssh_exec(ssh, 'sudo service influxdb stop')
+      throw_if_not_ok(result)
+
+      result = ssh_exec(ssh, "rm -rf #{handoff_dir}")
+      throw_if_not_ok(result)
+
+      result = ssh_exec(ssh, 'sudo service influxdb start')
+      throw_if_not_ok(result)
+    end
+
+    wait_for_ok(host)
+
+    puts 'handoff dir handler finished'
+
+  rescue => error
+    STDERR.puts "influxdb-handoff: #{error}"
+  end
+
+  def ssh_exec(ssh, cmd)
+    SensuPluginsInfluxDBHandoff::SshExec.ssh_exec!(ssh, cmd)
+  end
+
+  def throw_if_not_ok(result)
+    raise "sshexec error: STDOUT: #{result.stdout}, STDERR: #{result.stderr}, code: #{result.exit_status}" unless result.exit_status == 0
+  end
+
+  def wait_for_ok(host)
+    uri = URI("http://#{host}:8086/ping")
+    res = nil
+    count = 0
+
+    until res.is_a?(Net::HTTPSuccess)
+      sleep(10)
+      res = Net::HTTP.get_response(uri)
+      puts res.code
+      count += 1
+
+      if count >= 20
+        raise "timed out waiting for influxdb to start again, last response #{res.code} #{res.message}"
+      end
+    end
+  end
+end

data/lib/sensu-plugins-influxdb-handoff.rb

@@ -0,0 +1,2 @@
+require 'sensu-plugins-influxdb-handoff/version'
+require 'sensu-plugins-influxdb-handoff/ssh-exec'

data/lib/sensu-plugins-influxdb-handoff/ssh-exec.rb

@@ -0,0 +1,100 @@
+require 'net/ssh'
+require 'ostruct'
+require 'logger'
+
+# copy-pasted from https://rubygems.org/gems/ssh-exec/ to solve dependency issues
+
+module SensuPluginsInfluxDBHandoff
+  module SshExec
+    log = Logger.new(STDOUT)
+    log.level = Logger::INFO
+
+    class ExecutionError < StandardError
+      attr_reader :object
+
+      def initialize(object)
+        @object = object
+      end
+    end
+
+    # Execute the given command using the given ssh object and capture its standard output, standard
+    # error, and exit status. The implementation is based on this
+    # {http://stackoverflow.com/questions/3386233/how-to-get-exit-status-with-rubys-netssh-library/3386375#3386375
+    # StackOveflow answer}.
+    # @param ssh the Net::SSH shell to run the command in
+    # @param options [Hash] optional settings:
+    #   `echo_stdout` - whether to echo standard output from the subcommand,
+    #   `echo_stderr` - whether to echo standard error from the subcommand
+    # @return [OpenStruct] a struct containing `stdout`, `stderr`, `exit_status`, and `exit_signal`
+    def self.ssh_exec!(ssh, command, options = {})
+      options = options.clone
+      echo_stdout = options[:echo_stdout]
+      echo_stderr = options[:echo_stderr]
+      raise "Invalid options: #{options}" unless options.empty?
+
+      stdout_data = ''
+      stderr_data = ''
+      exit_code = nil
+      exit_signal = nil
+      ssh.open_channel do |channel|
+        channel.exec(command) do |_, success|
+          unless success
+            raise "FAILED: couldn't execute command #{command}"
+          end
+          channel.on_data do |_, data|
+            stdout_data += data
+            $stdout.write(data) if echo_stdout
+          end
+
+          channel.on_extended_data do |_, _, data|
+            stderr_data += data
+            $stderr.write(data) if echo_stderr
+          end
+
+          channel.on_request('exit-status') do |_, data|
+            exit_code = data.read_long
+          end
+
+          channel.on_request('exit-signal') do |_, data|
+            exit_signal = data.read_long
+          end
+        end
+      end
+      ssh.loop
+      OpenStruct.new(
+        stdout: stdout_data,
+        stderr: stderr_data,
+        exit_status: exit_code,
+        exit_signal: exit_signal
+      )
+    end
+
+    # Runs the given command in the given SSH shell, and raises ExecutionError
+    # in case of failure (nonzero exit status). Logs the command in all cases.
+    # Logs the command, exit status, standard output and standard error in case of failure.
+    # @param ssh the Net::SSH shell to run the command in
+    # @param options [Hash] optional settings:
+    #   `echo_stdout` - whether to echo stdout from the subcommand,
+    #   `echo_stderr` - whether to echo stderr from the subcommand,
+    #   `quiet` - to suppress logging the command and the error in case of non-zero exit status
+    # @return [OpenStruct] a struct containing `stdout`, `stderr`, `exit_status`, and `exit_signal`
+    def self.ensure_exec(ssh, command, options = {})
+      result = ssh_exec!(ssh, command, options)
+
+      options = options.clone
+      quiet = options.delete(:quiet)
+
+      @@log.info("Running on #{ssh.host}: #{command}") unless quiet
+
+      if result.exit_status != 0
+        @@log.error(
+          ("Failed running command #{command}: exit status #{result.exit_status}. " +
+          (result.stdout.empty? ? '' : "Standard output:\n#{result.stdout}\n") +
+          (result.stderr.empty? ? '' : "Standard error:\n#{result.stderr}")).strip
+        ) unless quiet
+        raise ExecutionError, "Failed running command #{command}: exit status #{result.exit_status}"
+      end
+      result
+    end
+  end
+end

data/lib/sensu-plugins-influxdb-handoff/version.rb

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

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-influxdb-handoff
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andy Royle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-07 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: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !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: 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: 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 handler for clearing the influxdb handoff dir
+email: "<ajroyle@gmail.com>"
+executables:
+- handler-influxdb-handoff.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/handler-influxdb-handoff.rb
+- lib/sensu-plugins-influxdb-handoff.rb
+- lib/sensu-plugins-influxdb-handoff/ssh-exec.rb
+- lib/sensu-plugins-influxdb-handoff/version.rb
+homepage: https://github.com/ve-interactive/sensu-plugins-influxdb-handoff
+licenses:
+- MIT
+metadata:
+  maintainer: ve-interactive
+  development_status: active
+  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.4.8
+signing_key: 
+specification_version: 4
+summary: Sensu plugins for clearing the influxdb handoff dir
+test_files: []