event_tracer 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f84ff22349c762a429e58f5913884a3eff066c983881ed16d9f846785c27184f
-  data.tar.gz: ccb8508e0eba3e08f2312248618d2fff80ff5bab70c08c5c9754b04ee000088e
+  metadata.gz: bc787e6f2e531d8525792eec4d55f3576f7b6543e356319fce7c065c436385d6
+  data.tar.gz: 22172cf85886ee0b668820d55bd13346997cd648b542337cc982c91510f01f50
 SHA512:
-  metadata.gz: 588eb7e39ca26221be2c15a986d5862a6f102713a8be329e245ae086c0503daa0c2e1d54d5996a008c1a6a93855f5f16b33eea551902438926fb1e29dcd29720
-  data.tar.gz: 43d3d079f656213b87f8666bca064dd83910282a4f7ffe3bb9dc1106f25ceea8c6b2e6dafbb8181c20c1377e515a6a37311cb495d4b9cab7c48016f2a79124ea
+  metadata.gz: d2afa747344e9e07aa85fa1d22a6612fca83df74e2bcfeb384b4f91e742e2d4a545c1070ceb9006592dff7bc97fefefe40ed4f326002f7f76119be24e9e26287
+  data.tar.gz: c176243abadde0675d267138476b2dbe9cbe20f78a3d49a479c96e9a086abb83ff4df859da65029aadb115d7d42a83fddf630de32ed797e7f7c8d930dec05fcf

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

@@ -18,15 +18,16 @@ module EventTracer
       gauge: :gauge,
       set: :set,
       histogram: :histogram
-    }
+    }.freeze
     DEFAULT_METRIC_TYPE = :count
     DEFAULT_COUNTER = 1
 
     attr_reader :allowed_tags
 
-    def initialize(decoratee, 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|
@@ -59,12 +60,14 @@ module EventTracer
 
     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)
-      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/prometheus_logger.rb

@@ -0,0 +1,97 @@
+module EventTracer
+  class PrometheusLogger < BasicDecorator
+
+    SUPPORTED_METRIC_TYPES = {
+      counter: :increment_count,
+      gauge: :set_gauge
+    }.freeze
+    DEFAULT_INCREMENT = 1
+
+    attr_reader :allowed_tags
+
+    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
+
+    LOG_TYPES.each do |log_type|
+      define_method log_type do |**args|
+        metrics = args[:metrics]
+
+        return fail_result('Invalid metrics for Prometheus') unless valid_args?(metrics)
+        return success_result if metrics.empty?
+
+        labels = build_metric_labels(args)
+
+        case metrics
+        when Array
+          metrics.each do |metric_name|
+            increment_count(metric_name, DEFAULT_INCREMENT, labels: labels)
+          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]
+
+            if metric_type
+              send(
+                metric_type,
+                metric_name,
+                payload.fetch(:value),
+                labels: labels
+              )
+            end
+          end
+        end
+
+        success_result
+      end
+    end
+
+    private
+
+      alias_method :prometheus, :decoratee
+
+      attr_reader :default_tags, :raise_if_missing
+
+      def valid_args?(metrics)
+        metrics && (metrics.is_a?(Hash) || metrics.is_a?(Array))
+      end
+
+      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_metric_labels(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.0'.freeze
+  VERSION = '0.6.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: event_tracer
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - melvrickgoh
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-26 00:00:00.000000000 Z
+date: 2022-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -102,6 +102,7 @@ files:
 - lib/event_tracer/dynamo_db/worker.rb
 - lib/event_tracer/error_with_payload.rb
 - lib/event_tracer/log_result.rb
+- lib/event_tracer/prometheus_logger.rb
 - lib/event_tracer/version.rb
 homepage: https://github.com/melvrickgoh/event_tracer
 licenses: