boxxspring-workers 1.1.5 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28d891511f5e9885528269e401d43946f8eab6e9
-  data.tar.gz: 7c4d7828f39a16ccecc075387792ca63eba21879
+  metadata.gz: 9bb58d38eac80a419803140a16f795f1d2295c0a
+  data.tar.gz: '04797acf3a9e42b0c16c1646fab97f754026658e'
 SHA512:
-  metadata.gz: 5e6b1079cc3a9b932f4d44ae19b584ea77e414a2929e193e2e4ff3cb1330dca72bd59eff298222aad07456435da083af7b518a286ee3a728ddbd2ca342e0bc9b
-  data.tar.gz: 94ba8c40b9ef4bbb5e2f04074acfefecd3f0376f2d8217fd6966f89ab36a6d6eb03fa3ca74b116bbb4c98baf679868e5cf5e34f8fc65eddff4e1129e19903c9c
+  metadata.gz: 4273c1fecb32544463181a2e49bdc9b2c2ce81c03a28776de56b8fd1b7548ba6c5bd88186056e31111a733ac9a4e9055bbeae75b5d45465442f53badf116a92f
+  data.tar.gz: 9f50f6eb3002870ef1e4268d07f7f010ca0b95d4af253d6b864c260ad3883817b4b9908164c6647fa5d47fb6a10d7f3b1dec7c47bf032710b8656a7fb6a49fe4

data/lib/boxxspring/worker/base.rb

@@ -11,6 +11,7 @@ module Boxxspring
       # modules
 
       include Logging
+      include Metrics
 
       #------------------------------------------------------------------------
       # class attributes
@@ -62,28 +63,38 @@ module Boxxspring
       # operations
 
       def process
-        messages = self.receive_messages() || []
-        messages.each do | message |
-          if message.present?
-            payload = self.payload_from_message( message )
-
-            if payload.present?
-              begin
-                result = self.process_payload( payload )
-                # note: if an exception is raised the message will be deleted
-                self.delete_message( message ) unless result == false
-              rescue StandardError => error
+         metric_defaults  dimensions: { worker_name: self.class.name, 
+                                        environment: environment } do 
+
+          messages = self.receive_messages() || []
+          messages.each do | message |
+            if message.present?
+              payload = self.payload_from_message( message )
+
+              if payload.present?
+                begin
+                  metric :messages do 
+                    result = self.process_payload( payload )
+                    
+                    # note: if an exception is raised the message will be deleted
+                    self.delete_message( message ) unless result == false
+                  end
+                rescue StandardError => error
+                  metric :errors 
+
+                  self.logger.error(
+                    "The #{ self.human_name } failed to process the payload."
+                  )
+                  self.logger.error( error.message )
+                  self.logger.info( error.backtrace.join( "\n" ) )
+                end
+
+              else
+                self.delete_message( message )
                 self.logger.error(
-                  "The #{ self.human_name } failed to process the payload."
+                  "The #{ self.human_name } received an invalid payload."
                 )
-                self.logger.error( error.message )
-                self.logger.info( error.backtrace.join( "\n" ) )
               end
-            else
-              self.delete_message( message )
-              self.logger.error(
-                "The #{ self.human_name } received an invalid payload."
-              )
             end
           end
         end

data/lib/boxxspring/worker/logging.rb

@@ -1,30 +1,23 @@
 module Boxxspring
-
   module Worker
-
     module Logging
 
       PWD = Dir.pwd.freeze
 
       def logger
-
         @logger ||= begin
-
           workers_env = ENV[ 'WORKERS_ENV' ]
 
           if Worker.configuration.include?( 'logger' )
-
            logger = Worker.configuration.logger
-
           else
 
             if self.log_local? || workers_env == 'test'
-
               logger = Logger.new( STDOUT )
-
             else
 
               group_name = self.log_group_name
+
               raise 'A logging group is required. You may need to set LOG_GROUP.' \
                 unless group_name.present?
 
