soar_auditing_provider 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4390d2df4df9f1cd83f6ca1b4c89666a8d04f6f7
-  data.tar.gz: f56c79fc2d8abbfa76cb3191c6a51768a41fbcd2
+  metadata.gz: 9cfff41987c79b02a5a35893b286b3770ecaa9f6
+  data.tar.gz: 696249e89783169ff5c77c50b77638595d740a94
 SHA512:
-  metadata.gz: 4d69636507b2a922cd24068f58f42271f25353230c6549838b44a276d1038e804f576a3b931df470e49fe96a9aa421c615697be63343981c158e171115777a77
-  data.tar.gz: c16d6398b32618d03bb1b9c94412068164c16062177ff30cf3c6aeaf852096ad710c7a78151731cc73eeacf9e3ddabc47ebe99947e0a255387fee377d6629544
+  metadata.gz: 5050b6588dbdded12927a93bc6d9dc76f55f51ebb2950a1c6a122d7b795b2d8fdd4e6562ad26e63e70e5c5f78673b9398f5c1adb34fec334bfa40e96f7b604d3
+  data.tar.gz: 98f9cd2beedff794442784f18067e521b6e2a5c16ba1c0440e445d19a16ffd83aaf6f92a68bb78e95d4d020c0246b259bd604e72ef57b8d407614e7d9209bd67

data/README.md

@@ -1,6 +1,6 @@
 # SoarAuditingProvider
 
