event_tracer 0.4.0 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f5987bb0a399ec5960ef763bfcd0dbfa5ccd6057706deb1a1916daa126208be
-  data.tar.gz: 4ccd9d11711d43ff6bb9facc9bed872f2023d09f1c1669469eb1583bce46783b
+  metadata.gz: 1eb75aebdf04e2a3797b9cb77780ab1f1960846b9332899d466ef67e269f599d
+  data.tar.gz: 9ffcabba2a3435bab02a8e6e2929250ee5aa659069b1d006d29c3df084923a45
 SHA512:
-  metadata.gz: 0d741c12baacd00c430f8d312d364161ba5959ccbcbfc79093ca520908b1d0c1537d9c50d918b3cb1df3610e5384f2fe36416342b9154fcec7e0d3d07b4d5d9f
-  data.tar.gz: 5bfd26725b5048a49a94746015127385cf03ada9fa9cede00d8a329780d3524442d40e4157a75c66c820e4076baa1d531381e7fd92374dcf98d0880c419be935
+  metadata.gz: fa666b368a2a7cdb565a850b460e0f763b195550cfdd640d9d7970709370cdc531eda7b48caab30b4687c00002bed32540511f3df4d83606ff1a33f6885b4698
+  data.tar.gz: 94dfdbc766ba5dcc02fac74d81ced3ed516d9a29ad578a8472810955aa66ffe0f92db1507593d2846951ff613e1524cb07fb37e8d8f2f4e7ae43b9db4c05161b

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

@@ -1,10 +1,24 @@
 require 'dry-configurable'
+require 'dry/configurable/version'
 
 module EventTracer
   class Config
     extend Dry::Configurable
 
-    setting :app_name, default: 'app_name'
-    setting :dynamo_db_table_name, default: 'logs'
+    if Dry::Configurable::VERSION >= "0.13"
+      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'
+    else
+      setting :app_name, 'app_name'
+
+      # TODO: switch to namespace in v1.0
+      setting :dynamo_db_table_name, 'logs'
+      setting :dynamo_db_client
+      setting :dynamo_db_queue_name, 'low'
+    end
   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

@@ -1,8 +1,13 @@
 module EventTracer
   module DynamoDB
     class Client
-      def self.call
-        Aws::DynamoDB::Client.new
+      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

data/lib/event_tracer/dynamo_db/logger.rb

@@ -7,33 +7,10 @@ require_relative 'default_processor'
 
 module EventTracer
   module DynamoDB
-    class Logger
+    class Logger < BufferedLogger
       def initialize(buffer: Buffer.new(buffer_size: 0), log_processor: DefaultProcessor.new)
-        @buffer = buffer
-        @log_processor = log_processor
+        super(buffer: buffer, log_processor: log_processor, worker: Worker)
       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

@@ -15,19 +15,24 @@ module EventTracer
     class Worker
       include ::Sidekiq::Worker
 
-      sidekiq_options retry: 1, queue: 'low'
+      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.call.batch_write_item(
-            request_items: { EventTracer::Config.config.dynamo_db_table_name => data }
+          client.batch_write_item(
+            request_items: { config.dynamo_db_table_name => data }
           )
 
         rescue Aws::DynamoDB::Errors::ServiceError => e
@@ -43,6 +48,8 @@ module EventTracer
 
       private
 
+        attr_reader :client, :config
+
         def wrap(items)
           # NOTE: This allows us to handle either buffered or unbuffered payloads
           if items.is_a?(Hash)

data/lib/event_tracer/version.rb

@@ -1,3 +1,3 @@
 module EventTracer
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.4.4'.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 = {}
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: event_tracer
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.4
 platform: ruby
 authors:
 - melvrickgoh
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-15 00:00:00.000000000 Z
+date: 2022-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -93,6 +93,7 @@ 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