event_tracer 0.0.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 14d9cc0ad49951e17c576a3fc4c1fbc9ffba1823
-  data.tar.gz: 3bc38170384e3d53f614222fc6e26dfc434b1ca1
+SHA256:
+  metadata.gz: 77058f3fa969027f3d51399425d8885c60037ae6250db1cfa686fbafb8524467
+  data.tar.gz: 40b98f105722939c88bb364a04bfbd708c9fcfc2c76815d41d5b2318994aa9bb
 SHA512:
-  metadata.gz: 92ad282b66078714af4e6345d3ffdfc3c4c347dabeae22dcf6d957072dcb4c899257297ed0c33502dd1a04a099fe973306e639dacc40094fec9bab9f490612a8
-  data.tar.gz: 7e520b9b01770affe29bd639aa3bc7828ead5a5ac9de73d12515029fe55ed7cba27ead64695d1795b4cab482bed9b2e13787e3453414cfac9ba65d992c142da2
+  metadata.gz: 31fb42ad32f68d2efd4b78dbfb9d55f16563bc897eaa4c4602c5855eb092bf0f03c4308c22a91ed011663c095548029155a7a795de638405588bb162a93d723b
+  data.tar.gz: 58c9ec65b708b9b44fb141c9da778fbc6d56fea371a8edc9e0aaf9ef4d4a2b89855e0a88afbafd0a61312c2b8023bd7c13325bc0f7c86be13ee7d87e534dc6ad

data/lib/event_tracer.rb

@@ -1,4 +1,5 @@
-require "event_tracer/version"
+require 'event_tracer/version'
+require 'event_tracer/log_result'
 
 module EventTracer
 
@@ -16,30 +17,68 @@ module EventTracer
 
   LOG_TYPES.each do |log_type|
     define_singleton_method log_type do |loggers: nil, **args|
-      begin
-        (selected_loggers(loggers) || @loggers).each do |_code, logger|
-          logger.send(log_type, **args)
-        end
-        true
-      rescue Exception => e
-        p e.message
-        false
-      end
+      send_log_messages(
+        log_type,
+        (selected_loggers(loggers) || @loggers),
+        args
+      )
     end
   end
 
   private
 
+    def self.send_log_messages(log_type, loggers, args)
+      result = Result.new
+
+      loggers.each do |code, logger|
+        begin
+          if args[:action] && args[:message]
+            result.record code, logger.send(log_type, filtered_log_arguments(code, args))
+          else
+            result.record code, LogResult.new(false, 'Fields action & message need to be populated')
+          end
+        rescue Exception => e
+          result.record code, LogResult.new(false, e.message)
+        end
+      end
+
+      result
+    end
+
     def self.selected_loggers(logger_codes)
       return unless logger_codes.is_a?(Array)
       return if logger_codes.detect { |code| !code.is_a?(Symbol) }
 
-      selected_codes = logger_codes.uniq & @loggers.keys
+      selected_codes = logger_codes.uniq & registered_logger_codes
 
       return if selected_codes.empty?
       @loggers.select { |code, _logger| selected_codes.include?(code) }
     end
 
+    def self.filtered_log_arguments(logger_code, args)
+      blacklisted_logger_keys = registered_logger_codes - [logger_code]
+
+      args.reject do |key, _value|
+        blacklisted_logger_keys.include?(key)
+      end
+    end
+
+    def self.registered_logger_codes
+      @loggers.keys
+    end
+
+    class Result
+      attr_reader :records
+
+      def initialize
+        @records = {}
+      end
+
+      def record(logger_code, outcome)
+        records[logger_code] = outcome
+      end
+    end
+
 end
 
 project_root = File.dirname(File.absolute_path(__FILE__))

data/lib/event_tracer/appsignal_logger.rb