-[![Gem Version](https://badge.fury.io/rb/soar_auditing_provider.png)](https://badge.fury.io/rb/soar_auditing_provider) [<img src="http://soar-ci.dev.auto-h.net:8080/job/soar-auditing-provider/badge/icon">](http://soar-ci.dev.auto-h.net:8080/job/soar-auditing-provider)
+[![Gem Version](https://badge.fury.io/rb/soar_auditing_provider.png)](https://badge.fury.io/rb/soar_auditing_provider)
 
 This gem provides an auditing provider for the SOAR architecture.
 
@@ -84,7 +84,7 @@ myauditing = SoarAuditingProvider::AuditingProvider.new( AUDITING_CONFIGURATION[
 
 In order to associate all startup and shutdown related audit events with each other it is useful to set an instance flow identifier. Generate an unique flow identifier and pass to the auditing provider.  Optional but very useful.
 ```ruby
-myauditing.instance_flow_identifier = SoarFlow::ID::generate_flow_id
+myauditing.startup_flow_id = SoarFlow::ID::generate_flow_id
 ```
 
 When auditing to a local file there is no need to identify each audit event with a specific service since each service probably has its own audit file.  However, when merging audit events to a centralized system it is vital to associate each audit event with a specific service and instance thereof.  Set an unique service identifer that will form part of each audit event as follow:
@@ -154,7 +154,7 @@ class Main
   def test_sanity
     #create and configure auditing instance
     myauditing = SoarAuditingProvider::AuditingProvider.new( AUDITING_CONFIGURATION['auditing'] )
-    myauditing.instance_flow_identifier = SoarFlow::ID::generate_flow_id
+    myauditing.startup_flow_id = SoarFlow::ID::generate_flow_id
     myauditing.service_identifier = 'my-test-service.com'
 
     #associate a set of auditing entries with a flow by generating a flow identifiers
@@ -190,7 +190,7 @@ The auditing provider automatically chains a hook into the Kernel at_exit method
 
 Provision has been made for out-of-band status/statistics gathering inside the auditing provider.  The hash containing the status/statistics is accessible using the status method call:
 ```ruby
-myauditing.get_status
+myauditing.detailed_status
 ```
 
 At present only the buffer overflow count is avialable:

data/lib/soar_auditing_provider/auditing_provider.rb

@@ -17,7 +17,7 @@ module SoarAuditingProvider
 
     public
 
-    attr_accessor :instance_flow_identifier
+    attr_accessor :startup_flow_id
     attr_accessor :service_identifier
     attr_reader   :configuration
 
@@ -67,8 +67,9 @@ module SoarAuditingProvider
       enqueue(:info, format(:info, prepend_caller_information(data), flow_identifier))
     end
 
-    def get_status
-      { 'audit_buffer_overflows' => @buffer_overflow_count }
+    def detailed_status
+      { 'audit_buffer_overflows' => @buffer_overflow_count,
+        'startup_flow_id'        => @startup_flow_id }
     end
 
     def flush
@@ -95,14 +96,14 @@ module SoarAuditingProvider
 
     def exit_cleanup(exception = nil)
       audit_exception_message(exception) if exception
-      info("Application exit",@instance_flow_identifier)
+      info("Application exit",@startup_flow_id)
       flush
     end
 
     def audit_exception_message(exception)
       exception_message = "#{exception.class}: #{exception.message}"
       exception_message = exception_message + ":\n\t" + exception.backtrace.join("\n\t") if ENV['RACK_ENV'] == 'development'
-      fatal(exception_message,@instance_flow_identifier)
+      fatal(exception_message,@startup_flow_id)
     end
 
     def enqueue(level, data)

data/lib/soar_auditing_provider/version.rb

@@ -1,3 +1,3 @@
 module SoarAuditingProvider
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/sanity/sanity.rb

@@ -39,7 +39,7 @@ class Main
   def test_sanity
     #create and configure auditing instance
     myauditing = SoarAuditingProvider::AuditingProvider.new( AUDITING_CONFIGURATION['auditing'] )
-    myauditing.instance_flow_identifier = SoarFlow::ID::generate_flow_id
+    myauditing.startup_flow_id = SoarFlow::ID::generate_flow_id
     myauditing.service_identifier = 'my-test-service.com'
 
     #associate a set of auditing entries with a flow by generating a flow identifiers

data/sanity/sanity_benchmark.rb

@@ -44,7 +44,7 @@ class Main
 
     #create and configure auditing instance
     myauditing = SoarAuditingProvider::AuditingProvider.new( AUDITING_CONFIGURATION['auditing'] )
-    myauditing.instance_flow_identifier = SoarFlow::ID::generate_flow_id
+    myauditing.startup_flow_id = SoarFlow::ID::generate_flow_id
     myauditing.service_identifier = 'my-test-service.com'
 
     #associate a set of auditing entries with a flow by generating a flow identifiers
@@ -52,7 +52,7 @@ class Main
 
     Benchmark.bm do |x|
       myauditing = SoarAuditingProvider::AuditingProvider.new( AUDITING_CONFIGURATION['auditing'].dup.merge("level" => "warn") )
-      myauditing.instance_flow_identifier = SoarFlow::ID::generate_flow_id
+      myauditing.startup_flow_id = SoarFlow::ID::generate_flow_id
       myauditing.service_identifier = 'my-test-service.com'
       x.report ("audit_call_below_audit_threshold:") {
         iterations.times {
@@ -60,7 +60,7 @@ class Main
         }
       }
       myauditing = SoarAuditingProvider::AuditingProvider.new( AUDITING_CONFIGURATION['auditing'].dup.merge("add_caller_source_location" => "false") )
-      myauditing.instance_flow_identifier = SoarFlow::ID::generate_flow_id
+      myauditing.startup_flow_id = SoarFlow::ID::generate_flow_id
       myauditing.service_identifier = 'my-test-service.com'
       x.report ("audit_call_without_caller_info  :") {
         iterations.times {
@@ -68,7 +68,7 @@ class Main
         }
       }
       myauditing = SoarAuditingProvider::AuditingProvider.new( AUDITING_CONFIGURATION['auditing'].dup.merge("add_caller_source_location" => "true") )
-      myauditing.instance_flow_identifier = SoarFlow::ID::generate_flow_id
+      myauditing.startup_flow_id = SoarFlow::ID::generate_flow_id
       myauditing.service_identifier = 'my-test-service.com'
       x.report ("audit_call_with_caller_info     :") {
         iterations.times {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: soar_auditing_provider
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ernst van Graan
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-31 00:00:00.000000000 Z
+date: 2016-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler