soar_auditing_provider 1.1.5 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 263b7fc728885f0bc350e4c339cb70c365ab0181
-  data.tar.gz: 2ef1bee6ad5a0b42568ceb41bdb6a621c3b9df77
+  metadata.gz: 68a71a4607fe41ceb5ecdca8da6bbb3286943eed
+  data.tar.gz: 447f4532707c1a4a5f27850af6a799c3588825b0
 SHA512:
-  metadata.gz: 0bd74895116aaa81c4dc780f42a54a5a569a16d8a3040eb26affabffa64dc43d13cd9ad97ec48a34af55a91a8a4eadb2424806f5df5c79a4fb3b076cb9374ae4
-  data.tar.gz: 53d08d6854c16b74168a711d9f85a0a7774737d6149c2f2916d2ef2c59fa56e8e40cc8fbaba6f71810140c8e41498fec41fec24287deba3c4cd7fe757bebce2d
+  metadata.gz: be08d976091be9c8a35d9a1cc57749f9e9072c54fefb7a013c86e26f81acc67cbc5dc30714434ef12de09e01b1b4eb88b4085d34658145cd2dde091fbf6f5a7c
+  data.tar.gz: 129400183873b8d08fe19d619197fc8aa96c907f770d431d9d33cfab650bdbf259b5a31f18e7ef5c3991a9d1155a97a18732dc238e74d3d2057b5d05607b1c3e

data/lib/soar_auditing_provider/auditing_provider.rb

@@ -74,8 +74,8 @@ module SoarAuditingProvider
       detail
     end
 
-    def flush
-      @worker.flush
+    def flush(timeout: 1)
+      @worker.flush(timeout: timeout)
     end
 
     def audit_exception(exception:, level: :error, flow_id: nil)
@@ -130,7 +130,7 @@ module SoarAuditingProvider
     end
 
     def create_auditing_worker
-      @worker = AuditingWorker.new
+      @worker = AuditingWorker.instance
       @worker.configure(queue_worker_configuration: @configuration['queue_worker'], auditor_audit_method: method(:super_class_caller))
       @worker.start
     end

data/lib/soar_auditing_provider/auditing_worker.rb

@@ -1,19 +1,15 @@
 require 'soar_thread_worker/thread_worker'
+require 'singleton'
 
 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 :dequeued_audits
-    attr_reader :latest_successful_audit_timespan
-    attr_reader :latest_successful_audit_timestamp
+    include Singleton
 
     def initialize
       @queue = Queue.new
-      @start_mutex = Mutex.new
+      @queue_mutex = Mutex.new
       initialize_metrics
+      super
     end
 
     def configure(queue_worker_configuration: ,auditor_audit_method: )
@@ -26,31 +22,27 @@ module SoarAuditingProvider
     end
 
     def enqueue(level, data)
