event_tracer 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '002520584662d6b31ce2f05310a70c4fb8af37c3c865f6bdf2b8ebc44bf16654'
-  data.tar.gz: daa3fc169b3daa2771adb7d832872c055b723dbe25d28fff4ba24c618f2b54a2
+  metadata.gz: 5f5987bb0a399ec5960ef763bfcd0dbfa5ccd6057706deb1a1916daa126208be
+  data.tar.gz: 4ccd9d11711d43ff6bb9facc9bed872f2023d09f1c1669469eb1583bce46783b
 SHA512:
-  metadata.gz: '038e91c1d03b17070b97c3c170d73992d4050b9cee39f3529fc712a2cfda324d8afdfb10013f6a6838176966f94d6dd17b5f4851a62af6bdc0e6c8ea2b2e95b1'
-  data.tar.gz: fdeb28420163369840b82b0a56e6bd83a638fe4c5e7069f280c6807d8f9ad00b9044c642263fc89391628c110af8e527596c2e86c2b759a50691c3d13a7390c5
+  metadata.gz: 0d741c12baacd00c430f8d312d364161ba5959ccbcbfc79093ca520908b1d0c1537d9c50d918b3cb1df3610e5384f2fe36416342b9154fcec7e0d3d07b4d5d9f
+  data.tar.gz: 5bfd26725b5048a49a94746015127385cf03ada9fa9cede00d8a329780d3524442d40e4157a75c66c820e4076baa1d531381e7fd92374dcf98d0880c419be935

data/lib/event_tracer/dynamo_db/client.rb

@@ -0,0 +1,9 @@
+module EventTracer
+  module DynamoDB
+    class Client
+      def self.call
+        Aws::DynamoDB::Client.new
+      end
+    end
+  end
+end

data/lib/event_tracer/dynamo_db/default_processor.rb

@@ -0,0 +1,15 @@
+module EventTracer
+  module DynamoDB
+    class DefaultProcessor
+      def call(log_type, action:, message:, args:)
+        args.merge(
+          timestamp: Time.now.utc.iso8601(6),
+          action: action,
+          message: message,
+          log_type: log_type,
+          app: EventTracer::Config.config.app_name
+        )
+      end
+    end
+  end
+end

data/lib/event_tracer/dynamo_db/logger.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'time'
+require_relative 'client'
+require_relative 'worker'
+require_relative 'default_processor'
+
+module EventTracer
+  module DynamoDB
+    class Logger
+      def initialize(buffer: Buffer.new(buffer_size: 0), log_processor: DefaultProcessor.new)
+        @buffer = buffer
+        @log_processor = log_processor
+      end
+
+      EventTracer::LOG_TYPES.each do |log_type|
+        define_method log_type do |**args|
+          save_message log_type, **args
+        end
+      end
+
+      private
+
+        attr_reader :buffer, :log_processor
+
+        def save_message(log_type, action:, message:, **args)
+          payload = log_processor.call(log_type, action: action, message: message, args: args)
+
+          unless buffer.add(payload)
+            all_payloads = buffer.flush + [payload]
+            Worker.perform_async(all_payloads)
+          end
+
+          LogResult.new(true)
+        end
+
+    end
+  end
+end

data/lib/event_tracer/dynamo_db/worker.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative 'client'
+
+begin
+  require 'sidekiq'
+  require 'aws-sdk-dynamodb'
+rescue LoadError => e
+  puts "Please add the missing gem into your app Gemfile: #{e.message}"
+  raise
+end
+
+module EventTracer
+  module DynamoDB
+    class Worker
+      include ::Sidekiq::Worker
+
+      sidekiq_options retry: 1, queue: 'low'
+
+      # See https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#batch_write_item-instance_method
+      MAX_DYNAMO_DB_ITEM_PER_REQUEST = 25
+
+      def perform(items)
+        wrap(items).each_slice(MAX_DYNAMO_DB_ITEM_PER_REQUEST) do |batch|
+          data = batch.map do |item|
+            { put_request: { item: clean_empty_values(item) } }
+          end
+
+          Client.call.batch_write_item(
+            request_items: { EventTracer::Config.config.dynamo_db_table_name => data }
+          )
+
+        rescue Aws::DynamoDB::Errors::ServiceError => e
+          EventTracer.error(
+            loggers: %i(base),
+            action: 'DynamoDBWorker',
+            app: EventTracer::Config.config.app_name,
+            error: e.class.name,
+            message: e.message
+          )
+        end
+      end
+
+      private
+
+        def wrap(items)
+          # NOTE: This allows us to handle either buffered or unbuffered payloads
+          if items.is_a?(Hash)
+            [items]
+          else
+            Array(items)
+          end
+        end
+
+        # dynamo can't serialise empty strings/ non-zero numerics
+        def clean_empty_values(data)
+          data.delete_if do |_key, value|
+            case value
+            when Hash
+              clean_empty_values(value)
+              false
+            when String then value.empty?
+            else false
+            end
+          end
+        end
+
+    end
+  end
+end

data/lib/event_tracer/version.rb