@@ -7,6 +7,7 @@ require_relative './basic_decorator'
 #
 # Usage: EventTracer.register :appsignal, EventTracer::AppsignalLogger.new(Appsignal)
 #        appsignal_logger.info appsignal: { increment_counter: { counter_1: 1, counter_2: 2 }, set_gauge: { gauge_1: 1 } }
+#        appsignal_logger.info appsignal: { set_gauge: { gauge_1: { value: 1, tags: { region: 'eu' } } } }
 module EventTracer
   class AppsignalLogger < BasicDecorator
 
@@ -14,11 +15,18 @@ module EventTracer
 
     LOG_TYPES.each do |log_type|
       define_method log_type do |**args|
-        SUPPORTED_METRICS.each do |metric|
-          next unless args[:appsignal] && args[:appsignal][metric].is_a?(Hash)
-          send_metric(metric, args[:appsignal][metric]) unless args[:appsignal][metric].empty?
+        return LogResult.new(false, "Invalid appsignal config") unless args[:appsignal] && args[:appsignal].is_a?(Hash)
+
+        applied_metrics(args[:appsignal]).each do |metric|
+          metric_args = args[:appsignal][metric]
+          return LogResult.new(false, "Appsignal metric #{metric} invalid") unless metric_args && metric_args.is_a?(Hash) 
+
+          send_metric metric, metric_args
+        rescue InvalidTagError => e
+          return LogResult.new(false, e.message)
         end
-        true
+
+        LogResult.new(true)
       end
     end
 
@@ -27,11 +35,29 @@ module EventTracer
       attr_reader :appsignal, :decoratee
       alias_method :appsignal, :decoratee
 
+      def applied_metrics(appsignal_args)
+        appsignal_args.keys.select { |metric| SUPPORTED_METRICS.include?(metric) }
+      end
+
       def send_metric(metric, payload)
-        payload.each do |increment, value|
-          appsignal.send(metric, increment, value)
+        payload.each do |increment, attribute|
+          if attribute.is_a?(Hash)
+            begin
+              appsignal.send(
+                metric,
+                increment,
+                attribute.fetch(:value),
+                attribute.fetch(:tags)
+              )
+            rescue KeyError
+              raise InvalidTagError, "Appsignal payload { #{increment}: #{attribute} } invalid"
+            end
+          else
+            appsignal.send(metric, increment, attribute)
+          end
         end
       end
-
   end
+
+  class InvalidTagError < StandardError; end
 end

data/lib/event_tracer/base_logger.rb

@@ -0,0 +1,28 @@
+require_relative '../event_tracer'
+require_relative './basic_decorator'
+require 'json'
+
+# Usage: EventTracer.register :base, EventTracer::BaseLogger.new(Logger.new(STDOUT))
+module EventTracer
+  class BaseLogger < BasicDecorator
+
+    LOG_TYPES.each do |log_type|
+      define_method log_type do |*args|
+        send_message(log_type, *args)
+        LogResult.new(true)
+      end
+    end
+
+    private
+
+      attr_reader :logger, :decoratee
+      alias_method :logger, :decoratee
+
+      # EventTracer ensures action & message is always populated
+      def send_message(log_method, action:, message:, **args)
+        data = args.merge(action: action, message: message)
+        logger.public_send(log_method, data)
+      end
+
+  end
+end

data/lib/event_tracer/datadog_logger.rb

@@ -0,0 +1,75 @@
+require_relative '../event_tracer'
+require_relative './basic_decorator'
+# NOTES
+# Datadog interface to send our usual actions
+# BasicDecorator adds a transparent interface on top of the datadog interface
+#
+# Usage: EventTracer.register :datadog, EventTracer::DataDogLogger.new(DataDog)
+#        data_dog_logger.info datadog: { count: { counter_1: 1, counter_2: 2 }, set: { gauge_1: 1 } }
+#        data_dog_logger.info datadog: { count: { counter_1: { value: 1, tags: ['tag1, tag2']} } }
+
+module EventTracer
+  class DatadogLogger < BasicDecorator
+
+    class InvalidTagError < StandardError; end
+
+    SUPPORTED_METRICS ||= %i[count set distribution gauge histogram].freeze
+
+    LOG_TYPES.each do |log_type|
+      define_method log_type do |**args|
+        return LogResult.new(false, 'Invalid datadog config') unless args[:datadog]&.is_a?(Hash)
+
+        applied_metrics(args[:datadog]).each do |metric|
+          metric_args = args[:datadog][metric]
+          return LogResult.new(false, "Datadog metric #{metric} invalid") unless metric_args.is_a?(Hash)
+
+          send_metric metric, metric_args
+        end
+
+        LogResult.new(true)
+      end
+    end
+
+    private
+
+    attr_reader :datadog, :decoratee
+    alias_method :datadog, :decoratee
+
+    def applied_metrics(datadog_args)
+      datadog_args.keys.select { |metric| SUPPORTED_METRICS.include?(metric) }
+    end
+
+    def send_metric(metric, payload)
+      payload.each do |increment, attribute|
+        if attribute.is_a?(Hash)
+          begin
+            datadog.public_send(
+              metric,
+              increment,
+              attribute.fetch(:value),
+              build_options(attribute[:tags])
+            )
+          rescue KeyError
+            raise InvalidTagError, "Datadog payload { #{increment}: #{attribute} } invalid"
+          end
+        else
+          datadog.public_send(metric, increment, attribute)
+        end
+      end
+    end
+
+    def build_options(tags)
+      return {} unless tags
+
+      formattted_tags =
+        if tags.is_a?(Array)
+          tags
+        else
+          tags.inject([]) do |acc, (tag, value)|
+            acc << "#{tag}:#{value}"
+          end
+        end
+      { tags: formattted_tags }
+    end
+  end
+end

data/lib/event_tracer/log_result.rb

@@ -0,0 +1,4 @@
+module EventTracer
+  class LogResult < Struct.new(:success?, :error)
+  end
+end

data/lib/event_tracer/version.rb

@@ -1,3 +1,3 @@
 module EventTracer
-  VERSION = "0.0.1"
+  VERSION = '0.2.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: event_tracer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.1
 platform: ruby
 authors:
 - melvrickgoh
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-01-06 00:00:00.000000000 Z
+date: 2020-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -62,14 +62,16 @@ extra_rdoc_files: []
 files:
 - lib/event_tracer.rb
 - lib/event_tracer/appsignal_logger.rb
+- lib/event_tracer/base_logger.rb
 - lib/event_tracer/basic_decorator.rb
-- lib/event_tracer/logger.rb
+- lib/event_tracer/datadog_logger.rb
+- lib/event_tracer/log_result.rb
 - lib/event_tracer/version.rb
 homepage: https://github.com/melvrickgoh/event_tracer
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib/event_tracer
@@ -85,9 +87,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Thin wrapper for formatted logging/ metric services to be used as a single
   service

data/lib/event_tracer/logger.rb

@@ -1,28 +0,0 @@
-require_relative '../event_tracer'
-require_relative './basic_decorator'
-require 'json'
-
-# Usage: EventTracer.register :base, EventTracer::Logger.new(Logger.new(STDOUT))
-module EventTracer
-  class Logger < BasicDecorator
-
-    LOG_TYPES.each do |log_type|
-      define_method log_type do |*args|
-        send_message(log_type, *args)
-      end
-    end
-
-    private
-
-      attr_reader :logger, :decoratee
-      alias_method :logger, :decoratee
-
-      # execute only if there's a message to be logged
-      def send_message(log_method, action: nil, simple_message: nil, **args)
-        return false unless simple_message || args[:message]
-        message_to_send = simple_message ? simple_message : args.to_json
-        logger.send(log_method, "[#{action}] #{message_to_send}")
-      end
-
-  end
-end