funktor 0.2.13 → 0.2.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea0e753064ccb434aa89a656425dbe94ce223e8fcce85e7ad3423bc3d082ba31
-  data.tar.gz: 02ff46a0ca5276400dacce0e239bdacc48142624f5bbd36311267bc04964aa78
+  metadata.gz: 6e146325cc89da410fb6af4397911f20d66d681eaf14c7bd2919d41c97ab6e62
+  data.tar.gz: 4da3a83da0c561ed6ca5e51c84d0fa608063f5fa3d70dedde9a57aed279b91a2
 SHA512:
-  metadata.gz: 98d58ca33de1fe46d1121ce3498522fc1de8316b71fdd978780ab9ffbd2f97085bf47cef9ff59809648b36e9b4abea96cd89b785df1403c64a587ecec70bcb92
-  data.tar.gz: e6db57253fd756583344d4424fac291cb6126f90838b30761febb0142d32959a5cdec3ee82b92c9ecb5dc9ce2a25c94db9152c4a64ed87a8e0b566024e54c650
+  metadata.gz: 4860f967c03a2cf365c211f5d511591a8778c8570492499603bb6e888fb85e7c3ee7def2906fdc09762c9f166b3e1a503571df5fe4175a1cfeb2b153b37a5ba4
+  data.tar.gz: 1f32d8f5d968a08c7c0bd36eba892309b8511414bfc0d9ff2cc082dbd38496f8bdfb259ac7046e3d6f06707f994b7a947648eb1a15996c1f481afe112dad9034

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    funktor (0.2.13)
+    funktor (0.2.18)
       activesupport
       aws-sdk-sqs (~> 1.37)
       thor
@@ -18,13 +18,13 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     aws-eventstream (1.1.1)
-    aws-partitions (1.472.0)
+    aws-partitions (1.473.0)
     aws-sdk-core (3.115.0)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-sqs (1.39.0)
+    aws-sdk-sqs (1.40.0)
       aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
     aws-sigv4 (1.2.3)

data/lib/funktor.rb

@@ -3,16 +3,21 @@ require 'funktor/aws/sqs/event'
 require 'funktor/aws/sqs/record'
 require 'funktor/counter'
 require 'funktor/job'
+require 'funktor/logger'
 require 'funktor/worker'
 require 'funktor/middleware_chain'
 require 'funktor/incoming_job_handler'
-require 'funktor/active_job_handler'
 
 require 'json'
 
 module Funktor
   class Error < StandardError; end
 
+  DEFAULT_OPTIONS = {
+    error_handlers: [],
+    log_level: Logger::DEBUG # Set a high log level during early, active development
+  }
+
   def self.configure_job_pusher
     yield self
   end
@@ -55,9 +60,41 @@ module Funktor
   def self.dump_json(object)
     JSON.generate(object)
   end
+
+  def self.options
+    @options ||= DEFAULT_OPTIONS.dup
+  end
+
+  def self.options=(opts)
+    @options = opts
+  end
+
+  # Register a proc to handle any error which occurs within the Funktor active job handler.
+  #
+  #   Funktor.error_handlers << proc {|error, context| ErrorsAsAService.notify(error, context) }
+  #
+  # The default error handler logs errors to STDOUT
+  def self.error_handlers
+    options[:error_handlers]
+  end
+
+  def self.logger
+    @logger ||= Funktor::Logger.new($stdout, level: options[:log_level])
+  end
+
+  def self.logger=(logger)
+    if logger.nil?
+      self.logger.level = Logger::FATAL
+      return self.logger
+    end
+
+    @logger = logger
+  end
 end
 
 # TODO - Should we require this by default or let people opt in?
-# Is it a code smell that we need to include it at the bottom, after
+# TODO - Is it a code smell that we need to include these at the bottom, after
 # the main Funktor module is defined?
 require 'funktor/middleware/metrics'
+require 'funktor/error_handler'
+require 'funktor/active_job_handler'

data/lib/funktor/active_job_handler.rb

@@ -2,6 +2,7 @@ require 'aws-sdk-sqs'
 
 module Funktor
   class ActiveJobHandler