@@ -1,3 +1,3 @@
 module EventTracer
-  VERSION = '0.3.2'.freeze
+  VERSION = '0.4.0'.freeze
 end

data/lib/event_tracer.rb

@@ -70,4 +70,4 @@ module EventTracer
 end
 
 project_root = File.dirname(File.absolute_path(__FILE__))
-Dir.glob("#{project_root}/event_tracer/*") {|file| require file}
+Dir.glob("#{project_root}/event_tracer/*.rb") {|file| require file}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: event_tracer
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - melvrickgoh
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-11 00:00:00.000000000 Z
+date: 2021-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -95,10 +95,10 @@ files:
 - lib/event_tracer/buffer.rb
 - lib/event_tracer/config.rb
 - lib/event_tracer/datadog_logger.rb
-- lib/event_tracer/dynamo_db_client.rb
-- lib/event_tracer/dynamo_db_default_processor.rb
-- lib/event_tracer/dynamo_db_log_worker.rb
-- lib/event_tracer/dynamo_db_logger.rb
+- lib/event_tracer/dynamo_db/client.rb
+- lib/event_tracer/dynamo_db/default_processor.rb
+- lib/event_tracer/dynamo_db/logger.rb
+- lib/event_tracer/dynamo_db/worker.rb
 - lib/event_tracer/log_result.rb
 - lib/event_tracer/version.rb
 homepage: https://github.com/melvrickgoh/event_tracer
@@ -121,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.28
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Thin wrapper for formatted logging/ metric services to be used as a single

data/lib/event_tracer/dynamo_db_client.rb

@@ -1,7 +0,0 @@
-module EventTracer
-  class DynamoDBClient
-    def self.call
-      Aws::DynamoDB::Client.new
-    end
-  end
-end

data/lib/event_tracer/dynamo_db_default_processor.rb

@@ -1,13 +0,0 @@
-module EventTracer
-  class DynamoDBDefaultProcessor
-    def call(log_type, action:, message:, args:)
-      args.merge(
-        timestamp: Time.now.utc.iso8601(6),
-        action: action,
-        message: message,
-        log_type: log_type,
-        app: EventTracer::Config.config.app_name
-      )
-    end
-  end
-end

data/lib/event_tracer/dynamo_db_log_worker.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'dynamo_db_client'
-
-begin
-  require 'sidekiq'
-  require 'aws-sdk-dynamodb'
-rescue LoadError => e
-  puts "Please add the missing gem into your app Gemfile: #{e.message}"
-  raise
-end
-
-module EventTracer
-  class DynamoDBLogWorker
-    include ::Sidekiq::Worker
-
-    sidekiq_options retry: 1, queue: 'low'
-
-    # See https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DynamoDB/Client.html#batch_write_item-instance_method
-    MAX_DYNAMO_DB_ITEM_PER_REQUEST = 25
-
-    def perform(items)
-      wrap(items).each_slice(MAX_DYNAMO_DB_ITEM_PER_REQUEST) do |batch|
-        data = batch.map do |item|
-          { put_request: { item: clean_empty_values(item) } }
-        end
-
-        EventTracer::DynamoDBClient.call.batch_write_item(
-          request_items: { EventTracer::Config.config.dynamo_db_table_name => data }
-        )
-
-      rescue Aws::DynamoDB::Errors::ServiceError => e
-        EventTracer.error(
-          loggers: %i(base),
-          action: 'DynamoDBLogWorker',
-          app: EventTracer::Config.config.app_name,
-          error: e.class.name,
-          message: e.message
-        )
-      end
-    end
-
-    private
-
-      def wrap(items)
-        # NOTE: This allows us to handle either buffered or unbuffered payloads
-        if items.is_a?(Hash)
-          [items]
-        else
-          Array(items)
-        end
-      end
-
-      # dynamo can't serialise empty strings/ non-zero numerics
-      def clean_empty_values(data)
-        data.delete_if do |_key, value|
-          case value
-          when Hash
-            clean_empty_values(value)
-            false
-          when String then value.empty?
-          else false
-          end
-        end
-      end
-
-  end
-end

data/lib/event_tracer/dynamo_db_logger.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require 'time'
-require_relative 'dynamo_db_client'
-
-module EventTracer
-  class DynamoDBLogger
-    def initialize(buffer: Buffer.new(buffer_size: 0), log_processor: EventTracer::DynamoDBDefaultProcessor.new)
-      @buffer = buffer
-      @log_processor = log_processor
-    end
-
-    EventTracer::LOG_TYPES.each do |log_type|
-      define_method log_type do |**args|
-        save_message log_type, **args
-      end
-    end
-
-    private
-
-      attr_reader :buffer, :log_processor
-
-      def save_message(log_type, action:, message:, **args)
-        payload = log_processor.call(log_type, action: action, message: message, args: args)
-
-        unless buffer.add(payload)
-          all_payloads = buffer.flush + [payload]
-          DynamoDBLogWorker.perform_async(all_payloads)
-        end
-
-        LogResult.new(true)
-      end
-
-  end
-end