soar_analytics 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46f9347898248334f05db891b72b6820a9349d7d
+  data.tar.gz: 2c2d11b807ac82febe9dc5044c072bdd119d9380
+SHA512:
+  metadata.gz: 225bda70028fd283fd3263c7265f7e5a5e850aea129b2466188f4bcaa1e70182c7102f7802517ceb7762a1d269f0971e04e5c34e2ab762b3f845774570a8f15e
+  data.tar.gz: 2a22e633a0b1c686e54f5f5e59dc1843061899ae3253fe975f24fbb076420e1ce197ec0afb4df3e0b28595b2689341ecd2efef7ae9f2258a01f658e969f8a597

data/.gitignore

@@ -0,0 +1,52 @@
+.byebug_history
+*tgz
+left
+test_tfa.sh
+test_production.sh
+iut-list
+juddi-distro-*
+*.swo
+*.zip
+*.tar.gz
+*.swp
+*.gem
+*.rbc
+Gemfile.lock
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.DS_Store
+logfile
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+soar_sc.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+soar_analytics

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in soar_analytics.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Barney de Villiers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+# SoarAnalytics
+
+This gem provides the analytics helpers that can be plugged into the SOAR architecture.  The output is in the form of key value pairs that can easily be analyzed using queries on your auditing event logs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'soar_analytics'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install soar_analytics
+
+## Testing
+
+Behavioural driven testing can be performed by testing so:
+
+    $ bundle exec rspec -cfd spec/*
+
+## Usage
+
+Initialize and configure the analytics with the auditing provider so:
+
+```ruby
+SoarAnalytics.auditing = myauditing
+```
+
+## Reporter
+
+The Reporter class is the most basic reporting which simply reports a value in a key value pair using the specified auditing level.  Not very useful for most applcations but forms the basis of other specialized reporters in this gem. The flow identifier parameter is optional.
+
+```ruby
+flow_id = SoarFlow::ID::generate_flow_id
+reporter = SoarAnalytics::Reporter.new('my_reporter')
+value = 123
+reporter.report(value,:warn,flow_id)
+```
+
+## ThresholdReporter
+
+The ThresholdReporter class can be configured with various thresholds that determines the auditing level of the audit event when reported.  This allows you to set levels at which you can define informational, warning and error conditions based on the value reported.  Useful in examples such as where a database operation should take less than an certain amount of time. Anything above that value will then be reported as warnings or errors. The flow identifier parameter is optional.
+
+```ruby
+flow_id = SoarFlow::ID::generate_flow_id
+threshold_reporter = SoarAnalytics::ThresholdReporter.new(name: 'my_threshold_reporter', info_threshold: 1, warn_threshold: 2, error_threshold: 3)
+value = 2
+threshold_reporter.report(value,flow_id)
+```
+
+## TimeDeltaReporter
+
+Probably the most useful reporter in this gem is the TimeDeltaReporter which calculates and reports on the time difference since the initialization of the object.  This is a specialization of the ThresholdReporter. Only the parameter 'name' is required during the initialization.  The rest are optional and defaults to info level for all time deltas greater or equal to zero. The flow identifier parameter is also optional.
+
+```ruby
+flow_id = SoarFlow::ID::generate_flow_id
+timer = SoarAnalytics::TimeDeltaReporter.new(name: "db_access_time", info_threshold: 1, warn_threshold: 2, error_threshold: 3)
+sleep(1)
+timer.report(flow_id)
+```
+
+## Contributing
+
+Bug reports and feature requests are welcome by email to barney dot de dot villiers at hetzner dot co dot za. This gem is sponsored by Hetzner (Pty) Ltd (http://hetzner.co.za)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+require "bundler/setup"
+require 'soar_analytics'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/soar_analytics.rb

@@ -0,0 +1,8 @@
+require 'soar_analytics/version'
+require 'soar_analytics/analytics'
+require 'soar_analytics/reporter'
+require 'soar_analytics/threshold_reporter'
+require 'soar_analytics/time_delta_reporter'
+
+module SoarAnalytics
+end

data/lib/soar_analytics/analytics.rb

@@ -0,0 +1,9 @@
+module SoarAnalytics
+  def self.auditing=(auditing)
+    @@auditing = auditing
+  end
+
+  def self.auditing
+    @@auditing
+  end
+end

data/lib/soar_analytics/reporter.rb

@@ -0,0 +1,19 @@
+require 'soar_auditing_format'
+
+module SoarAnalytics
+  class Reporter
+    def initialize(name)
+      @name = name
+    end
+
+    def report(value, audit_level = :info, flow_identifier = nil)
+      SoarAnalytics.auditing.send(audit_level,format_key_value_pair(value),flow_identifier)
+    end
+
+    private
+
+    def format_key_value_pair(value)
+      SoarAuditingFormatter::Formatter.optional_field_format(@name,value)
+    end
+  end
+end

data/lib/soar_analytics/threshold_reporter.rb

@@ -0,0 +1,31 @@
+module SoarAnalytics
+  class ThresholdReporter < Reporter
+    def initialize(name:, info_threshold: 0, warn_threshold: nil, error_threshold: nil)
+      super(name)
+      @thresholds = [
+        { 'level' => :error, 'threshold' => error_threshold},
+        { 'level' => :warn,  'threshold' => warn_threshold},
+        { 'level' => :info,  'threshold' => info_threshold}
+      ]
+    end
+
+    def report(value, flow_identifier = nil)
+      audit_level = determine_highest_matching_auditing_level(value)
+      super(simplify_numbers(value), audit_level, flow_identifier) if audit_level
+    end
+
+    private
+
+    def determine_highest_matching_auditing_level(value)
+      @thresholds.each { | threshold |
+        return threshold['level'] if threshold['threshold'] and (value >= threshold['threshold'])
+      }
+      return nil
+    end
+
+    def simplify_numbers(value)
+      return "%.6f" % value if value.is_a?(Float)
+      return value
+    end
+  end
+end

data/lib/soar_analytics/time_delta_reporter.rb

@@ -0,0 +1,22 @@
+module SoarAnalytics
+  class TimeDeltaReporter < ThresholdReporter
+    def initialize(name:, info_threshold: 0, warn_threshold: nil, error_threshold: nil)
+      super
+      record_start_time
+    end
+
+    def report(flow_identifier = nil)
+      super(calculate_time_delta, flow_identifier)
+    end
+
+    private
+
+    def record_start_time
+      @start_time = Time.now
+    end
+
+    def calculate_time_delta
+      Time.now - @start_time
+    end
+  end
+end

data/lib/soar_analytics/version.rb

@@ -0,0 +1,3 @@
+module SoarAnalytics
+  VERSION = "0.0.1"
+end

data/sanity/.ruby-gemset

@@ -0,0 +1 @@
+soar_analytics_sanity

data/sanity/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3

data/sanity/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'soar_analytics', path: '../'
+gem 'soar_auditing_provider', '~> 1.0'
+gem "log4r_auditor", '~> 1.0'
+gem "soar_flow", "~> 0.1.1"
+gem "byebug"

data/sanity/sanity.rb

@@ -0,0 +1,91 @@
+require 'soar_auditing_format'
+require 'soar_auditing_provider'
+require 'soar_flow'
+require 'log4r_auditor'
+
+require 'time'
+require 'securerandom'
+require "soar_analytics"
+
+class Main
+  AUDITING_CONFIGURATION = {
+    'auditing' => {
+      'provider' => 'SoarAuditingProvider::AuditingProvider',
+      'level' => 'info',
+      'install_exit_handler' => 'true',
+      'queue_worker' => {
+        'queue_size' => 1000,
+        'initial_back_off_in_seconds' => 1,
+        'back_off_multiplier' => 2,
+        'back_off_attempts' => 5
+      },
+      'default_nfrs' => {
+        'accessibility' => 'local',
+        'privacy' => 'not encrypted',
+        'reliability' => 'instance',
+        'performance' => 'high'
+      },
+      'auditors' => {
+        'log4r' => {
+          'adaptor' => 'Log4rAuditor::Log4rAuditor',
+          'file_name' => 'soar_sc.log',
+          'standard_stream' => 'stdout',
+          'nfrs' => {
+            'accessibility' => 'local',
+            'privacy' => 'not encrypted',
+            'reliability' => 'instance',
+            'performance' => 'high'
+          }
+        }
+      }
+    }
+    } unless defined? AUDITING_CONFIGURATION; AUDITING_CONFIGURATION.freeze
+
+    def setup_analytics
+      myauditing = SoarAuditingProvider::AuditingProvider.new( AUDITING_CONFIGURATION['auditing'] )
+      myauditing.instance_flow_identifier = SoarFlow::ID::generate_flow_id
+      myauditing.service_identifier = 'my-test-service.com'
+      SoarAnalytics.auditing = myauditing
+    end
+
+    def test_time_delta_reporter
+      analytic_timer = SoarAnalytics::TimeDeltaReporter.new(name: "mytimer_that_should_not_be_audited", info_threshold: 1, warn_threshold: 2, error_threshold: 3)
+      sleep(0)
+      analytic_timer.report(SoarFlow::ID::generate_flow_id)
+
+      analytic_timer = SoarAnalytics::TimeDeltaReporter.new(name: "mytimer_with_default_values")
+      sleep(0)
+      analytic_timer.report(SoarFlow::ID::generate_flow_id)
+
+      analytic_timer = SoarAnalytics::TimeDeltaReporter.new(name: "mytimer", info_threshold: 1, warn_threshold: 2, error_threshold: 3)
+      sleep(1)
+      analytic_timer.report(SoarFlow::ID::generate_flow_id)
+
+      analytic_timer = SoarAnalytics::TimeDeltaReporter.new(name: "mytimer", info_threshold: 1, warn_threshold: 2, error_threshold: 3)
+      sleep(2)
+      analytic_timer.report(SoarFlow::ID::generate_flow_id)
+
+      analytic_timer = SoarAnalytics::TimeDeltaReporter.new(name: "mytimer", info_threshold: 1, warn_threshold: 2, error_threshold: 3)
+      sleep(3)
+      analytic_timer.report(SoarFlow::ID::generate_flow_id)
+
+      flow_id = SoarFlow::ID::generate_flow_id
+      reporter = SoarAnalytics::Reporter.new('my_reporter')
+      value = 123
+      reporter.report(value,:warn,flow_id)
+
+      flow_id = SoarFlow::ID::generate_flow_id
+      threshold_reporter = SoarAnalytics::ThresholdReporter.new(name: 'my_threshold_reporter', info_threshold: 1, warn_threshold: 2, error_threshold: 3)
+      value = 2
+      threshold_reporter.report(value,flow_id)
+
+      flow_id = SoarFlow::ID::generate_flow_id
+      timer = SoarAnalytics::TimeDeltaReporter.new(name: "db_access_time", info_threshold: 1, warn_threshold: 2, error_threshold: 3)
+      sleep(1)
+      timer.report(flow_id)
+    end
+  end
+
+  main = Main.new
+  main.setup_analytics
+  main.test_time_delta_reporter

data/soar_analytics.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'soar_analytics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'soar_analytics'
+  spec.version       = SoarAnalytics::VERSION
+  spec.authors       = ['Barney de Villiers']
+  spec.email         = ['barney.de.villiers@hetzner.co.za']
+
+  spec.summary       = %q{Analytics toolset for the SOAR architecture}
+  spec.description   = %q{Analytics toolset for the SOAR architecture that provides for easy analysis of matters such as performance}
+  spec.homepage      = 'https://github.com/hetznerZA/soar_analytics'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'byebug', '~> 9'
+  spec.add_development_dependency 'soar_auditing_format', '~> 0.0.5'
+  spec.add_development_dependency 'soar_auditing_provider', '~> 1.0'
+  spec.add_development_dependency 'log4r_auditor', '~> 1.0'
+  spec.add_development_dependency 'soar_flow', '~> 0.1'
+
+  spec.add_dependency 'soar_auditing_format', '~> 0.0.5'
+
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: soar_analytics
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Barney de Villiers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
+- !ruby/object:Gem::Dependency
+  name: soar_auditing_format
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: soar_auditing_provider
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: log4r_auditor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: soar_flow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: soar_auditing_format
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+description: Analytics toolset for the SOAR architecture that provides for easy analysis
+  of matters such as performance
+email:
+- barney.de.villiers@hetzner.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/soar_analytics.rb
+- lib/soar_analytics/analytics.rb
+- lib/soar_analytics/reporter.rb
+- lib/soar_analytics/threshold_reporter.rb
+- lib/soar_analytics/time_delta_reporter.rb
+- lib/soar_analytics/version.rb
+- sanity/.ruby-gemset
+- sanity/.ruby-version
+- sanity/Gemfile
+- sanity/sanity.rb
+- soar_analytics.gemspec
+homepage: https://github.com/hetznerZA/soar_analytics
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Analytics toolset for the SOAR architecture
+test_files: []