+    include Funktor::ErrorHandler
 
     def initialize
       @failed_counter = Funktor::Counter.new('failed')
@@ -28,8 +29,7 @@ module Funktor
         @processed_counter.incr(job)
       # rescue Funktor::Job::InvalidJsonError # TODO Make this work
       rescue Exception => e
-        puts "Error during processing: #{$!}"
-        puts "Backtrace:\n\t#{e.backtrace.join("\n\t")}"
+        handle_error(e, job)
         @failed_counter.incr(job)
         attempt_retry_or_bail(job)
       end

data/lib/funktor/cli/templates/config/resources/cloudwatch_dashboard.yml

@@ -7,10 +7,126 @@ Resources:
         {
             "widgets": [
 
+                <% current_y = 0 %>
+
+                { <% "Funktor Banner" %>
+                    "height": 3,
+                    "width": 24,
+                    "y": <%= current_y %>,
+                    "x": 0,
+                    "type": "text",
+                    "properties": {
+                        "markdown": "\n# Funktor Auto-generated Dashbaord\n\n This dashboard is auto-generated by Funktor and will be updated as Funktor progresses. If you want to customize this dashboard you should use 'Actions => Save dashbaord as' in the toolbar above to create a new dashboard of your own.\n\n The upper section shows you high level queue and worker stats, the lower sections show more details about all the AWS resources at play."
+                    }
+                },
+                <% current_y += 3 %>
+
+              { <% "Job Duration By Worker" %>
+                    "height": 6,
+                    "width": 12,
+                    "y": <%= current_y %>,
+                    "x": 12,
+                    "type": "metric",
+                    "properties": {
+                        "metrics": [
+                            <%- app_worker_names.each do |worker_name| -%>
+                            [ "<%= app_name %>", "Duration", "WorkerClassName", "<%= worker_name %>" ],
+                            [ "...", { "stat": "p99" } ]<%= worker_name == app_worker_names.last ? "" : "," %>
+                            <%- end -%>
+                        ],
+                        "view": "timeSeries",
+                        "stacked": false,
+                        "region": "us-east-1",
+                        "stat": "Average",
+                        "period": 60,
+                        "title": "Job Duration by Worker"
+                    }
+                },
+
+                { <% "Processed/Failed Jobs By Worker" %>
+                    "height": 6,
+                    "width": 12,
+                    "y": <%= current_y %>,
+                    "x": 0,
+                    "type": "metric",
+                    "properties": {
+                        "metrics": [
+                            <%- app_worker_names.each do |worker_name| -%>
+                            [ "<%= app_name %>", "processed", "WorkerClassName", "<%= worker_name %>" ],
+                            [ ".", "failed", ".", "." ]<%= worker_name == app_worker_names.last ? "" : "," %>
+                            <%- end -%>
+                        ],
+                        "view": "timeSeries",
+                        "stacked": false,
+                        "region": "us-east-1",
+                        "title": "Process/Failed Jobs By Worker",
+                        "period": 60,
+                        "stat": "Sum"
+                  }
+                },
+                <% current_y += 6 %>
+                { <% "Job Duration By Queue" %>
+                    "height": 6,
+                    "width": 12,
+                    "y": <%= current_y %>,
+                    "x": 12,
+                    "type": "metric",
+                    "properties": {
+                        "metrics": [
+                            <%- queue_names.each do |queue_name| -%>
+                            [ "<%= app_name %>", "Duration", "Queue", "<%= queue_name %>" ],
+                            [ "...", { "stat": "p99" } ]<%= queue_name == queue_names.last ? "" : "," %>
+                            <%- end -%>
+                        ],
+                        "view": "timeSeries",
+                        "stacked": false,
+                        "region": "us-east-1",
+                        "stat": "Average",
+                        "period": 60,
+                        "title": "Job Duration by Queue"
+                    }
+                },
+                { <% "Processed/Failed Jobs By Queue" %>
+                    "height": 6,
+                    "width": 12,
+                    "y": <%= current_y %>,
+                    "x": 0,
+                    "type": "metric",
+                    "properties": {
+                        "metrics": [
+                            <%- queue_names.each do |queue_name| -%>
+                            [ "<%= app_name %>", "processed", "Queue", "<%= queue_name %>" ],
+                            [ ".", "failed", ".", "." ]<%= queue_name == queue_names.last ? "" : "," %>
+                            <%- end -%>
+                        ],
+                        "view": "timeSeries",
+                        "stacked": false,
+                        "region": "us-east-1",
+                        "title": "Process/Failed Jobs By Queue",
+                        "period": 60,
+                        "stat": "Sum"
+                  }
+                },
+
+
+                { <% "Funktor Behind the Scenes Banner" %>
+                    "height": 3,
+                    "width": 24,
+                    "y": <%= current_y %>,
+                    "x": 0,
+                    "type": "text",
+                    "properties": {
+                        "markdown": "\n# Behind the scenes\n\n The stats below give some insight into the inner workings of the Funktor apparatus."
+                    }
+                },
+                <% current_y += 3 %>
+
+
+                <% current_y += 6 %>
                 { <% "Incoming Jobs" %>
                     "height": 3,
                     "width": 6,
-                    "y": 0,
+                    "y": <%= current_y %>,
                     "x": 0,
                     "type": "text",
                     "properties": {
@@ -20,7 +136,7 @@ Resources:
                 { <% "Incoming Job Queue Messages per minute" %>
                     "height": 3,
                     "width": 3,
-                    "y": 0,
+                    "y": <%= current_y %>,
                     "x": 6,
                     "type": "metric",
                     "properties": {
@@ -37,7 +153,7 @@ Resources:
                 { <% "Incoming Job Handler Duration" %>
                     "height": 3,
                     "width": 15,
-                    "y": 0,
+                    "y": <%= current_y %>,
                     "x": 9,
                     "type": "metric",
                     "properties": {
@@ -55,10 +171,12 @@ Resources:
                     }
                 },
 
+
+                <% current_y += 3 %>
                 { <% "Incoming Job Queue (Async & scheduled jobs land here first)" %>
                     "height": 6,
                     "width": 9,
-                    "y": 3,
+                    "y": <%= current_y %>,
                     "x": 0,
                     "type": "metric",
                     "properties": {
@@ -84,7 +202,7 @@ Resources:
                 { <% "Incoming Job Handler Duration in Milliseconds" %>
                     "height": 6,
                     "width": 9,
-                    "y": 3,
+                    "y": <%= current_y %>,
                     "x": 9,
                     "type": "metric",
                     "properties": {
@@ -104,7 +222,7 @@ Resources:
                 { <% "Incoming Job Handler Error count and success rate (%)" %>
                     "height": 3,
                     "width": 6,
-                    "y": 3,
+                    "y": <%= current_y %>,
                     "x": 18,
                     "type": "metric",
                     "properties": {
@@ -131,7 +249,7 @@ Resources:
                 { <% "Incoming Job Handler Concurrent Executions" %>
                     "height": 3,
                     "width": 6,
-                    "y": 6,
+                    "y": <%= current_y + 3 %>,
                     "x": 18,
                     "type": "metric",
                     "properties": {
@@ -149,7 +267,7 @@ Resources:
 
 
 
-                <% current_y = 9 %>
+                <% current_y += 6 %>
                 <%- queue_names.each do |queue_name| -%>
                 { <% "Active Jobs" %>
                     "height": 3,
@@ -300,28 +418,7 @@ Resources:
                 <% current_y += 9 %>
                 <%- end -%>
 
-                { <% "Job Duration By Worker" %>
-                    "height": 6,
-                    "width": 24,
-                    "y": <%= current_y %>,
-                    "x": 0,
-                    "type": "metric",
-                    "properties": {
-                        "metrics": [
-                            <%- app_worker_names.each do |worker_name| -%>
-                            [ "<%= app_name %>", "Duration", "WorkerClassName", "<%= worker_name %>" ],
-                            [ "...", { "stat": "p99" } ]<%= worker_name == app_worker_names.last ? "" : "," %>
-                            <%- end -%>
-                        ],
-                        "view": "timeSeries",
-                        "stacked": false,
-                        "region": "us-east-1",
-                        "stat": "Average",
-                        "period": 60,
-                        "title": "Job Duration by Worker"
-                    }
-                },
-                <% current_y += 6 %>
+                
 
                 { <% "Delayed Jobs" %>
                     "height": 3,
@@ -551,5 +648,8 @@ Resources:
                     }
                 }
 
+
+                
+
             ]
         }

data/lib/funktor/counter.rb

@@ -21,7 +21,7 @@ module Funktor
           "CloudWatchMetrics": [
             {
               "Namespace": ENV['FUNKTOR_APP_NAME'],
-              "Dimensions": [["WorkerClassName"]],
+              "Dimensions": [["WorkerClassName"], ["Queue"]],
               "Metrics": [ # CPU, Memory, Duration, etc...
                            {
                              "Name": dimension,
@@ -32,6 +32,7 @@ module Funktor
           ]
         },
         "WorkerClassName": job.worker_class_name,
+        "Queue": job.queue,
         "#{dimension}": 1
         #"count": value,
         #"requestId": "989ffbf8-9ace-4817-a57c-e4dd734019ee"

data/lib/funktor/error_handler.rb

@@ -0,0 +1,25 @@
+module Funktor
+  module ErrorHandler
+    class Logger
+      def call(error, context)
+        Funktor.logger.warn(Funktor.dump_json(context)) unless context.empty?
+        Funktor.logger.warn("#{error.class.name}: #{error.message}")
+        Funktor.logger.warn(error.backtrace.join("\n")) unless error.backtrace.nil?
+      end
+
+      Funktor.error_handlers << Funktor::ErrorHandler::Logger.new
+    end
+
+    def handle_error(error, context = {})
+      Funktor.error_handlers.each do |handler|
+        begin
+          handler.call(error, context)
+        rescue => new_error
+          Funktor.logger.error "!!! ERROR HANDLER THREW AN ERROR !!!"
+          Funktor.logger.error new_error
+          Funktor.logger.error new_error.backtrace.join("\n") unless new_error.backtrace.nil?
+        end
+      end
+    end
+  end
+end

data/lib/funktor/logger.rb

@@ -0,0 +1,5 @@
+require 'logger'
+module Funktor
+  class Logger < ::Logger
+  end
+end

data/lib/funktor/middleware/metrics.rb

@@ -20,7 +20,7 @@ module Funktor
             "CloudWatchMetrics": [
               {
                 "Namespace": ENV['FUNKTOR_APP_NAME'],
-                "Dimensions": [["WorkerClassName"]],
+                "Dimensions": [["WorkerClassName"], ["Queue"]],
                 "Metrics": [ # CPU, Memory, Duration, etc...
                              {
                                "Name": "Duration",
@@ -31,6 +31,7 @@ module Funktor
             ]
           },
           "WorkerClassName": job.worker_class_name,
+          "Queue": job.queue,
           "Duration": time_diff_in_seconds * 1_000
           #"count": value,
           #"requestId": "989ffbf8-9ace-4817-a57c-e4dd734019ee"

data/lib/funktor/version.rb

@@ -1,3 +1,3 @@
 module Funktor
-  VERSION = "0.2.13"
+  VERSION = "0.2.18"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: funktor
 version: !ruby/object:Gem::Version
-  version: 0.2.13
+  version: 0.2.18
 platform: ruby
 authors:
 - Jeremy Green
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-30 00:00:00.000000000 Z
+date: 2021-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sqs
@@ -137,9 +137,11 @@ files:
 - lib/funktor/cli/templates/package.json
 - lib/funktor/cli/templates/serverless.yml
 - lib/funktor/counter.rb
+- lib/funktor/error_handler.rb
 - lib/funktor/fake_job_queue.rb
 - lib/funktor/incoming_job_handler.rb
 - lib/funktor/job.rb
+- lib/funktor/logger.rb
 - lib/funktor/middleware/metrics.rb
 - lib/funktor/middleware_chain.rb
 - lib/funktor/testing.rb