@@ -49,15 +42,12 @@ module Boxxspring
               )
 
             end
-
-
           end
-
           logger.level = self.log_level
+
           logger
 
         end
-
       end
 
       protected; def log_group_name
@@ -87,9 +77,7 @@ module Boxxspring
         log_local = ENV[ 'LOG_LOCAL' ] || 'false'
         ( log_local.to_s =~ /^true$/i ) == 0
       end
-
+    
     end
-
   end
-
 end

data/lib/boxxspring/worker/metrics/count_metric_computer.rb

@@ -0,0 +1,13 @@
+class CountMetricComputer < MetricComputer
+  
+  def value 
+    @value
+  end
+
+  def start
+  end
+
+  def stop 
+  end
+
+end

data/lib/boxxspring/worker/metrics/metric_computer.rb

@@ -0,0 +1,42 @@
+class MetricComputer
+  
+  def name
+    @name ||= ""
+  end
+  
+  def value
+    @value ||= 1
+  end
+  
+  def unit
+    @unit ||= ""
+  end
+
+  def initialize( hash, defaults )
+    @name, @value, @unit = hash.values
+    @defaults = defaults
+  end
+
+  def to_json
+    {
+      metric_name: name.to_s.capitalize,
+      dimensions: normalize_dimensions_from_defaults( @defaults ),
+      value: value.to_i,
+      unit: unit.to_s.capitalize
+    }
+  end
+
+  private; def normalize_dimensions_from_defaults( defaults )
+    return nil if defaults[ :dimensions ].blank?
+    
+    defaults[ :dimensions ].map do | key, value |
+      {
+        name: key.to_s.camelize,
+        value: value 
+      }
+    end 
+
+  end
+
+end
+

data/lib/boxxspring/worker/metrics/microseconds_metric_computer.rb

@@ -0,0 +1,15 @@
+class MicrosecondsMetricComputer < MetricComputer
+  
+  def value 
+    @value * 1000000
+  end
+
+  def start
+    @start_time = Time.now
+  end
+
+  def stop 
+    @value = Time.now - @start_time
+  end
+
+end

data/lib/boxxspring/worker/metrics/milliseconds_metric_computer.rb

@@ -0,0 +1,7 @@
+class MillisecondsMetricComputer < MicrosecondsMetricComputer
+  
+  def value 
+    super / 1000
+  end
+
+end

data/lib/boxxspring/worker/metrics/seconds_metric_computer.rb

@@ -0,0 +1,7 @@
+class SecondsMetricComputer < MicrosecondsMetricComputer
+  
+  def value 
+    super / 1000000
+  end
+
+end

data/lib/boxxspring/worker/metrics.rb

@@ -0,0 +1,97 @@
+require 'thread'
+
+module Boxxspring
+  
+  module Worker
+  
+    module Metrics
+      
+      METRICS_MUTEX = Mutex.new 
+      METRICS_CLIENT = Aws::CloudWatch::Client.new 
+      METRICS_UPLOAD_INTERVAL = 1
+      
+      def initialize( *arguments )
+        super
+
+        @metrics = []
+        @metric_defaults = [ {} ]
+
+        Thread.new do
+          upload_metrics
+        end
+      end
+
+      def upload_metrics
+        loop do 
+          unless @metrics.empty?
+            begin
+              metrics_payload = nil 
+              
+              METRICS_MUTEX.synchronize do
+                metrics_payload = @metrics
+                @metrics = []
+              end
+              
+              METRICS_CLIENT.put_metric_data( {
+                namespace: 'Unimatrix/Worker',
+                metric_data: metrics_payload
+              } )
+
+            rescue Error => e
+              logger.error( 
+                "An error has occured when making a request to the AWS " +
+                "Cloudwatch endpoint 'put_metric_data'." 
+              )
+            end
+
+            sleep METRICS_UPLOAD_INTERVAL 
+          end
+        end
+      end
+
+      def metric_defaults( defaults = {} )
+        previous_defaults = @metric_defaults.last 
+        @metric_defaults.push( previous_defaults.merge( defaults ) )
+
+        yield
+        @metric_defaults.pop
+
+      end
+
+      def metric ( *arguments )
+        arguments = [ arguments ] unless arguments.first.is_a? Array
+        computers = arguments.map do | metric |
+          parsed_metric = parse_metric( metric )  
+
+          computer_class =
+            "#{ parsed_metric[ :unit ].to_s.capitalize }MetricComputer".constantize
+          computer_class.new( parsed_metric, @metric_defaults.last )
+        end
+
+        if block_given?
+          computers.each( &:start )
+          yield
+          computers.each( &:stop )
+        end
+
+        METRICS_MUTEX.synchronize do
+          @metrics = @metrics.concat( 
+            computers.map( &:to_json ).delete_if { | json | json.blank? } 
+          ) 
+        end 
+
+      end
+
+      private; def parse_metric ( unparsed_metrics )
+        name, data, unit = unparsed_metrics.first, 1, :count
+
+        data = unparsed_metrics[ 1 ] if unparsed_metrics[ 1 ].is_a? Integer
+        unit = unparsed_metrics[ 1 ] if unparsed_metrics[ 1 ].is_a? Symbol
+        unit = unparsed_metrics[ 2 ] unless unparsed_metrics[ 2 ].nil?
+
+        { name: name, data: data, unit: unit }
+      end
+
+    end
+  end
+end

data/lib/boxxspring-worker-version.rb

@@ -1,5 +1,5 @@
 module Boxxspring
   module Worker
-    VERSION = '1.1.5'
+    VERSION = '1.2.0'
   end
 end

data/lib/boxxspring-worker.rb

@@ -6,6 +6,12 @@ require 'lib/boxxspring/abstract'
 require 'lib/boxxspring/journal'
 require 'lib/boxxspring/worker'
 require 'lib/boxxspring/worker/logging'
+require 'lib/boxxspring/worker/metrics'
+require 'lib/boxxspring/worker/metrics/metric_computer'
+require 'lib/boxxspring/worker/metrics/microseconds_metric_computer'
+require 'lib/boxxspring/worker/metrics/count_metric_computer'
+require 'lib/boxxspring/worker/metrics/seconds_metric_computer'
+require 'lib/boxxspring/worker/metrics/milliseconds_metric_computer'
 require 'lib/boxxspring/worker/configuration'
 require 'lib/boxxspring/worker/base'
 require 'lib/boxxspring/worker/task_base'
@@ -14,4 +20,4 @@ require 'lib/boxxspring/synchronization'
 require 'lib/boxxspring/synchronization/operations'
 require 'lib/boxxspring/synchronization/orchestrator'
 require 'lib/boxxspring/synchronization/mutex'
-require 'lib/boxxspring/synchronization/variable'
+require 'lib/boxxspring/synchronization/variable'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boxxspring-workers
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.2.0
 platform: ruby
 authors:
 - Kristoph Cichocki-Romanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-25 00:00:00.000000000 Z
+date: 2017-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: cloudwatchlogger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: boxxspring
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +129,12 @@ files:
 - lib/boxxspring/worker/base.rb
 - lib/boxxspring/worker/configuration.rb
 - lib/boxxspring/worker/logging.rb
+- lib/boxxspring/worker/metrics.rb
+- lib/boxxspring/worker/metrics/count_metric_computer.rb
+- lib/boxxspring/worker/metrics/metric_computer.rb
+- lib/boxxspring/worker/metrics/microseconds_metric_computer.rb
+- lib/boxxspring/worker/metrics/milliseconds_metric_computer.rb
+- lib/boxxspring/worker/metrics/seconds_metric_computer.rb
 - lib/boxxspring/worker/task_base.rb
 - lib/tasks/workers.rake
 homepage: http://bedrocket.com
@@ -137,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Bedrocket Media Ventrures Boxxspring Worker framework.