event_tracer 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16cc39532664c9eb8da45f8f90a3a76ca7f180cc81da848bdf980dba5f91bfc8
-  data.tar.gz: 713186d9e6d2de28d334f2a29db2be8e8619f7176080b5d9390f5225568db0af
+  metadata.gz: 335d4c810b2a3e378d826518f8e8c6c2a8a1310f029401381ac2f407437554ca
+  data.tar.gz: 95971a338ad15cb6f5f74bb78f10f59dfba0918c7578a3e1057f8d11e5dc7bbb
 SHA512:
-  metadata.gz: 9a5faa6c50a2662896675686b0da3b2706ca29ec102e244be0230547e551e2da014af73954a2396870ebf20b1e55b170451e8f4863257a713776aab6dbc301d6
-  data.tar.gz: c2b1ce96276d8821b476a21c35528c3f1c738363d960e1c709e3a1f361228fe4d0ac09ab8f13f2c6a1daef834f35f0fe22fca8b2cc328eab54a114eaa062a039
+  metadata.gz: 473b42b4728e7233bdddaa4d85c681b33b41c71c26eb78ee9578c332f878e78234e6007b37c6c120e0adf13eaa8dd87e18f09d2069cfe7ca578e2ef8f1fc6079
+  data.tar.gz: 5a58acc598909419d8164a4cfb46c2c9695b12faee98bdf2ae937648dc964c4c70e04c78e8a2395ed133a245ca86d4ac7d471972a7e72510267d2bcb754b1e56

data/lib/event_tracer/base_logger.rb

@@ -20,7 +20,8 @@ module EventTracer
 
       # EventTracer ensures action & message is always populated
       def send_message(log_method, action:, message:, **args)
-        data = args.merge(action: action, message: message).except(:metrics)
+        args.delete(:metrics)
+        data = args.merge(action: action, message: message)
         logger.public_send(log_method, data)
       end
 

data/lib/event_tracer/buffer.rb

@@ -0,0 +1,65 @@
+require 'concurrent'
+
+module EventTracer
+  # This is an implementation of buffer storage. We use Concurrent::Array underneath
+  # to ensure thread-safe behavior. Data is stored until certain size / interval
+  # before flushing.
+  #
+  # Caveats: We should only store non-important data like logs in this buffer
+  # because if a process is killed, the data in this buffer is lost.
+  class Buffer
+    # Buffer can store maximum 10 items.
+    # Bigger size requires more memory to store, so choose a reasonable number
+    DEFAULT_BUFFER_SIZE = 10
+    # An item can live in buffer for at least 10s between each `Buffer#add` if the buffer is not full
+    # If there are larger interval between the calls, it can live longer.
+    DEFAULT_FLUSH_INTERVAL = 10
+
+    def initialize(
+      buffer_size: DEFAULT_BUFFER_SIZE,
+      flush_interval: DEFAULT_FLUSH_INTERVAL
+    )
+      @buffer_size = buffer_size
+      @flush_interval = flush_interval
+      @buffer = Concurrent::Array.new
+    end
+
+    # Add an item to buffer
+    #
+    # @param item: data to be added to buffer
+    # @return true if the item can be added, otherwise false
+    def add(item)
+      if add_item?
+        buffer.push({ item: item, created_at: Time.now })
+        true
+      else
+        false
+      end
+    end
+
+    # Remove all existing items from buffer
+    #
+    # @return all items in buffer
+    def flush
+      data = []
+
+      data << buffer.shift[:item] until buffer.empty?
+
+      data
+    end
+
+    # This method is only used to facilitate testing
+    def size
+      buffer.size
+    end
+
+    private
+
+      attr_reader :buffer_size, :flush_interval, :buffer
+
+      def add_item?
+        buffer.size < buffer_size &&
+          (buffer.empty? || buffer.first[:created_at] > Time.now - flush_interval)
+      end
+  end
+end

data/lib/event_tracer/config.rb

@@ -0,0 +1,13 @@
+require 'dry-configurable'
+
+module EventTracer
+  class Config
+    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
+  end
+end

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,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,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: '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 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.0'.freeze
+  VERSION = '0.4.1'.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,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: event_tracer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - melvrickgoh
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-11 00:00:00.000000000 Z
+date: 2021-11-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 description: 'Thin wrapper for formatted logging/ metric services to be used as a
-  single service. External service(s) supported: Appsignal'
+  single service. External service(s) supported: Appsignal, Datadog, DynamoDB'
 email:
 - melvrickgoh@hotmail.com
 executables: []
@@ -64,7 +92,13 @@ files:
 - lib/event_tracer/appsignal_logger.rb
 - lib/event_tracer/base_logger.rb
 - lib/event_tracer/basic_decorator.rb
+- 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/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