sensu-plugins-oracle 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e05bc65c5bf93831644ccdebae43ecc27f7a35ab
-  data.tar.gz: 853e25216e18f24f0ec94d2c357f805dcfc1e228
+  metadata.gz: 3870e038023cfb7baa04fdaeb18d24e1cf5d620a
+  data.tar.gz: 374295249f2a24d15736fcfbf6c70b791b0ef8ac
 SHA512:
-  metadata.gz: 95dbd868e884e2aa3692de4a8d8d37320f946c5b2b2fd62fd57745307653ba555d3d5a8dc082111a3182e9c74193c7cc5dd505440575cb8f2f5499451c8682a2
-  data.tar.gz: 6e26c529fb09bb2c330d09155011b393e7327b12b4de2d2844d001dfc2ad25cd807490f886fbe77920ad0ed9b721bd7be4032e9c23546e989029bac770ff939a
+  metadata.gz: 4f40c0f3d54c7d5d007c10ae1783d0f6c67cdc0ad11b930b9bacf6216a7220303031cbc5575a0c686f049a5e1d449ff572975d9b29167e1216bc9eb929277bf6
+  data.tar.gz: bbffaeac68eef29e2da04fcbf82d1a81f05b8869beb7c02ee5feaae5e88a857843049d63f59d964934d01de65c4fbb33cd7c8146a121f86e4584e035c98f2d08

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.0 - 2016-08-04
+### Added
+- first version which is able to check a single or multiple oracle connections
+
 ## 0.0.1 - 2016-08-03
 ### Added
 - initial release based on sensu-plugins-postgres (https://github.com/sensu-plugins/sensu-plugins-postgres)

data/README.md

@@ -1,4 +1,5 @@
 
+[![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)
 [![Dependency Status](https://gemnasium.com/badges/github.com/thomis/sensu-plugins-oracle.svg)](https://gemnasium.com/github.com/thomis/sensu-plugins-oracle)
 
@@ -7,25 +8,37 @@
 This sensu plugin provides native Oracle instrumentation.
 
 ## Files
- * bin/check-oracle-alive.rb
+  * bin/check-oracle-alive.rb
+  * bin/check-oracle-query.rb
 
 ## Usage
 
   ```
+  -- check a single connection
   check-oracle-alive.rb -u scott -p tiger -d hr
 
-  check-oracle-alive.rb -u scott -p tiger -d ht -T 30
+  -- check a single connection with timeout
+  check-oracle-alive.rb -u scott -p tiger -d hr -T 30
   ```
 
   ```
+  -- check multiple connections as defined in a file
   check-oracle-alive.rb -f connections.csv
 
   > cat connections.csv
-  # production connection
-  example_connection_1,scott/tiger@hr
+    # production connection
+    example_connection_1,scott/tiger@hr
 
-  # test connection
-  example_connection_2,scott/tiger@hr_test
+    # test connection
+    example_connection_2,scott/tiger@hr_test
+  ```
+
+  ```
+  -- check for invalid objects in a schema, show 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
+  check-oracle-query.rb -f connections.csv -t -s -query "select object_type, object_name from user_objects where status = 'INVALID'" -c 'value > 0'
 
   ```
 

data/bin/check-oracle-alive.rb

@@ -17,7 +17,7 @@
 #   gem: ruby-oci8
 #
 # USAGE:
-#   ./check-oracle-alive.rb -u db_user -p db_pass -h db_host -d db
+#   ./check-oracle-alive.rb -u USERNAME -p PASSWORD -d DATABASE -P PRIVILEGE -T TIMEOUT -f FILE
 #
 # NOTES:
 #
@@ -30,7 +30,7 @@
 require 'sensu-plugins-oracle'
 require 'sensu-plugin/check/cli'
 
-class CheckOracle < Sensu::Plugin::Check::CLI
+class CheckOracleAlive < Sensu::Plugin::Check::CLI
   option :username,
          description: 'Oracle Username',
          short: '-u USERNAME',

data/bin/check-oracle-query.rb

@@ -0,0 +1,184 @@
+#! /usr/bin/env ruby
+#
+#   check-oracle-alive
+#
+# DESCRIPTION:
+#
+#   This plugin attempts to login to oracle with provided credentials.
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: ruby-oci8
+#
+# USAGE:
+#   ./check-oracle-alive.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:
+#
+# LICENSE:
+#   Copyright (c) 2016 Thomas Steiner
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugins-oracle'
+require 'sensu-plugin/check/cli'
+
+# Check Oracle Query
+class CheckOracleQuery < Sensu::Plugin::Check::CLI
+  option :username,
+         description: 'Oracle Username',
+         short: '-u USERNAME',
+         long: '--username USERNAME'
+
+  option :password,
+         description: 'Oracle Password',
+         short: '-p PASSWORD',
+         long: '--password PASSWORD'
+
+  option :database,
+         description: 'Database schema to connect to',
+         short: '-d DATABASE',
+         long: '--database DATABASE'
+
+  option :privilege,
+         description: 'Connect to Oracle database by optional priviledge (SYSDBA, SYSOPER, SYSASM,  , SYSDG or SYSKM)',
+         short: '-P PRIVILEGE',
+         long: '--privilege PRIVILEGE'
+
+  option :timeout,
+         description: 'Connection timeout (seconds)',
+         short: '-T TIMEOUT',
+         long: '--timeout TIMEOUT'
+
+  option :file,
+         description: 'File with connection strings to check',
+         short: '-f FILE',
+         long: '--file FILE'
+
+  option :query,
+         description: 'Database query to execute',
+         short: '-q QUERY',
+         long: '--query QUERY',
+         required: true
+
+  option :warning,
+         description: 'Warning threshold expression',
+         short: '-w WARNING',
+         long: '--warning WARNING',
+         default: nil
+
+  option :critical,
+         description: 'Critical threshold expression',
+         short: '-c CRITICAL',
+         long: '--critical CRITICAL',
+         default: nil
+
+  option :tuples,
+         description: 'Count the number of tuples (rows) returned by the query',
+         short: '-t',
+         long: '--tuples',
+         boolean: true,
+         default: false
+
+  option :show,
+         description: 'Show result records',
+         short: '-s',
+         long: '--show',
+         boolean: true,
+         default: false
+
+  def run
+    # handle OCI8 properties
+    OCI8.properties[:connect_timeout] = config[:timeout].to_i if config[:timeout]
+
+    if config[:file]
+      handle_connections_from_file
+    else
+      handle_connection
+    end
+  end
+
+  private
+
+  def handle_connection
+    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)
+    else
+      # issue with the query
+      critical session.error_message
+    end
+  end
+
+  def handle_connections_from_file
+    sessions = ::SensuPluginsOracle::Session.parse_from_file(config[:file])
+
+    sessions_total = sessions.size
+    results = Hash.new { |h, key| h[key] = [] }
+
+    thread_group = ThreadGroup.new
+    mutex = Mutex.new
+
+    sessions.each do |session|
+      thread_group.add Thread.new {
+
+        if session.query(config[:query].to_s)
+          method, message = session.handle_query_result(config)
+          mutex.synchronize do
+            results[method] << message
+          end
+        else
+          mutex.synchronize do
+            results[:critical] << session.error_message
+          end
+        end
+
+      }
+    end
+    thread_group.list.map(&:join)
+
+    # return summary plus warning and critical messages
+    sessions_ok = results[:ok].size
+
+    # default values
+    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
+
+    messages = [header.join(', ')]
+
+    if results[:warning].size > 0
+      method = :warning
+      messages << nil
+      messages << 'WARNING'
+      messages << results[:warning].compact.sort.join("\n\n")
+    end
+
+    if results[:critical].size > 0
+      method = :critical
+      messages << nil
+      messages << 'CRITICAL'
+      messages << results[:critical].compact.sort.join("\n\n")
+    end
+
+    send(method, messages.join("\n"))
+  rescue => e
+    unknown e.to_s
+  end
+
+end

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

@@ -1,3 +1,5 @@
+require 'dentaku'
+
 module SensuPluginsOracle
   class Session
 
@@ -7,11 +9,14 @@ module SensuPluginsOracle
 
     attr_reader :server_version
 
+    attr_accessor :rows
+
     PRIVILEDGES = [:SYSDBA, :SYSOPER, :SYSASM, :SYSBACKUP, :SYSDG, :SYSKM]
 
     def initialize(args)
       @name = args[:name]
       @error_message = nil
+      @rows = []
 
       @connect_string = args[:connect_string]
 
@@ -19,6 +24,8 @@ module SensuPluginsOracle
       @password = args[:password]
       @database = args[:database]
       @priviledge = args[:priviledge].upcase.to_sym if args[:priviledge] && PRIVILEDGES.include?(args[:priviledge].upcase.to_sym)
+
+      @provide_name_in_result = args[:provide_name_in_result] || false
     end
 
     def self.parse_from_file(file)
@@ -29,7 +36,7 @@ module SensuPluginsOracle
           line.strip!
           next if line.size == 0 || line =~ /^#/
           a = line.split(/:|,|;/)
-          sessions << Session.new(name: a[0], connect_string: a[1])
+          sessions << Session.new(name: a[0], connect_string: a[1], provide_name_in_result: true)
         end
       end
 
@@ -37,17 +44,68 @@ module SensuPluginsOracle
     end
 
     def alive?
-      connection = OCI8.new(@connect_string) if @connect_string
-      connection = OCI8.new(@username, @password, @database) if @username
-
-      @server_version = connection.oracle_server_version
-
+      connect
+      @server_version = @connection.oracle_server_version
       true
-    rescue OCIError => e
+    rescue StandardError, OCIError => e
       @error_message = [@name, e.message.split("\n").first].compact.join(": ")
       false
     ensure
-      connection.logoff if connection
+      disconnect
+    end
+
+    def query(query_string)
+      connect
+      @rows = []
+
+      cursor = @connection.exec(query_string)
+
+      @rows = []
+      while row = cursor.fetch
+        @rows << row
+      end
+      cursor.close
+
+      return true
+    rescue StandardError, OCIError => e
+      @error_message = [@name, e.message.split("\n").first].compact.join(": ")
+      return false
+    end
+
+    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
+      return :critical, show(config[:show]) if config[:critical] && calc.evaluate(config[:critical], value: value)
+      return :warning, show(config[:show]) if config[:warning] && calc.evaluate(config[:warning], value: value)
+      return :ok, show(config[:show])
+    end
+
+    private
+
+    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.join("\n")
+    end
+
+    def connect
+      return if @connection
+
+      if @username
+        @connection = OCI8.new(@username.to_s, @password.to_s, @database.to_s)
+      else
+        @connection = OCI8.new(@connect_string.to_s)
+      end
+    end
+
+    def disconnect
+      @connection.logoff if @connection
+      @connection = nil
     end
 
   end

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

@@ -1,7 +1,7 @@
 module SensuPluginsOracle
   module Version
     MAJOR = 0
-    MINOR = 1
+    MINOR = 3
     PATCH = 0
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-oracle
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-04 00:00:00.000000000 Z
+date: 2016-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -28,16 +28,30 @@ dependencies:
   name: ruby-oci8
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: dentaku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.9
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,12 +108,27 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 description: |-
   This plugin provides native Oracle
                                 instrumentation.
 email: "<thomas.steiner@ikey.ch>"
 executables:
 - check-oracle-alive.rb
+- check-oracle-query.rb
 extensions: []
 extra_rdoc_files: []
 files:
@@ -107,6 +136,7 @@ files:
 - LICENSE
 - README.md
 - bin/check-oracle-alive.rb
+- bin/check-oracle-query.rb
 - lib/sensu-plugins-oracle.rb
 - lib/sensu-plugins-oracle/session.rb
 - lib/sensu-plugins-oracle/version.rb
@@ -114,7 +144,7 @@ homepage: https://github.com/thomis/sensu-plugins-oracle
 licenses:
 - MIT
 metadata:
-  maintainer: "@tas50"
+  maintainer: thomis
   development_status: active
   production_status: unstable - testing recommended
   release_draft: 'false'