soar_auditing_provider 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 533e50f96d003eaf80b09fa70ec1154c7c28478f
-  data.tar.gz: 69cac5833f72d7f332f364cad8799ff091293e30
+  metadata.gz: 1b51be1b463900ba2715d257a51f3a0cdfa8c460
+  data.tar.gz: 3ef84c3086184040563844bf10e36c548fb97886
 SHA512:
-  metadata.gz: d7d3045035d9b59331a9d34a19ca88f52628f25dcd0bca2ea983ce2bd86562241576975040be9558072915a6a8fd4a529384cd344bd388e0f6930725a9e3116e
-  data.tar.gz: 614ffb3a1b13cb9e884ca84293ceabe88037dec32bfe56aa2d9c741b02d00e5c88c8ca2b97f8ab8ed49c481f7ec3551a6a398d2a289542e9bc68f31c877dac6a
+  metadata.gz: 57cea7784dab0e044ccefb314bef4579b06dddd823a8c7d0883d7628d73db9a1b4ef4f96df3a2d59183ebb6881eaaf5c184912c80ce2a8f3dc72a2e606d3cd90
+  data.tar.gz: bd2fd69d3e94fbb4dfa9e81779afa17e623a7807e6da60ca3b5595e47cbcfabadd80ed24c5db004535b3e7bd8383e96f01c0b29cc04721e5f469b69f6b23f0e4

data/lib/soar_auditing_provider/auditing_provider.rb

@@ -29,6 +29,7 @@ module SoarAuditingProvider
       create_auditing_worker
       @buffer_overflow_count = 0
       install_at_exit_handler
+      initialize_metrics
     end
 
     def select_auditor(nfrs)
@@ -68,13 +69,9 @@ module SoarAuditingProvider
     end
 
     def detailed_status
-      { 'audit_buffer_overflows' => @buffer_overflow_count,
-        'startup_flow_id'        => @startup_flow_id,
-        'failed_audit_attempts'  => @worker.failed_audit_attempts,
-        'successful_audits'      => @worker.successful_audits,
-        'total_audits'           => @worker.total_audits,
-        'latest_audit_timespan'  => @worker.latest_audit_timespan,
-        'latest_audit_timestamp' => @worker.latest_audit_timestamp }
+      detail = basic_status_detail
+      detail = detail.merge(verbose_status_detail) if @configuration['verbose_detail']
+      detail
     end
 
     def flush
@@ -113,6 +110,7 @@ module SoarAuditingProvider
 
     def enqueue(level, data)
       @worker.enqueue(level, data)
+      @enqueued_audit_events += 1
     rescue AuditingOverflowError
       increase_buffer_overflow_count
       $stderr.puts "Audit buffer full, unable to audit event : #{level} : #{data}"
@@ -160,5 +158,33 @@ module SoarAuditingProvider
       $stderr.puts 'Invalid auditor configuration'
       raise
     end
+
+    def initialize_metrics
+      @startup_timestamp     = Time.now.utc.iso8601(3)
+      @enqueued_audit_events = 0
+    end
+
+    def verbose_status_detail
+      {
+        'worker' => {
+          'dequeued_audits'                      => @worker.dequeued_audits,
+          'successful_audits'                    => @worker.successful_audits,
+          'failed_audit_attempts'                => @worker.failed_audit_attempts,
+          'latest_successful_audit_timespan'     => @worker.latest_successful_audit_timespan,
+          'latest_successful_audit_timestamp'    => @worker.latest_successful_audit_timestamp,
+          'latest_failed_audit_timestamp'        => @worker.latest_failed_audit_timestamp,
+          'latest_failed_audit_error_message'    => @worker.latest_failed_audit_error_message
+        }
+      }
+    end
+
+    def basic_status_detail
+      {
+        'audit_buffer_overflows' => @buffer_overflow_count,
+        'enqueued_audit_events'  => @enqueued_audit_events,
+        'startup_flow_id'        => @startup_flow_id,
+        'startup_timestamp'      => @startup_timestamp
+      }
+    end
   end
 end

data/lib/soar_auditing_provider/auditing_worker.rb

@@ -3,10 +3,12 @@ require 'soar_thread_worker/thread_worker'
 module SoarAuditingProvider
   class AuditingWorker < SoarThreadWorker::ThreadWorker
     attr_reader :failed_audit_attempts
+    attr_reader :latest_failed_audit_timestamp
+    attr_reader :latest_failed_audit_error_message
     attr_reader :successful_audits
-    attr_reader :total_audits
-    attr_reader :latest_audit_timespan
-    attr_reader :latest_audit_timestamp
+    attr_reader :dequeued_audits
+    attr_reader :latest_successful_audit_timespan
+    attr_reader :latest_successful_audit_timestamp
 
     def initialize
       @queue = Queue.new
@@ -43,7 +45,7 @@ module SoarAuditingProvider
 
     def execute
       audit_event = @queue.pop
-      @total_audits += 1
+      @dequeued_audits += 1
       failed_before = false
       begin
         if @stopping
@@ -53,7 +55,8 @@ module SoarAuditingProvider
         exponential_back_off(start_at_last_attempt: failed_before) {
           time_before_audit = Time.now
           @auditor_audit_method.call(audit_event[:level],audit_event[:data])
-          @latest_audit_timespan = Time.now - time_before_audit
+          @latest_successful_audit_timespan = (Time.now - time_before_audit).round(3)
+          @latest_successful_audit_timestamp = Time.now.utc.iso8601(3)
           @successful_audits += 1
         }
       rescue Exception => e
@@ -61,7 +64,6 @@ module SoarAuditingProvider
         failed_before = true
         retry
       end
-      @latest_audit_timestamp = Time.now.utc
       return false #indicates to thread worder that we are not done executing
     end
 
@@ -130,10 +132,12 @@ module SoarAuditingProvider
       end
       begin
         yield
-      rescue StandardError
+      rescue StandardError => exception
         # Any exception derived from StandardError is assumed to be a failure and
         # attempted again until it completes without an exception or an exception
         # not derived from StandardError
+        @latest_failed_audit_error_message = "#{exception.class}: #{exception.message}"
+        @latest_failed_audit_timestamp = Time.now.utc.iso8601(3)
         @failed_audit_attempts += 1
         if ((attempt <= @maximum_back_off_attempts) and (not @stopping)) then
           sleep_unless_stopping(calculate_back_off_delay(attempt))
@@ -165,10 +169,12 @@ module SoarAuditingProvider
 
     def initialize_metrics
       @failed_audit_attempts = 0
+      @latest_failed_audit_timestamp = 0
       @successful_audits = 0
-      @total_audits = 0
-      @latest_audit_timespan = 0
-      @latest_audit_timestamp = 0
+      @latest_successful_audit_timestamp = 0
+      @dequeued_audits = 0
+      @latest_successful_audit_timespan = 0
+      @latest_failed_audit_error_message = "None"
     end
   end
 end

data/lib/soar_auditing_provider/version.rb

@@ -1,3 +1,3 @@
 module SoarAuditingProvider
-  VERSION = "1.1.1"
+  VERSION = "1.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soar_auditing_provider
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Ernst van Graan
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-06 00:00:00.000000000 Z
+date: 2016-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler