event_tracer 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8be7917ff4969abe550fba1973934f60eca36600b9e1e6b541061cae4da176fa
-  data.tar.gz: b92553317d9c5432bfd64d8242ed099283f6c059c9ecfaa01a1252311001f64b
+  metadata.gz: c5207c9165b5c41811f3128fdf9d22c1dd21f805131aab1d2dfa2861bc55a43b
+  data.tar.gz: 3cda4e4b5dcb3c994797e9cae5ef3d31253e49d09a5d7527b49f107fc430e1df
 SHA512:
-  metadata.gz: 7c0ce2be131339ef8b498ed2fd15267d9d0026b21bded4f01b58b576ce238455a9025345ebd2a9ea30e742b3357f6718aa12f20c56d35ae6729c3556ec043129
-  data.tar.gz: a6bbd25e1299c39d17b0f95e86047367f5bf45bd64dc6c945ea6c67c5cbe065fb3e2e32fffb451e61430266d8d92e83324ec4a916f2e9d977a7cb2f3e1bf44dc
+  metadata.gz: 6333e12e55d047a9d4b6f5a6cb8af0781218a5be884b06a1b96fa3e994a73901f72d14e47269929df96284c0a8bb5ffc8f7aa6677413d2952a87b1b54b9f81c4
+  data.tar.gz: 8a27bbcf11291c1ca89c39944b784fb44661b00496f10412da4efbe933c7a014bac7a7fa186d55580e0fd2e766b1fcbe18565c13475091d1a01e6c1d0369c653

data/lib/event_tracer.rb

@@ -31,14 +31,10 @@ module EventTracer
       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)
+        if args[:action] && args[:message]
+          result.record code, logger.send(log_type, **args)
+        else
+          result.record code, LogResult.new(false, 'Fields action & message need to be populated')
         end
       end
 
@@ -55,14 +51,6 @@ module EventTracer
       @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

data/lib/event_tracer/appsignal_logger.rb

@@ -2,45 +2,62 @@ require_relative '../event_tracer'
 require_relative './basic_decorator'
 
 # NOTES
-# Appsignal interface to send our usual actions 
+# Appsignal interface to send our usual actions
 # BasicDecorator adds a transparent interface on top of the appsignal interface
 #
-# 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 } }
+# Usage: EventTracer.register :appsignal,
+#          EventTracer::AppsignalLogger.new(Appsignal, allowed_tags: ['tag_1', 'tag_2'])
+#
+#        appsignal_logger.info metrics: [:counter_1, :counter_2]
+#        appsignal_logger.info metrics: { counter_1: { type: :counter, value: 1 }, gauce_2: { type: :gauce, value: 10 } }
 module EventTracer
   class AppsignalLogger < BasicDecorator
 
-    SUPPORTED_METRICS ||= %i(increment_counter add_distribution_value set_gauge)
+    SUPPORTED_METRIC_TYPES = {
+      counter: :increment_counter,
+      distribution: :add_distribution_value,
+      gauge: :set_gauge
+    }
+    DEFAULT_METRIC_TYPE = :increment_counter
+    DEFAULT_COUNTER = 1
+
+    def initialize(decoratee, allowed_tags: [])
+      super(decoratee)
+      @allowed_tags = allowed_tags
+    end
 
     LOG_TYPES.each do |log_type|
       define_method log_type do |**args|
-        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
+        metrics = args[:metrics]
+
+        return fail_result('Invalid appsignal config') unless valid_args?(metrics)
+        return success_result if metrics.empty?
+
+        tags = args.slice(*allowed_tags)
+
+        case metrics
+        when Array
+          metrics.each do |metric|
+            appsignal.public_send(DEFAULT_METRIC_TYPE, metric, DEFAULT_COUNTER, tags)
+          end
+        when Hash
+          metrics.each do |metric_name, metric_payload|
+            metric_type = SUPPORTED_METRIC_TYPES[metric_payload.fetch(:type).to_sym]
+            appsignal.public_send(metric_type, metric_name, metric_payload.fetch(:value), tags) if metric_type
+          end
         end
 
-        LogResult.new(true)
+        success_result
       end
     end
 
     private
 
-      attr_reader :appsignal, :decoratee
+      attr_reader :decoratee, :allowed_tags
       alias_method :appsignal, :decoratee
 
-      def applied_metrics(appsignal_args)
-        appsignal_args.keys.select { |metric| SUPPORTED_METRICS.include?(metric) }
+      def valid_args?(metrics)
+        metrics && (metrics.is_a?(Hash) || metrics.is_a?(Array))
       end
-
-      def send_metric(metric, payload)
-        payload.each do |increment, value|
-          appsignal.send(metric, increment, value)
-        end
-      end
-
   end
 end

data/lib/event_tracer/base_logger.rb

@@ -7,8 +7,8 @@ module EventTracer
   class BaseLogger < BasicDecorator
 
     LOG_TYPES.each do |log_type|
-      define_method log_type do |*args|
-        send_message(log_type, *args)
+      define_method log_type do |**args|
+        send_message(log_type, **args)
         LogResult.new(true)
       end
     end
@@ -20,6 +20,7 @@ module EventTracer
 
       # EventTracer ensures action & message is always populated
       def send_message(log_method, action:, message:, **args)
+        args.delete(:metrics)
         data = args.merge(action: action, message: message)
         logger.public_send(log_method, data)
       end

data/lib/event_tracer/basic_decorator.rb

@@ -1,3 +1,5 @@
+require 'delegate'
+
 module EventTracer
   class BasicDecorator < Delegator
 
@@ -14,5 +16,13 @@ module EventTracer
       @delegate_sd_obj = obj
     end
 
+    def success_result
+      LogResult.new(true)
+    end
+
+    def fail_result(message)
+      LogResult.new(false, message)
+    end
+
   end
-end
+end

data/lib/event_tracer/datadog_logger.rb

@@ -4,72 +4,68 @@ require_relative './basic_decorator'
 # 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']} } }
+# Usage: EventTracer.register :datadog,
+#          EventTracer::DataDogLogger.new(DataDog, allowed_tags: ['tag_1', 'tag_2'])
+#
+#        data_dog_logger.info metrics: [:counter_1, :counter_2]
+#        data_dog_logger.info metrics: { counter_1: { type: :counter, value: 1}, gauce_2: { type: :gauce, value: 10 } }
 
 module EventTracer
   class DatadogLogger < BasicDecorator
 
-    class InvalidTagError < StandardError; end
+    SUPPORTED_METRIC_TYPES = {
+      counter: :count,
+      distribution: :distribution,
+      gauge: :gauge,
+      set: :set,
+      histogram: :histogram
+    }
+    DEFAULT_METRIC_TYPE = :count
+    DEFAULT_COUNTER = 1
 
-    SUPPORTED_METRICS ||= %i[count set distribution gauge histogram].freeze
+    def initialize(decoratee, allowed_tags: [])
+      super(decoratee)
+      @allowed_tags = allowed_tags
+    end
 
     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)
+        metrics = args[:metrics]
+
+        return fail_result('Invalid Datadog config') unless valid_args?(metrics)
+        return success_result if metrics.empty?
 
-        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)
+        tags = build_tags(args)
 
-          send_metric metric, metric_args
+        case metrics
+        when Array
+          metrics.each do |metric|
+            datadog.public_send(DEFAULT_METRIC_TYPE, metric, DEFAULT_COUNTER, tags: tags)
+          end
+        when Hash
+          metrics.each do |metric_name, metric_payload|
+            metric_type = SUPPORTED_METRIC_TYPES[metric_payload.fetch(:type).to_sym]
+            datadog.public_send(metric_type, metric_name, metric_payload.fetch(:value), tags: tags) if metric_type
+          end
         end
 
-        LogResult.new(true)
+        success_result
       end
     end
 
     private
 
-    attr_reader :datadog, :decoratee
+    attr_reader :decoratee, :allowed_tags
     alias_method :datadog, :decoratee
 
-    def applied_metrics(datadog_args)
-      datadog_args.keys.select { |metric| SUPPORTED_METRICS.include?(metric) }
+    def valid_args?(metrics)
+      metrics && (metrics.is_a?(Hash) || metrics.is_a?(Array))
     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
+    def build_tags(args)
+      args.slice(*allowed_tags).map do |tag, value|
+        "#{tag}:#{value}"
       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/version.rb

@@ -1,3 +1,3 @@
 module EventTracer
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.1'.freeze
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: event_tracer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - melvrickgoh
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-12 00:00:00.000000000 Z
+date: 2021-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -87,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Thin wrapper for formatted logging/ metric services to be used as a single