sensu-plugins-oracle 0.6.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f8ca74b2373ad51c402a3496958f8f7fa8f3e53
-  data.tar.gz: d164d87f734ffd137a045a8da455eb4881c793fe
+  metadata.gz: 8754fe74e7bae6ba56d526c7f82e2cdc2cf7d25e
+  data.tar.gz: c08634c5b47caf6160e037d1a078922ffda78271
 SHA512:
-  metadata.gz: e08cc0b4b5b506704fa32b051fd1e93179442a4f6620265065b02a9eb059ffd41d5d57f83145cf047fe0ad977b8582637266b4875d526132696a1d0f3027ac6b
-  data.tar.gz: 3bd32501ea7e7a9451e18d90d362428cfb1c459df0aaead6daf01be59e76d1618bf560b4f4a2b9798a589047b23f58289f66538ba963515a74c5c2daa62516eb
+  metadata.gz: 086707b8af26c658237c93e7cea9063840a31a582c4ef51db0019c9034b864c978a6e533016a8b0160da23ba95c03f0a5a601734290b1e0aee629538228fb7aa
+  data.tar.gz: bbccf4e8ebf44b1f34e46d23a2d21df9d52aac5a26e567959bed49bff656f37d0da03e3016cc34898166997663e9ced24b65e6a0b213a5088219dbf75f0910a2

data/README.md

@@ -1,7 +1,8 @@
 
 [![Gem Version](https://badge.fury.io/rb/sensu-plugins-oracle.svg)](https://badge.fury.io/rb/sensu-plugins-oracle)
-[![Code Climate](https://codeclimate.com/github/thomis/sensu-plugins-oracle/badges/gpa.svg)](https://codeclimate.com/github/thomis/sensu-plugins-oracle)
+[![Maintainability](https://api.codeclimate.com/v1/badges/a96aadf931c023673c49/maintainability)](https://codeclimate.com/github/thomis/sensu-plugins-oracle/maintainability)
 [![Dependency Status](https://gemnasium.com/badges/github.com/thomis/sensu-plugins-oracle.svg)](https://gemnasium.com/github.com/thomis/sensu-plugins-oracle)
+[![Build Status](https://travis-ci.org/thomis/sensu-plugins-oracle.svg?branch=master)](https://travis-ci.org/thomis/sensu-plugins-oracle)
 
 # sensu-plugins-oracle
 
@@ -34,7 +35,7 @@ This sensu plugin provides native Oracle instrumentation.
   ```
 
   ```
-  -- check for invalid objects in a schema, show type and name if there are invalid objects (-s), define a ciritical boundary only (-c)
+  -- check for invalid objects in a schema, shows type and name if there are invalid objects (-s), define a ciritical boundary only (-c)
   check-oracle-query.rb -u scott -p tiger -d hr -t -s -query "select object_type, object_name from user_objects where status = 'INVALID'" -c "value > 0"
 
   -- same as above but check for all connections in a file, use 5 worker threads

data/bin/check-oracle-alive.rb

@@ -16,7 +16,8 @@
 #   gem: ruby-oci8
 #
 # USAGE:
-#   ./check-oracle-alive.rb -u USERNAME -p PASSWORD -d DATABASE -P PRIVILEGE -T TIMEOUT -f FILE
+#   ./check-oracle-alive.rb -u USERNAME -p PASSWORD -d DATABASE \
+#       -P PRIVILEGE -T TIMEOUT -f FILE
 #
 # NOTES:
 #
@@ -29,6 +30,7 @@
 require 'sensu-plugins-oracle'
 require 'sensu-plugin/check/cli'
 
+# Check Oracle Alive
 class CheckOracleAlive < Sensu::Plugin::Check::CLI
   option :username,
          description: 'Oracle Username',
@@ -46,7 +48,8 @@ class CheckOracleAlive < Sensu::Plugin::Check::CLI
          long: '--database DATABASE'
 
   option :privilege,
-         description: 'Connect to Oracle database by optional priviledge (SYSDBA, SYSOPER, SYSASM,  , SYSDG or SYSKM)',
+         description: 'Connect to Oracle database by optional priviledge' \
+                      ' (SYSDBA, SYSOPER, SYSASM,  , SYSDG or SYSKM)',
          short: '-P PRIVILEGE',
          long: '--privilege PRIVILEGE'
 
@@ -61,22 +64,35 @@ class CheckOracleAlive < Sensu::Plugin::Check::CLI
          long: '--file FILE'
 
   option :worker,
-         description: 'Number of worker threads to check for alive connections',
+         description: 'Number of worker threads to check' \
+                      ' for alive connections',
          short: '-W WORKER',
          long: '--worker WORKER',
          default: 1,
-         :proc => Proc.new { |v| v.to_i == 0 ? 1 : v.to_i }
+         proc: proc { |v| v.to_i.zero? ? 1 : v.to_i }
 
   option :verbose,
          description: 'Shows console log messages',
-         short: '-v',
+         short: '-V',
          long: '--verbose',
          boolean: true,
          default: false
 
+  option :version,
+         description: 'Shows current version',
+         short: '-v',
+         long: '--version',
+         boolean: true,
+         default: false
+
   def run
     # handle OCI8 properties
-    ::SensuPluginsOracle::Session.set_timeout_properties(config[:timeout])
+    ::SensuPluginsOracle::Session.timeout_properties(config[:timeout])
+
+    if config[:version]
+      ok("Version #{SensuPluginsOracle::Version::VER_STRING}")
+      return
+    end
 
     if config[:file]
       handle_connections_from_file
@@ -88,11 +104,10 @@ class CheckOracleAlive < Sensu::Plugin::Check::CLI
   private
 
   def handle_connection
-    session = SensuPluginsOracle::Session.new(
-      username: config[:username],
-      password: config[:password],
-      database: config[:database],
-      privilege: config[:privilege])
+    session = SensuPluginsOracle::Session.new(username: config[:username],
+                                              password: config[:password],
+                                              database: config[:database],
+                                              privilege: config[:privilege])
 
     if session.alive?
       ok "Server version: #{session.server_version}"
@@ -103,29 +118,27 @@ class CheckOracleAlive < Sensu::Plugin::Check::CLI
 
   def handle_connections_from_file
     sessions = ::SensuPluginsOracle::Session.parse_from_file(config[:file])
-    ::SensuPluginsOracle::Session.handle_multiple(
-      sessions: sessions,
-      method: :alive?,
-      config: config
-    )
+    ::SensuPluginsOracle::Session.handle_multiple(sessions: sessions,
+                                                  method: :alive?,
+                                                  config: config)
 
     errors = []
     sessions.each do |session|
-      errors << session.error_message if session.error_message
+      message = session.error_message
+      errors << message if message
     end
 
     sessions_total = sessions.size
     errors_total = errors.size
 
-    if errors_total == 0
+    if errors_total.zero?
       ok "All are alive (#{sessions_total}/#{sessions_total})"
     else
-      critical ["#{sessions_total - errors_total}/#{sessions_total} are alive", errors].flatten.join("\n - ")
+      message = "#{sessions_total - errors_total}/#{sessions_total} are alive"
+      critical([message, errors].flatten.join("\n - "))
     end
 
   rescue => e
     unknown e.to_s
   end
-
-
 end

data/bin/check-oracle-query.rb

@@ -3,7 +3,8 @@
 #   check-oracle-query
 #
 # DESCRIPTION:
-#   This plugin attempts to execute defined query against provided connection credential(s).
+#   This plugin attempts to execute defined query against provided
+#   connection credential(s).
 #
 # OUTPUT:
 #   plain text
@@ -16,7 +17,10 @@
 #   gem: ruby-oci8
 #
 # USAGE:
-#   ./check-oracle-query.rb -u USERNAME -p PASSWORD -d DATABASE -P PRIVILEGE -T TIMEOUT -f FILE -q 'select foo from bar' -w 'value > 5' -c 'value > 10'
+#   ./check-oracle-query.rb -u USERNAME -p PASSWORD -d DATABASE \
+#                           -P PRIVILEGE -T TIMEOUT -f FILE \
+#                           -q 'select foo from bar' \
+#                           -w 'value > 5' -c 'value > 10'
 #
 # NOTES:
 #
@@ -47,7 +51,8 @@ class CheckOracleQuery < Sensu::Plugin::Check::CLI
          long: '--database DATABASE'
 
   option :privilege,
-         description: 'Connect to Oracle database by optional priviledge (SYSDBA, SYSOPER, SYSASM,  , SYSDG or SYSKM)',
+         description: 'Connect to Oracle database by optional priviledge' \
+                      ' (SYSDBA, SYSOPER, SYSASM,  , SYSDG or SYSKM)',
          short: '-P PRIVILEGE',
          long: '--privilege PRIVILEGE'
 
@@ -94,22 +99,35 @@ class CheckOracleQuery < Sensu::Plugin::Check::CLI
          default: false
 
   option :worker,
-         description: 'Number of worker threads to execute query against provided connections',
+         description: 'Number of worker threads to execute query' \
+                      ' against provided connections',
          short: '-W WORKER',
          long: '--worker WORKER',
          default: 1,
-         :proc => Proc.new { |v| v.to_i == 0 ? 1 : v.to_i }
+         proc: proc { |v| v.to_i.zero? ? 1 : v.to_i }
 
   option :verbose,
          description: 'Shows console log messages',
-         short: '-v',
+         short: '-V',
          long: '--verbose',
          boolean: true,
          default: false
 
+  option :version,
+         description: 'Shows current version',
+         short: '-v',
+         long: '--version',
+         boolean: true,
+         default: false
+
   def run
     # handle OCI8 properties
-    ::SensuPluginsOracle::Session.set_timeout_properties(config[:timeout])
+    ::SensuPluginsOracle::Session.timeout_properties(config[:timeout])
+
+    if config[:version]
+      ok("Version #{SensuPluginsOracle::Version::VER_STRING}")
+      return
+    end
 
     if config[:file]
       handle_connections_from_file
@@ -121,15 +139,14 @@ class CheckOracleQuery < Sensu::Plugin::Check::CLI
   private
 
   def handle_connection
-    session = SensuPluginsOracle::Session.new(
-      username: config[:username],
-      password: config[:password],
-      database: config[:database],
-      privilege: config[:privilege])
+    session = SensuPluginsOracle::Session.new(username: config[:username],
+                                              password: config[:password],
+                                              database: config[:database],
+                                              privilege: config[:privilege])
 
     if session.query(config[:query].to_s)
       method, message = session.handle_query_result(config)
-      self.send(method, message)
+      send(method, message)
     else
       # issue with the query
       critical session.error_message
@@ -138,44 +155,46 @@ class CheckOracleQuery < Sensu::Plugin::Check::CLI
 
   def handle_connections_from_file
     sessions = ::SensuPluginsOracle::Session.parse_from_file(config[:file])
-    ::SensuPluginsOracle::Session.handle_multiple(
-      sessions: sessions,
-      method: :query,
-      method_arguments: config[:query].to_s,
-      config: config
-    )
+    ::SensuPluginsOracle::Session.handle_multiple(sessions: sessions,
+                                                  method: :query,
+                                                  config: config,
+                                                  method_args: config[:query])
 
     results = Hash.new { |h, key| h[key] = [] }
     sessions.each do |session|
-      if session.error_message
-        results[:critical] << session.error_message
+      message = session.error_message
+      if message
+        results[:critical] << message
       else
-        method, message = session.handle_query_result(config)
-        results[method] << message
+        type, message = session.handle_query_result(config)
+        results[type] << message
       end
     end
 
-    # return summary plus warning and critical messages
+    method, messages = summary(results, sessions.size)
+
+    send(method, messages.join("\n"))
+  rescue => e
+    unknown e.to_s
+  end
+
+  # returns summary based on header and detailed (warning & critical) messages
+  def summary(results, session_count)
+    # header
     method = :ok
-    header = ["Total: #{sessions.size}"]
-    header << "Ok: #{results[:ok].size}" if results[:ok].size > 0
-    header << "Warning: #{results[:warning].size}" if results[:warning].size > 0
-    header << "Critical: #{results[:critical].size}" if results[:critical].size > 0
+    headers = ["Total: #{session_count}"]
+    messages = []
 
-    messages = [header.join(', ')]
+    headers << "Ok: #{results[:ok].size}" unless results[:ok].empty?
 
     [:warning, :critical].each do |type|
-      if results[type].size > 0
-        method = type
-        messages << nil
-        messages << type.to_s.capitalize
-        messages << results[type].compact.sort.join("\n\n")
-      end
+      next if results[type].empty?
+      method = type
+      label = type.to_s.capitalize
+      headers << "#{label}: #{results[type].size}"
+      messages << [label, results[type].compact.sort.join("\n\n")]
     end
 
-    send(method, messages.join("\n"))
-  rescue => e
-    unknown e.to_s
+    [method, [headers, messages].flatten]
   end
-
 end

data/lib/sensu-plugins-oracle/session.rb

@@ -1,8 +1,8 @@
 require 'dentaku'
 
 module SensuPluginsOracle
+  # Session to handle oracle checks
   class Session
-
     attr_reader :name, :error_message
     attr_reader :connect_string
     attr_reader :username, :password, :database, :priviledge
@@ -11,7 +11,17 @@ module SensuPluginsOracle
 
     attr_accessor :rows
 
-    PRIVILEDGES = [:SYSDBA, :SYSOPER, :SYSASM, :SYSBACKUP, :SYSDG, :SYSKM]
+    PRIVILEDGES = [
+      :SYSDBA,
+      :SYSOPER,
+      :SYSASM,
+      :SYSBACKUP,
+      :SYSDG,
+      :SYSKM
+    ].freeze
+
+    # catch any error thrown within a thread during join call
+    Thread.abort_on_exception = true
 
     def initialize(args)
       @name = args[:name]
@@ -23,24 +33,23 @@ module SensuPluginsOracle
       @username = args[:username]
       @password = args[:password]
       @database = args[:database]
-      @priviledge = args[:priviledge].upcase.to_sym if args[:priviledge] && PRIVILEDGES.include?(args[:priviledge].upcase.to_sym)
-
+      @priviledge = validate_priviledge(args[:priviledge])
       @provide_name_in_result = args[:provide_name_in_result] || false
     end
 
     def self.parse_from_file(file)
       sessions = []
 
-      File.open(file) do |input|
-        input.each_line do |line|
-          line.strip!
-          next if line.size == 0 || line =~ /^#/
-          a = line.split(/:|,|;/)
-          sessions << Session.new(name: a[0], connect_string: a[1], provide_name_in_result: true)
-        end
+      File.read(file).each_line do |line|
+        line.strip!
+        next if line.size.zero? || line =~ /^#/
+        a = line.split(/:|,|;/)
+        sessions << Session.new(name: a[0],
+                                connect_string: a[1],
+                                provide_name_in_result: true)
       end
 
-      return sessions
+      sessions
     end
 
     def alive?
@@ -48,7 +57,7 @@ module SensuPluginsOracle
       @server_version = @connection.oracle_server_version
       true
     rescue StandardError, OCIError => e
-      @error_message = [@name, e.message.split("\n").first].compact.join(": ")
+      @error_message = [@name, e.message.split("\n").first].compact.join(': ')
       false
     ensure
       disconnect
@@ -68,25 +77,21 @@ module SensuPluginsOracle
 
       return true
     rescue StandardError, OCIError => e
-      @error_message = [@name, e.message.split("\n").first].compact.join(": ")
+      @error_message = [@name, e.message.split("\n").first].compact.join(': ')
       return false
     end
 
-    def handle_query_result(config={})
+    def handle_query_result(config = {})
       # check if query is ok, warning, or critical
       value = @rows.size
       value = @rows[0][0].to_f if @rows[0] && !config[:tuples]
 
-      calc = Dentaku::Calculator.new
+      method = evaluate(config, value)
 
-      method = :ok
-      method = :warning if config[:warning] && calc.evaluate(config[:warning], value: value)
-      method = :critical if config[:critical] && calc.evaluate(config[:critical], value: value)
-
-      return method, show(config[:show])
+      [method, show(config[:show])]
     end
 
-    def self.set_timeout_properties(timeout)
+    def self.timeout_properties(timeout)
       return unless timeout
       timeout = timeout.to_i
       OCI8.properties[:tcp_connect_timeout] = timeout
@@ -95,29 +100,34 @@ module SensuPluginsOracle
       OCI8.properties[:recv_timeout] = timeout
     end
 
-    def self.handle_multiple(args={})
+    def self.handle_multiple(args = {})
+      # queue with sesssion
       queue_sessions = Queue.new
 
       # feed the queue with sessions
-      args[:sessions].map{ |session| queue_sessions.push(session) }
+      args[:sessions].map { |session| queue_sessions.push(session) }
 
-      puts "Worker Threads: #{args[:config][:worker]}" if args[:config][:verbose]
+      if args[:config][:verbose]
+        puts "Worker Threads: #{args[:config][:worker]}"
+      end
 
       # start worker threads and handle requested sessions
       worker = (1..args[:config][:worker]).map do
         Thread.new do
-          begin
-            while session = queue_sessions.pop(true)
-              start = Time.now
-              puts "Processing #{session.name} - Method: #{args[:method]}" if args[:config][:verbose]
-              if args[:method_arguments]
-                session.send(args[:method], args[:method_arguments])
-              else
-                session.send(args[:method])
-              end
-              puts "Done       #{session.name}, took #{ '%0.1f' % ((Time.now - start)*1000)} ms" if args[:config][:verbose]
+          until queue_sessions.empty?
+            session = queue_sessions.pop(true)
+            start = Time.now
+            message = "Processing #{session.name} - Method: #{args[:method]}"
+            puts message if args[:config][:verbose]
+            if args[:method_args]
+              session.send(args[:method], args[:method_args])
+            else
+              session.send(args[:method])
             end
-          rescue ThreadError
+            message_done = format('Done       %s, took %0.1f ms',
+                                  session.name,
+                                  (Time.now - start) * 1000)
+            puts message_done if args[:config][:verbose]
           end
         end
       end
@@ -126,14 +136,37 @@ module SensuPluginsOracle
 
     private
 
-    def show(show_records=true)
+    def validate_priviledge(priviledge)
+      return nil unless priviledge
+      priviledge_symbol = priviledge.upcase.to_sym
+      return nil unless PRIVILEDGES.include?(priviledge_symbol)
+      priviledge_symbol
+    end
+
+    def show(show_records = true)
       return nil unless show_records
       buffer = []
       buffer << "#{@name} (#{@rows.size})" if @provide_name_in_result
-      buffer += @rows.map{ |row| '- ' + row.join(', ')}
+      buffer += @rows.map { |row| '- ' + row.join(', ') }
       buffer.join("\n")
     end
 
+    def evaluate(config, value)
+      calc = Dentaku::Calculator.new
+
+      method = :ok
+
+      if config[:warning] && calc.evaluate(config[:warning], value: value)
+        method = :warning
+      end
+
+      if config[:critical] && calc.evaluate(config[:critical], value: value)
+        method = :critical
+      end
+
+      method
+    end
+
     def connect
       return if @connection
 
@@ -148,6 +181,5 @@ module SensuPluginsOracle
       @connection.logoff if @connection
       @connection = nil
     end
-
   end
 end

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

@@ -1,9 +1,3 @@
 module SensuPluginsOracle
-  module Version
-    MAJOR = 0
-    MINOR = 6
-    PATCH = 0
-
-    VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
-  end
+  VERSION = '0.7.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-oracle
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.2
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-29 00:00:00.000000000 Z
+date: 2017-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -16,115 +16,113 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: ruby-oci8
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.4
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.4
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: dentaku
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.11
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.11
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.3
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.3
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: '12.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: '12.2'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.4
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.4
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.8
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.8
-description: |-
-  This plugin provides native Oracle
-                                instrumentation.
+        version: '1.0'
+description: This plugin provides native Oracle instrumentation.
 email: "<thomas.steiner@ikey.ch>"
 executables:
 - check-oracle-alive.rb