nagios-splunk 0.0.1

data/README

@@ -0,0 +1,19 @@
+= Nagios::Splunk
+Nagios splunk plugin allows to check splunk license usage
+
+== API
+
+client = Nagios::Splunk::RestClient.new("http://admin:changeme@localhost:8089/")
+splunk = Nagios::Splunk::Check.new(client)
+
+warn = 80 # 80%
+crit = 90 # 90%
+
+splunk.license_usage(warn, crit) # => "License OK: 50% of license capacity is used | quota: 500 MB; used: 250 MB"
+
+== Usage:
+
+$ check_splunk -s http://admin:changeme@localhost:8089/ -w 60 -c 80
+"License OK: 50% of license capacity is used | quota: 500 MB; used: 250 MB"
+$ echo $?
+0

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake/testtask'
+require 'rake/gempackagetask'
+
+task :default => :test
+
+desc "Run tests"
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+gem_spec = eval(File.read("nagios-splunk.gemspec"))
+
+Rake::GemPackageTask.new(gem_spec) do |pkg|
+  pkg.gem_spec = gem_spec
+end
+
+desc "remove build files"
+task :clean do
+  sh %Q{ rm -f pkg/*.gem }
+end

data/bin/check_splunk

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'nagios/splunk'
+exit Nagios::Splunk::CLI.new.run

data/lib/nagios/splunk.rb

@@ -0,0 +1,16 @@
+module Nagios
+
+  STATUS = { 1 => "WARN", 2 => "CRITICAL", 0 => "OK" }
+
+  module Splunk
+
+    LOGIN_URL = "/services/auth/login"
+    POOL_LIST_URL = "/services/licenser/pools"
+    LICENSE_LIST_URL = "/services/licenser/licenses"
+
+    autoload :Check, "nagios/splunk/check"
+    autoload :RestClient, "nagios/splunk/rest_client"
+    autoload :CLI, "nagios/splunk/cli"
+
+  end
+end

data/lib/nagios/splunk/check.rb

@@ -0,0 +1,73 @@
+require 'nokogiri'
+
+module Nagios
+
+  module Splunk
+
+    # Nagios::Splunk::Check implements different types of checks of
+    class Check
+
+      attr_reader :rest_client
+
+      # @param [String] server_url full server url with username and password (RFC 3986)
+      # example: https://user:pass@localhost:8089/
+      def initialize(client)
+        @rest_client = client
+      end
+
+      # license usage check
+      # @param [Integer] warn license usage threshhold
+      # @param [Integer] crit license usage threshhold
+      # @return [Array<Integer, String>] exit code and message
+      def license_usage(warn, crit)
+        quota = licenses.
+          select {|k,v| v["type"] == "enterprise" && v["status"] == "VALID" }.
+          reduce(0) { |r,l| r+=l[1]["quota"].to_i }
+        used_quota = pools.reduce(0) {|r,p| r+=p[1]["used_bytes"].to_i }
+        case true
+        when used_quota > quota * crit.to_i / 100:
+            code = 2
+        when used_quota > quota * warn.to_i / 100:
+            code = 1
+        else
+          code = 0
+        end
+        message = "License #{STATUS[code]}: #{used_quota * 100 / quota}% of license capacity is used"
+        message << " | quota: #{quota} B; used: #{used_quota} B"
+        return [code, message]
+      end
+
+      # list of avialable licenses
+      # @return [Array<Hash>]
+      def licenses
+        response = rest_client.get(LICENSE_LIST_URL)
+        response.code == "200" ? parse_data(response.body) : {}
+      end
+
+      # list of available pools
+      # @return [Array<Hash>]
+      def pools
+        response = rest_client.get(POOL_LIST_URL)
+        response.code == "200" ? parse_data(response.body) : {}
+      end
+
+      private
+
+      def parse_data(data)
+        doc = Nokogiri::Slop(data)
+        doc.remove_namespaces!
+        doc.search("entry").reduce(Hash.new) do |r,e|
+          name = e.title.content
+          next r if name =~ /^F+D{0,1}$/
+          r[name] ||= Hash.new
+          e.search("dict/key").each do |k|
+            r[name][k.attribute("name").value] = k.text
+          end
+          r
+        end
+      end
+
+    end
+
+  end
+end

data/lib/nagios/splunk/cli.rb

@@ -0,0 +1,42 @@
+require 'mixlib/cli'
+
+module Nagios
+  module Splunk
+
+    class CLI
+      include Mixlib::CLI
+
+      option(:server_url,
+             :short => "-s URL",
+             :long  => "--server URL",
+             :required => true,
+             :description => "Splunk server url",
+             :on => :head)
+
+      option(:warn,
+             :short => "-w WARN",
+             :long  => "--warn WARN",
+             :default => '80',
+             :description => "Warn % of license capacity usage (default: 80)")
+
+      option(:crit,
+             :short => "-c CRIT",
+             :long  => "--crit CRIT",
+             :default => '90',
+             :description => "Critical % of license capacity usage (default: 90)")
+
+      def run(argv = ARGV)
+        parse_options(argv)
+
+        client = RestClient.new(config[:server_url])
+        splunk = Check.new(client)
+
+        status, message = splunk.license_usage(config[:warn], config[:crit])
+
+        puts message
+        status
+      end
+    end
+
+  end
+end

data/lib/nagios/splunk/rest_client.rb

@@ -0,0 +1,75 @@
+require 'net/https'
+
+module Nagios
+  module Splunk
+
+    # Rest client which communicates with Splunk via REST API
+    class RestClient
+
+      attr_reader :token
+
+      # turn on/off debugging
+      # @param [<True, False>]
+      def self.debug(value = nil)
+        @debug = value if value
+        @debug
+      end
+
+      # parse server url string and set up intance variables
+      # @param [String] server_url full server url with username and password (RFC 3986)
+      # example: https://user:pass@localhost:8089/
+      def initialize(server_url)
+        uri = URI.parse(server_url)
+        @host = uri.host
+        @port = uri.port
+        @username = uri.user
+        @password = uri.password
+      end
+
+      # send HTTP request to the server
+      # @param [String] url
+      # @return [Net::HTTPRespose]
+      def get(url)
+        login unless token
+        response = client.request(request(url, token))
+      end
+
+      private
+
+      # build GET request and include Authorization
+      # @param [String] url
+      # @param [String] token authenticate token
+      def request(url, token)
+        headers = { "Authorization" => "Splunk #{token}" }
+        Net::HTTP::Get.new(url, headers)
+      end
+
+      # build HTTP connection
+      # @return [Net::HTTP]
+      def client
+        @client ||= Net::HTTP.new(@host, @port)
+        @client.use_ssl = true
+        @client.set_debug_output $stderr if debug
+        @client
+      end
+
+      def debug
+        self.class.debug
+      end
+
+      # receive authentication token
+      def login
+        request = Net::HTTP::Post.new(LOGIN_URL)
+        request.set_form_data({"username" => @username, "password" => @password})
+        response = client.request(request)
+        if response.code == "200"
+          doc = Nokogiri::XML.parse(response.body)
+          elem = doc.search("//sessionKey").first
+          @token = elem.text if elem
+        end
+      end
+
+    end
+
+  end
+end

data/nagios-splunk.gemspec

@@ -0,0 +1,27 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "nagios-splunk"
+  s.version     = "0.0.1"
+  s.authors     = 'Max Horbul'
+  s.email       = ["max@gorbul.net"]
+  s.homepage    = "https://github.com/mhorbul/nagios-splunk"
+  s.rubyforge_project = 'nagios-splunk'
+  s.summary     = "Nagios Splunk plugin"
+  s.description = "Splunk monitoring in Nagios"
+
+  s.files         = Dir['{bin/*,lib/**/*,test/*}'] +
+    %w{README Rakefile nagios-splunk.gemspec}
+
+  s.bindir          = 'bin'
+  s.executables     << 'check_splunk'
+  s.require_path    = 'lib'
+
+  s.add_dependency 'nokogiri'
+  s.add_dependency 'mixlib-cli'
+
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'rake'
+
+  s.has_rdoc = false
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+$:.push File.join(File.dirname(__FILE__), "../lib")
+
+require 'rubygems'
+require "bundler/setup"
+require 'nagios/splunk'
+require 'minitest/autorun'
+
+module MiniTest
+  def self.fixtures_path
+    File.expand_path(File.join(File.dirname(__FILE__), "fixtures"))
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: nagios-splunk
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Max Horbul
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-12 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mixlib-cli
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Splunk monitoring in Nagios
+email: 
+- max@gorbul.net
+executables: 
+- check_splunk
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/check_splunk
+- lib/nagios/splunk/check.rb
+- lib/nagios/splunk/cli.rb
+- lib/nagios/splunk/rest_client.rb
+- lib/nagios/splunk.rb
+- test/test_helper.rb
+- README
+- Rakefile
+- nagios-splunk.gemspec
+homepage: https://github.com/mhorbul/nagios-splunk
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: nagios-splunk
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Nagios Splunk plugin
+test_files: []
+