event_tracer 0.3.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '002520584662d6b31ce2f05310a70c4fb8af37c3c865f6bdf2b8ebc44bf16654'
-  data.tar.gz: daa3fc169b3daa2771adb7d832872c055b723dbe25d28fff4ba24c618f2b54a2
+  metadata.gz: f13a5619d77a274784538f42abb8121d19f91fc24f4d2def934e9430aa232410
+  data.tar.gz: f281a954af8e3d1e38fc6640ca9ca971ae46b2ea567f80b6d569a4e432fe117f
 SHA512:
-  metadata.gz: '038e91c1d03b17070b97c3c170d73992d4050b9cee39f3529fc712a2cfda324d8afdfb10013f6a6838176966f94d6dd17b5f4851a62af6bdc0e6c8ea2b2e95b1'
-  data.tar.gz: fdeb28420163369840b82b0a56e6bd83a638fe4c5e7069f280c6807d8f9ad00b9044c642263fc89391628c110af8e527596c2e86c2b759a50691c3d13a7390c5
+  metadata.gz: f24211641d5b8f3ae7e6006122b2f8dc3af0403249e8149dcc64caf479d07cf6b7d96aae8ae7295a048935c1a9b38fa769a2f1ea6cdce2243f8a0bb7bea90cbe
+  data.tar.gz: c5c85f05628fbeb39878f2ba9dd04a87fb0d02f284f09b827cedf69454154d7a8db0d3d224d85456d01c4152f28d661bf4d5eda7ec9d943ed2d756e38611cf6f

data/lib/event_tracer/appsignal_logger.rb

@@ -1,4 +1,3 @@
-require_relative '../event_tracer'
 require_relative './basic_decorator'
 
 # NOTES
@@ -21,9 +20,11 @@ module EventTracer
     DEFAULT_METRIC_TYPE = :increment_counter
     DEFAULT_COUNTER = 1
 
+    attr_reader :allowed_tags
+
     def initialize(decoratee, allowed_tags: [])
       super(decoratee)
-      @allowed_tags = allowed_tags
+      @allowed_tags = allowed_tags.freeze
     end
 
     LOG_TYPES.each do |log_type|
@@ -53,7 +54,6 @@ module EventTracer
 
     private
 
-      attr_reader :decoratee, :allowed_tags
       alias_method :appsignal, :decoratee
 
       def valid_args?(metrics)

data/lib/event_tracer/base_logger.rb

@@ -1,4 +1,3 @@
-require_relative '../event_tracer'
 require_relative './basic_decorator'
 require 'json'
 
@@ -15,7 +14,6 @@ module EventTracer
 
     private
 
-      attr_reader :logger, :decoratee
       alias_method :logger, :decoratee
 
       # EventTracer ensures action & message is always populated

data/lib/event_tracer/basic_decorator.rb

@@ -24,5 +24,8 @@ module EventTracer
       LogResult.new(false, message)
     end
 
+    private
+
+    attr_reader :decoratee
   end
 end

data/lib/event_tracer/buffered_logger.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'time'
+
+module EventTracer
+  class BufferedLogger
+    def initialize(log_processor:, worker:, buffer: Buffer.new(buffer_size: 0))
+      @buffer = buffer
+      @worker = worker
+      @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, :worker
+
+    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]
+        execute_payload(all_payloads)
+      end
+
+      LogResult.new(true)
+    end
+
+    def execute_payload(payloads)
+      worker.perform_async(payloads)
+    rescue JSON::GeneratorError => e
+      filtered_payloads = filter_invalid_data(payloads)
+
+      EventTracer.warn(
+        loggers: %i(base),
+        action: self.class.name,
+        app: EventTracer::Config.config.app_name,
+        error: e.class.name,
+        message: e.message,
+        payload: payloads - filtered_payloads
+      )
+
+      worker.perform_async(filtered_payloads) if filtered_payloads.any?
+    end
+
+    def filter_invalid_data(payloads)
+      payloads.select { |payload| payload.to_json rescue false }
+    end
+  end
+end

data/lib/event_tracer/config.rb

@@ -5,6 +5,10 @@ module EventTracer
     extend Dry::Configurable
 
     setting :app_name, default: 'app_name'
+
+    # TODO: switch to namespace in v1.0
     setting :dynamo_db_table_name, default: 'logs'
+    setting :dynamo_db_client
+    setting :dynamo_db_queue_name, default: 'low'
   end
 end

data/lib/event_tracer/datadog_logger.rb

@@ -1,4 +1,3 @@
-require_relative '../event_tracer'
 require_relative './basic_decorator'
 # NOTES
 # Datadog interface to send our usual actions
@@ -23,9 +22,11 @@ module EventTracer
     DEFAULT_METRIC_TYPE = :count
     DEFAULT_COUNTER = 1
 
+    attr_reader :allowed_tags
+
     def initialize(decoratee, allowed_tags: [])
       super(decoratee)
-      @allowed_tags = allowed_tags
+      @allowed_tags = allowed_tags.freeze
     end
 
     LOG_TYPES.each do |log_type|
@@ -55,7 +56,6 @@ module EventTracer
 
     private
 
-    attr_reader :decoratee, :allowed_tags
     alias_method :datadog, :decoratee
 
     def valid_args?(metrics)

data/lib/event_tracer/dynamo_db/client.rb

@@ -0,0 +1,14 @@
+module EventTracer
+  module DynamoDB
+    class Client
+      class << self
+        extend Gem::Deprecate
+
+        def call
+          Aws::DynamoDB::Client.new
+        end
+        deprecate :call, 'EventTracer::Config.config.dynamo_db_client', 2021, 12
+      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,16 @@
+# frozen_string_literal: true
+
+require 'time'
+require_relative 'client'
+require_relative 'worker'
+require_relative 'default_processor'
+
+module EventTracer
+  module DynamoDB
+    class Logger < BufferedLogger
+      def initialize(buffer: Buffer.new(buffer_size: 0), log_processor: DefaultProcessor.new)
+        super(buffer: buffer, log_processor: log_processor, worker: Worker)
+      end
+    end
+  end
+end

data/lib/event_tracer/dynamo_db/worker.rb

@@ -0,0 +1,77 @@
+# 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: EventTracer::Config.config.dynamo_db_queue_name
+
+      # 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 initialize(client = nil)
+        @config = EventTracer::Config.config
+        @client = client || @config.dynamo_db_client || Client.call
+      end
+
+      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.batch_write_item(
+            request_items: { 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
+
+        attr_reader :client, :config
+
+        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.3'.freeze
 end

data/lib/event_tracer.rb

@@ -3,7 +3,7 @@ require 'event_tracer/log_result'
 
 module EventTracer
 
-  LOG_TYPES ||= %i(info warn error)
+  LOG_TYPES = %i(info warn error)
 
   @loggers = {}
 
@@ -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.3
 platform: ruby
 authors:
 - melvrickgoh
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-11 00:00:00.000000000 Z
+date: 2022-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -93,12 +93,13 @@ files:
 - lib/event_tracer/base_logger.rb
 - lib/event_tracer/basic_decorator.rb
 - lib/event_tracer/buffer.rb
+- lib/event_tracer/buffered_logger.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 +122,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