-      if @queue.size < @maximum_queue_size then
+      @queue_mutex.synchronize {
+        raise AuditingOverflowError if @queue.size >= @maximum_queue_size
         @queue.push({:level => level, :data => data})
-      else
-        raise AuditingOverflowError
-      end
-      ensure_worker_is_running
-    end
-
-    def start(verbose: false)
-      @start_mutex.synchronize {
-        if not running? then
-          super()
-          $stderr.puts("Auditing worker was not running and respawned") if verbose
-        end
+        start
       }
     end
 
     def execute
-      audit_event = @queue.pop
+      audit_event = nil
+      @queue_mutex.synchronize {
+        @thread.exit if @queue.empty?
+        audit_event = @queue.pop
+      }
       @dequeued_audits += 1
       failed_before = false
       begin
         if @stopping
-          @queue.push(audit_event) if audit_event #push the event back into the queue so that fallback flush mechanism can deal with this audit event
-          return true #indicates to thread worder that we are done executing since we are in the process of stopping
+          @queue_mutex.synchronize {
+            @queue.push(audit_event) if audit_event #push the event back into the queue so that fallback flush mechanism can deal with this audit event
+            @thread.exit
+          }
         end
         exponential_back_off(start_at_last_attempt: failed_before) {
           time_before_audit = Time.now
@@ -64,13 +56,20 @@ module SoarAuditingProvider
         failed_before = true
         retry
       end
-      return false #indicates to thread worder that we are not done executing
+
+      @queue_mutex.synchronize {
+        return false if not @queue.empty? #indicates to thread worker that we are not done executing since the queue is not empty
+        @thread.exit
+      }
     end
 
-    def flush(timeout = 1)
-      ensure_worker_is_running
+    def flush(timeout:)
+      start #start the worker thread just in case there are items enqueued
+      sleep(0.1)
+      stop(immediate: false)
       wait_for_worker_to_clear_queue(timeout)
-      fallback_flush_to_stderr if @queue.size > 0
+      stop(immediate: true)
+      fallback_flush_to_stderr (timeout) if not @queue.empty?
     end
 
     def status_detail
@@ -88,14 +87,14 @@ module SoarAuditingProvider
 
     private
 
-    def wait_for_worker_to_clear_queue(timeout = 1)
+    def wait_for_worker_to_clear_queue(timeout)
       start_time = Time.now
-      until ((@queue.size == 0) or ((Time.now - start_time) >= timeout)) do
+      until ((not @thread.alive?) or ((Time.now - start_time) >= timeout)) do
         sleep(0.1)
       end
     end
 
-    def fallback_flush_to_stderr(timeout = 1)
+    def fallback_flush_to_stderr(timeout)
       $stderr.puts 'Unable to flush audit entries to auditor, stopping worker and flushing to stderr'
       ensure_worker_is_stopped
       start_time = Time.now
@@ -114,22 +113,10 @@ module SoarAuditingProvider
       $stderr.puts "#{notification}: #{message}"
     end
 
-    def ensure_worker_is_running
-      start(verbose: true)
-    end
-
     def ensure_worker_is_stopped
-      attempt_graceful_stop
-      sleep_while_still_running(5)
-      force_stop
-    end
-
-    def attempt_graceful_stop
-      @stopping = true
-    end
-
-    def force_stop
-      stop
+      stop(immediate: false)
+      sleep_while_still_running(2)
+      stop(immediate: true)
     end
 
     def validate_configuration(queue_worker_configuration)
@@ -175,7 +162,7 @@ module SoarAuditingProvider
 
     def sleep_while_still_running(desired_delay)
       start_time = Time.now
-      until ((false == @running) or ((Time.now - start_time) >= desired_delay)) do
+      until ((false == running?) or ((Time.now - start_time) >= desired_delay)) do
         sleep(0.1)
       end
     end

data/lib/soar_auditing_provider/version.rb

@@ -1,3 +1,3 @@
 module SoarAuditingProvider
-  VERSION = "1.1.5"
+  VERSION = "1.2.0"
 end

data/soar_auditing_provider.gemspec

@@ -22,12 +22,12 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'byebug', '~> 9.0.5'
-  spec.add_development_dependency 'log4r_auditor', '~> 0.0.4'
+  spec.add_development_dependency 'log4r_auditor', '~> 1.0.0'
   spec.add_development_dependency 'soar_flow', '~> 0.1.1'
   spec.add_development_dependency 'soar_xt', '~> 0.0.3'
 
   spec.add_dependency 'soar_auditing_provider_api', '~> 0.9.0'
   spec.add_dependency 'soar_auditing_format', '~> 0.0.5'
-  spec.add_dependency 'soar_thread_worker', '~> 0.1'
+  spec.add_dependency 'soar_thread_worker', '~> 0.2'
   spec.add_dependency 'soar_configured_factory', '~> 0.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soar_auditing_provider
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.2.0
 platform: ruby
 authors:
 - Ernst van Graan
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-12 00:00:00.000000000 Z
+date: 2016-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: soar_flow
   requirement: !ruby/object:Gem::Requirement
@@ -143,14 +143,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: soar_configured_factory
   requirement: !ruby/object:Gem::Requirement