senedsa 0.0.4.0

data/LICENSE

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2012 by Evernote Corporation, All rights reserved.
+ *
+ * Use of the source code and binary libraries included in this package
+ * is permitted under the following terms:
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+ * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.    
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License. You may obtain a 
+ * copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ */

data/README.md

@@ -0,0 +1,111 @@
+# OVERVIEW
+
+*Senedsa* is a small utility and library that wraps around the Nagios `send_nsca` utility, which must be available in your system. *Senedsa* assumes by default that `send_nsca` is available in your PATH and that `send_nsca`'s configuration file is in its default location. Both of these items can be overriden via options in the configuration file or in the command line.
+
+# SYNOPSIS
+
+    senedsa [options] svc_output
+
+Options are as follows:
+
+	Senedsa options
+		-C, --config CONFIG              senedsa configuration file
+
+	NSCA options:
+    	-H, --nsca_hostname HOSTNAME     NSCA server hostname                              [REQUIRED]
+    	-p, --nsca_port PORT             NSCA server port
+
+	Send_Nsca options:
+	    -t, --send_nsca_timeout TIMEOUT  send_nsca connection timeout
+    	-d, --send_nsca_delim DELIM      send_nsca field delimited
+    	-c, --send_nsca_config CONFIG    send_nsca configuration file
+    	-b, --send_nsca_binary BINARY    send_nsca binary path
+
+	Service (svc_) options:
+    	-h, --svc_hostname HOSTNAME      service hostname                                  [REQUIRED]
+    	-S, --svc_descr DESCR            service description                               [REQUIRED]
+    	-s, --svc_status STATUS          service status: ok, warning, critical, unknown    [REQUIRED]
+
+	General options:
+    	-a, --about                      Display senedsa information
+    	-V, --version                    Display senedsa version
+            --help                       Show this message
+ 
+With no options or arguments, `senedsa` displays help (as shown above). Options `-H`, `-h`, `-S` and `-s` are mandatory (unless specified in the configuration file); `svc_output` need not be quoted: anything passed as an argument is considered part of `svc_output`.
+
+# CONFIGURATION
+
+A YAML-based configuration (default location is `~/.senedsa/config`) can be used to set defaults for any option (except `senedsa_config`), which can then be overriden in the command line. This is useful, for instance, if the `send_nsca` binary is not in your PATH, its configuration file is not in the default location, or so that the NSCA server hostname need not be specified on the command line in every invocation. Use long option names to set the corresponding values:
+
+    ---
+    :send_nsca_binary: /usr/local/bin/send_nsca
+    :send_nsca_config: /local/etc/nagios/send_nsca.cfg
+    :nsca_hostname: nsca.example.com
+
+Thus, we can now run `senedsa` like so:
+
+    senedsa -h myhost.example.com -S mypassiveservice -s ok Everthing ok with myservice
+    
+In extreme cases, where `senedsa` is being used by some external script for a specific host and service (assume `send_nsca` is in the PATH and the configuration is its standard location), the configuration file `/etc/senedsa.foo` could be:
+
+	---
+	:nsca_hostname: nsca.example.com
+	:send_nsca_hostname: my.hostname.example.com
+	:send_nsca_descr: script_service
+	
+Then, the script would invoke `senedsa` as follows:
+
+	senedsa -C /etc/senedsa.foo -s ok service is doing great
+
+# LIBRARY
+
+Using *Senedsa* as a library:
+
+    require 'senedsa/send_nsca'
+    
+    begin
+      @send_nsca = SendNsca.new hostname, svc_descr, :nsca_hostname => nsca.example.com
+      @send_nsca.send(:ok,"Everything ok with my service")
+    rescue => e
+      # rescue logic
+    end
+    
+If you wish to use a configuration file to set defaults:
+
+	---
+	:nsca_hostname: nsca.example.com
+	:send_nsca_hostname: my.hostname.example.com
+
+Then:
+
+	begin
+	  cfg_options = SendNsca.configure(cfg_file)
+      @send_nsca = SendNsca.new hostname, svc_descr, cfg_options
+      @send_nsca.send(:ok,"Everything ok with my service")
+    rescue => e
+      # rescue logic
+    end
+
+Alternatively, you can set defaults in the `SendNsca` class before creating any instances:
+
+    SendNsca.defaults[:nsca_hostname] = "nsca.example.com"
+    @send_nsca = SendNsca.new svc_hostname, svc_descr
+    @send_nsca.send :ok, "Everything ok with my service"
+
+After a SendNsca instance is created, changing the defaults has no effect on said instance. You must then make changes to the instance itself:
+
+	@send_nsca = SendNsca.new hostname, svc_descr
+	@send_nsca.hostname = "nsca.example.com"
+    
+If you have multiple services in the same host:
+
+	SendNsca.nsca.hostname = "nsca.example.com"                      # default NSCA server
+	SendNsca.send_nsca.binary = "/usr/local/bin/send_nsca"           # default binary location
+	SendNsca.send_nsca.config = "/local/etc/nagios/send_nsca.cfg"    # default config location
+	
+	svc1 = SendNsca.new hostname, "service 1"
+	svc2 = SendNsca.new hostname, "service 2"
+	
+	svc1.send :warning, "Service is flaking out"
+	svc2.send :critical, "Service is dead"
+	

data/bin/senedsa

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby -w
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'senedsa'
+
+module Senedsa
+
+  app = CLI.new(ARGV)
+  app.run
+
+end

data/lib/senedsa.rb

@@ -0,0 +1,7 @@
+require 'senedsa/version'
+require 'senedsa/about'
+require 'senedsa/send_nsca'
+require 'senedsa/cli'
+
+module Senedsa
+end

data/lib/senedsa/about.rb

@@ -0,0 +1,4 @@
+module Senedsa
+  ME = :senedsa
+  ABOUT = "#{ME} v#{VERSION}\nhttps://github.com/evernote/ops-#{ME}\nCopyright (c) 2012 by Evernote Corporation\nLicensed under the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)"
+end

data/lib/senedsa/cli.rb

@@ -0,0 +1,122 @@
+require 'optparse'
+require 'yaml'
+require 'awesome_print'
+
+module Senedsa
+
+  class CLI
+
+    ID = File.basename($PROGRAM_NAME).to_sym
+    CFGFILE = File.join(ENV['HOME'],"/.#{ID}/config")
+
+    attr_reader :options
+
+    def initialize(arguments)
+      @arguments = arguments
+      @cli_options = { :senedsa_config => CFGFILE, :debug => false }
+      @options = {}
+    end
+
+    def run
+      begin
+        parsed_options?
+        config_options?
+        arguments_valid?
+        options_valid?
+      rescue ArgumentError, OptionParser::MissingArgument, StandardError => e
+        output_message e.message, 1
+      end
+      process_options
+      process_arguments
+      process_command
+    end
+
+    protected
+      def parsed_options?
+        begin
+          opts = OptionParser.new
+
+          opts.banner = "Usage: #{ID} [options] svc_output"
+          opts.separator ""
+
+          opts.separator "Senedsa options"
+          opts.on('-C', '--config CONFIG',               String,                 "senedsa configuration file")                         { |config|    @cli_options[:senedsa_config] = config }
+          opts.separator ""
+
+          opts.separator "NSCA options:"
+          opts.on('-H', '--nsca_hostname HOSTNAME',      String,                 "NSCA server hostname")                               { |hostname|  @cli_options[:nsca_hostname] = hostname }
+          opts.on('-p', '--nsca_port PORT',              Integer,                "NSCA server port")                                   { |port|      @cli_options[:nsca_port] = port }
+          opts.separator ""
+
+          opts.separator "Send_Nsca options:"
+          opts.on('-t', '--send_nsca-timeout TIMEOUT',   Integer,                "send_nsca connection timeout")                       { |timeout|   @cli_options[:send_nsca_timeout] = timeout }
+          opts.on('-d', '--send_nsca-delim DELIM',       String,                 "send_nsca field delimited")                          { |delim|     @cli_options[:send_nsca_delim] = delim }
+          opts.on('-c', '--send_nsca-config CONFIG',     String,                 "send_nsca configuration file")                       { |config|    @cli_options[:send_nsca_config] = config }
+          opts.on('-b', '--send_nsca-binary BINARY',     String,                 "send_nsca binary path")                              { |binary|    @cli_options[:send_nsca_binary] = binary }
+          opts.separator ""
+
+          opts.separator "Service options:"
+          opts.on('-h', '--hostname HOSTNAME',           String,                 "service hostname")                                   { |hostname|  @cli_options[:svc_hostname] = hostname }
+          opts.on('-S', '--service SVC_DESCR',           String,                 "service description")                                { |svc_descr| @cli_options[:svc_descr] = svc_descr }
+          opts.on('-s', '--status STATUS',               SendNsca::STATUS.keys,  "service status: #{SendNsca::STATUS.keys.join ', '}") { |status|    @cli_options[:svc_status] = status }
+          opts.separator ""
+
+          opts.separator "General options:"
+          opts.on('-a', '--about',                                               "Display #{ID} information")                          { output_message ABOUT, 0 }
+          opts.on('-V', '--version',                                             "Display #{ID} version")                              { output_message VERSION, 0 }
+          opts.on_tail('--help',                                                 "Show this message")                                  { output_message opts; exit 0 }
+
+          output_message opts, 0 if @arguments.size == 0
+
+          opts.parse!(@arguments)
+        rescue => e
+          output_message e.message, 1
+        end
+      end
+
+      def config_options?
+        cfg_options = SendNsca.configure(@cli_options[:senedsa_config])
+        raise
+        cfg_options.delete(:senedsa_config) unless cfg_options[:senedsa_config].nil?
+        @options.merge!(cfg_options)
+      end
+
+      def options_valid?
+        true
+      end
+
+      def arguments_valid?
+        raise ArgumentError, "must specify svc_output" unless @arguments.size > 0
+        true
+      end
+
+      def process_options
+        @options.merge!(@cli_options)
+        raise OptionParser::MissingArgument, "NSCA hostname (-H) must be specified" if @options[:nsca_hostname].nil?
+        raise OptionParser::MissingArgument, "service description (-S) must be specified" if @options[:svc_descr].nil?
+        raise OptionParser::MissingArgument, "service hostname (-h) must be specified" if @options[:svc_hostname].nil?
+        raise OptionParser::MissingArgument, "service status (-s) must be specified" if @options[:svc_status].nil?
+      end
+
+      def process_arguments
+        @arguments = @arguments.join(' ')
+      end
+
+      def output_message(message, exitstatus=nil)
+        m = (! exitstatus.nil? and exitstatus > 0) ? "%s: error: %s" % [ID, message] : message
+        $stderr.write "#{m}\n"
+        exit exitstatus unless exitstatus.nil?
+      end
+
+      def process_command
+        begin
+          @send_nsca = SendNsca.new @options[:svc_hostname], @options[:svc_descr], @options
+          @send_nsca.send(@options[:svc_status],@arguments)
+        rescue => e
+          output_message e.message, 1
+        end
+        exit 0
+      end
+  end
+
+end

data/lib/senedsa/send_nsca.rb

@@ -0,0 +1,84 @@
+require 'open3'
+
+module Senedsa
+
+  class SendNsca
+
+    STATUS = {
+        :ok       => 0,
+        :warning  => 1,
+        :critical => 2,
+        :unknown  => 3
+    }
+
+    @defaults = {
+        :send_nsca_binary => 'send_nsca',
+        :send_nsca_config => nil,
+        :send_nsca_delim => '\t',
+        :send_nsca_timeout => 10,
+        :nsca_hostname => nil,
+        :nsca_port => 5667,
+        :svc_hostname => nil,
+        :svc_descr => nil,
+        :svc_status => nil
+    }
+
+    class << self
+
+      attr_accessor :defaults end
+
+      def self.configure(cfg_file)
+        begin
+          cfg_options = YAML.load File.open(cfg_file)
+          raise ConfigurationError, "senedsa_config not allowed in configuration file (#{cfg_file})" unless cfg_options[:senedsa_config].nil?
+        rescue Psych::SyntaxError => e
+          raise StandardError, "syntax error in configuration file #{cfg_file}: #{e.message}"
+        rescue Errno::ENOENT, Errno::EACCES => e
+          raise StandardError, e.message
+        end
+        cfg_options
+      end
+
+    attr_accessor :send_nsca, :nsca
+
+    class Error < StandardError; end
+    class SendNscaError < Error; end
+    class ConfigurationError < SendNscaError; end
+
+    def initialize(svc_hostname,svc_descr,options)
+      @options = options.nil? ? SendNsca.defaults : SendNsca.defaults.merge(options)
+      @options[:svc_hostname] = svc_hostname
+      @options[:svc_descr] = svc_descr
+    end
+
+    SendNsca.defaults.keys.each do |attr|
+      define_method(attr.to_s) { @options[attr.to_sym] }
+      define_method(attr.to_s + '=') { |value| @options[attr.to_sym] = value }
+    end
+
+    def send(status,svc_output)
+      run(status,svc_output)
+    end
+
+    private
+
+      def command
+        c = "#{send_nsca_binary} -H #{nsca_hostname} -p #{nsca_port} -t #{send_nsca_timeout} -d '#{send_nsca_delim}'"
+        c << " -c #{send_nsca_config}" unless send_nsca_config.nil?
+        c
+      end
+
+      def run(status,svc_output)
+        begin
+          Open3.popen3(command) do |stdin, stdout, stderr, wait_thr|
+            stdin.write("%s\n" % [svc_hostname,svc_descr,STATUS[status],svc_output].join(send_nsca_delim))
+            $stdout.write stdout.gets
+            raise SendNscaError, stderr.gets.chomp unless wait_thr.value.exitstatus == 0
+          end
+        rescue Errno::ENOENT, Errno::EACCES => e
+          raise SendNscaError, e.message
+        end
+      end
+  end
+end
+

data/lib/senedsa/version.rb

@@ -0,0 +1,3 @@
+module Senedsa
+  VERSION = '0.0.4.0'
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: senedsa
+version: !ruby/object:Gem::Version
+  version: 0.0.4.0
+  prerelease: 
+platform: ruby
+authors:
+- Gerardo López-Fernádez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-25 00:00:00.000000000 Z
+dependencies: []
+description: Senedsa is a small utility and library wrapper for the Nagios send_nsca.
+email: gerir@evernote.com
+executables:
+- senedsa
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/senedsa/about.rb
+- lib/senedsa/cli.rb
+- lib/senedsa/send_nsca.rb
+- lib/senedsa/version.rb
+- lib/senedsa.rb
+- bin/senedsa
+- LICENSE
+- README.md
+homepage: https://github.com/evernote/ops-senedsa
+licenses:
+- Apache License, Version 2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.5
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Utility and library wrapper for Nagios send_nsca utility
+test_files: []
+has_rdoc: