event_tracer 0.5.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c2e5bbf4d4546e3ece6589508e00fc01eb30ca41b572ff2afbb4185b73c93d5
-  data.tar.gz: e3fe3b13cf8fc1e43732a75386502618427cab7a449fe95b8d2c69789383947b
+  metadata.gz: 77541537838df5e2de191b30cac6096e30ef9afbba5634c99ab7dceca8378f80
+  data.tar.gz: ce9067501e85318e4b22d731d9e28472e11b4142d70ff4d4e6b3049c5d5daf35
 SHA512:
-  metadata.gz: 17cd02fe83f7725b8e2a9d495979f5b183e2a63fc071b1b58795adfb910ed0c9048f1692b608d78d0348377b4c9216c1601481234ff60791206b2c1797e7d51f
-  data.tar.gz: ba23fdd140689fa467671a1f28024f38ea6b5c9e1ddd911c4980cbb91d57faf7a5ad2ce028aaffcead4f75d06ac4d5e30b0728525a3dac074ac366b8318f2797
+  metadata.gz: 3980aee7c87f0e4b7aaad10def59b2a2d7cf6aa9facad6a34193dd453048c428c0553c735fae7294376ed44e574c3371854e56eb36ec77197094a96a55945354
+  data.tar.gz: 816e02c8bddc0444fba2f8e189789c887ef2f82fc3a76618af2ed56145b249a64f4f3a5ddbba7d0fc319b8da976a72a1cd897033046849549d775b7d5498ca33

data/lib/event_tracer/appsignal_logger.rb

@@ -1,4 +1,4 @@
-require_relative './basic_decorator'
+require_relative './metric_logger'
 
 # NOTES
 # Appsignal interface to send our usual actions
@@ -10,55 +10,32 @@ require_relative './basic_decorator'
 #        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
+  class AppsignalLogger < MetricLogger
 
     SUPPORTED_METRIC_TYPES = {
       counter: :increment_counter,
       distribution: :add_distribution_value,
       gauge: :set_gauge
-    }
+    }.freeze
     DEFAULT_METRIC_TYPE = :increment_counter
     DEFAULT_COUNTER = 1
 
-    attr_reader :allowed_tags
-
     def initialize(decoratee, allowed_tags: [])
       super(decoratee)
       @allowed_tags = allowed_tags.freeze
     end
 
-    LOG_TYPES.each do |log_type|
-      define_method log_type do |**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|
-            payload = metric_payload.transform_keys(&:to_sym)
-            metric_type = SUPPORTED_METRIC_TYPES[payload.fetch(:type).to_sym]
-            appsignal.public_send(metric_type, metric_name, payload.fetch(:value), tags) if metric_type
-          end
-        end
+    private
 
-        success_result
+      def send_metric(metric_type, metric_name, value, tags)
+        appsignal.public_send(metric_type, metric_name, value, tags)
       end
-    end
 
-    private
+      def build_tags(args)
+        args.slice(*allowed_tags)
+      end
 
       alias_method :appsignal, :decoratee
 
-      def valid_args?(metrics)
-        metrics && (metrics.is_a?(Hash) || metrics.is_a?(Array))
-      end
   end
 end

data/lib/event_tracer/buffer.rb

@@ -58,8 +58,15 @@ module EventTracer
       attr_reader :buffer_size, :flush_interval, :buffer
 
       def add_item?
-        buffer.size < buffer_size &&
-          (buffer.empty? || buffer.first[:created_at] > Time.now - flush_interval)
+        return false if buffer.size >= buffer_size
+
+        # NOTE: we cannot use buffer.empty? then buffer.first here
+        # due to race-condition when another thread flushes the buffer
+        # right after buffer.empty? but before buffer.first is called.
+        # If we have more complicated use case, we may need to start introducing
+        # mutext.
+        first_item = buffer.first
+        first_item.nil? || first_item[:created_at] > Time.now - flush_interval
       end
   end
 end

data/lib/event_tracer/datadog_logger.rb

@@ -1,4 +1,5 @@
-require_relative './basic_decorator'
+require_relative './metric_logger'
+
 # NOTES
 # Datadog interface to send our usual actions
 # BasicDecorator adds a transparent interface on top of the datadog interface
@@ -10,7 +11,7 @@ require_relative './basic_decorator'
 #        data_dog_logger.info metrics: { counter_1: { type: :counter, value: 1}, gauce_2: { type: :gauce, value: 10 } }
 
 module EventTracer
-  class DatadogLogger < BasicDecorator
+  class DatadogLogger < MetricLogger
 
     SUPPORTED_METRIC_TYPES = {
       counter: :count,
@@ -22,52 +23,22 @@ module EventTracer
     DEFAULT_METRIC_TYPE = :count
     DEFAULT_COUNTER = 1
 
-    attr_reader :allowed_tags
-
     def initialize(decoratee, allowed_tags: [], default_tags: {})
       super(decoratee)
       @allowed_tags = allowed_tags.freeze
       @default_tags = default_tags.freeze
     end
 
-    LOG_TYPES.each do |log_type|
-      define_method log_type do |**args|
-        metrics = args[:metrics]
-
-        return fail_result('Invalid Datadog config') unless valid_args?(metrics)
-        return success_result if metrics.empty?
-
-        tags = build_tags(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|
-            payload = metric_payload.transform_keys(&:to_sym)
-            metric_type = SUPPORTED_METRIC_TYPES[payload.fetch(:type).to_sym]
-            datadog.public_send(metric_type, metric_name, payload.fetch(:value), tags: tags) if metric_type
-          end
-        end
+    private
 
-        success_result
-      end
+    def send_metric(metric_type, metric_name, value, tags)
+      datadog.public_send(metric_type, metric_name, value, tags: tags)
     end
 
-    private
-
     alias_method :datadog, :decoratee
 
-    attr_reader :default_tags
-
-    def valid_args?(metrics)
-      metrics && (metrics.is_a?(Hash) || metrics.is_a?(Array))
-    end
-
     def build_tags(args)
-      @default_tags.merge(args.slice(*allowed_tags)).map do |tag, value|
+      default_tags.merge(args.slice(*allowed_tags)).map do |tag, value|
         "#{tag}:#{value}"
       end
     end

data/lib/event_tracer/metric_logger.rb

@@ -0,0 +1,42 @@
+require_relative './basic_decorator'
+
+module EventTracer
+  class MetricLogger < BasicDecorator
+
+    attr_reader :allowed_tags
+
+    LOG_TYPES.each do |log_type|
+      define_method log_type do |**args|
+        metrics = args[:metrics]
+
+        return fail_result("Invalid metrics for #{self.class.name}") unless valid_args?(metrics)
+        return success_result if metrics.empty?
+
+        tags = build_tags(args)
+
+        case metrics
+        when Array
+          metrics.each do |metric|
+            send_metric(self.class::DEFAULT_METRIC_TYPE, metric, self.class::DEFAULT_COUNTER, tags)
+          end
+        when Hash
+          metrics.each do |metric_name, metric_payload|
+            payload = metric_payload.transform_keys(&:to_sym)
+            metric_type = self.class::SUPPORTED_METRIC_TYPES[payload.fetch(:type).to_sym]
+            send_metric(metric_type, metric_name, payload.fetch(:value), tags) if metric_type
+          end
+        end
+
+        success_result
+      end
+    end
+
+    private
+
+    attr_reader :default_tags
+
+    def valid_args?(metrics)
+      metrics && (metrics.is_a?(Hash) || metrics.is_a?(Array))
+    end
+  end
+end

data/lib/event_tracer/prometheus_logger.rb

@@ -0,0 +1,64 @@
+require_relative './metric_logger'
+
+module EventTracer
+  class PrometheusLogger < MetricLogger
+
+    SUPPORTED_METRIC_TYPES = {
+      counter: :increment_count,
+      gauge: :set_gauge
+    }.freeze
+    DEFAULT_METRIC_TYPE = :increment_count
+    DEFAULT_COUNTER = 1
+
+    def initialize(prometheus, allowed_tags: [], default_tags: {}, raise_if_missing: true)
+      super(prometheus)
+      @allowed_tags = allowed_tags.freeze
+      @default_tags = default_tags.freeze
+      @raise_if_missing = raise_if_missing
+    end
+
+    private
+
+      def send_metric(metric_type, metric_name, value, labels)
+        send(metric_type, metric_name, value, labels: labels)
+      end
+
+      alias_method :prometheus, :decoratee
+
+      attr_reader :raise_if_missing
+
+      def increment_count(metric_name, value, labels:)
+        metric = get_metric(metric_name.to_sym, :counter)
+        metric.increment(by: value, labels: labels)
+      end
+
+      def set_gauge(metric_name, value, labels:)
+        metric = get_metric(metric_name.to_sym, :gauge)
+        metric.set(value, labels: labels)
+      end
+
+      def get_metric(metric_name, metric_type)
+        metric = prometheus.get(metric_name)
+
+        return metric if metric
+        raise "Metric #{metric_name} not registered" if raise_if_missing
+
+        prometheus.public_send(
+          metric_type,
+          metric_name,
+          docstring: "A #{metric_type} for #{metric_name}",
+          labels: labels_for_registration
+        )
+      end
+
+      def build_tags(args)
+        allowed_tags.inject(default_tags) do |metric_labels, tag|
+          metric_labels.merge(tag => args[tag])
+        end
+      end
+
+      def labels_for_registration
+        (allowed_tags + default_tags.keys).uniq
+      end
+  end
+end

data/lib/event_tracer/version.rb

@@ -1,3 +1,3 @@
 module EventTracer
-  VERSION = '0.5.1'.freeze
+  VERSION = '0.6.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: event_tracer
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.2
 platform: ruby
 authors:
 - melvrickgoh
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-18 00:00:00.000000000 Z
+date: 2022-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -102,6 +102,8 @@ files:
 - lib/event_tracer/dynamo_db/worker.rb
 - lib/event_tracer/error_with_payload.rb
 - lib/event_tracer/log_result.rb
+- lib/event_tracer/metric_logger.rb
+- lib/event_tracer/prometheus_logger.rb
 - lib/event_tracer/version.rb
 homepage: https://github.com/melvrickgoh/event_tracer
 licenses: