config and apis

sentry-ruby/lib/sentry-ruby.rb

@@ -23,6 +23,7 @@
 require "sentry/session_flusher"
 require "sentry/backpressure_monitor"
 require "sentry/cron/monitor_check_ins"
+require "sentry/metrics"
 
 [
   "sentry/rake",
@@ -77,6 +78,10 @@ def exception_locals_tp
     #   @return [BackpressureMonitor, nil]
     attr_reader :backpressure_monitor
 
+    # @!attribute [r] metrics_aggregator
+    #   @return [Metrics::Aggregator, nil]
+    attr_reader :metrics_aggregator
+
     ##### Patch Registration #####
 
     # @!visibility private
@@ -224,6 +229,7 @@ def init(&block)
       @background_worker = Sentry::BackgroundWorker.new(config)
       @session_flusher = config.session_tracking? ? Sentry::SessionFlusher.new(config, client) : nil
       @backpressure_monitor = config.enable_backpressure_handling ? Sentry::BackpressureMonitor.new(config, client) : nil
+      @metrics_aggregator = config.enable_metrics ? Sentry::Metrics::Aggregator.new(config, client) : nil
       exception_locals_tp.enable if config.include_local_variables
       at_exit { close }
     end
@@ -244,6 +250,13 @@ def close
         @backpressure_monitor = nil
       end
 
+      if @metrics_aggregator
+        # TODO-neel-metrics force flush?
+        @metrics_aggregator.flush(force: true)
+        @metrics_aggregator.kill
+        @metrics_aggregator = nil
+      end
+
       if client = get_current_client
         client.transport.flush
 

sentry-ruby/lib/sentry/configuration.rb

@@ -254,6 +254,12 @@ def capture_exception_frame_locals=(value)
     # @return [Boolean, nil]
     attr_reader :enable_tracing
 
+    # Enable metrics usage
+    # Starts a new {Sentry::Metrics::Aggregator} instance to aggregate metrics
+    # and a thread to aggregate flush every 5 seconds.
+    # @return [Boolean]
+    attr_accessor :enable_metrics
+
     # Send diagnostic client reports about dropped events, true by default
     # tries to attach to an existing envelope max once every 30s
     # @return [Boolean]
@@ -383,6 +389,7 @@ def initialize
       self.rack_env_whitelist = RACK_ENV_WHITELIST_DEFAULT
       self.traces_sampler = nil
       self.enable_tracing = nil
+      self.enable_metrics = false
 
       @transport = Transport::Configuration.new
       @cron = Cron::Configuration.new

sentry-ruby/lib/sentry/metrics.rb

@@ -5,12 +5,27 @@
 require 'sentry/metrics/distribution_metric'
 require 'sentry/metrics/gauge_metric'
 require 'sentry/metrics/set_metric'
+require 'sentry/metrics/aggregator'
 
 module Sentry
   module Metrics
     class << self
       # TODO-neel-metrics define units, maybe symbols
-      def incr(key, value: 1.0, unit: 'none', tags: nil, timestamp: nil)
+
+      def incr(key, value = 1.0, unit = 'none', tags: {}, timestamp: nil)
+        Sentry.metrics_aggregator&.add(:c, key, value, unit, tags: tags, timestamp: timestamp)
+      end
+
+      def distribution(key, value, unit = 'none', tags: {}, timestamp: nil)
+        Sentry.metrics_aggregator&.add(:d, key, value, unit, tags: tags, timestamp: timestamp)
+      end
+
+      def set(key, value, unit = 'none', tags: {}, timestamp: nil)
+        Sentry.metrics_aggregator&.add(:s, key, value, unit, tags: tags, timestamp: timestamp)
+      end
+
+      def gauge(key, value, unit = 'none', tags: {}, timestamp: nil)
+        Sentry.metrics_aggregator&.add(:g, key, value, unit, tags: tags, timestamp: timestamp)
       end
     end
   end

sentry-ruby/lib/sentry/metrics/aggregator.rb

@@ -18,8 +18,7 @@ class Aggregator
       def initialize(configuration, client)
         @client = client
         @logger = configuration.logger
-        @release = configuration.release
-        @environment = configuration.environment
+        @default_tags = { 'release' => configuration.release, 'environment' => configuration.environment }
 
         @thread = nil
         @exited = false
@@ -36,7 +35,7 @@ def add(type,
               key,
               value,
               unit,
-              tags: nil,
+              tags: {},
               timestamp: nil)
         return unless ensure_thread
 
@@ -47,7 +46,7 @@ def add(type,
         # and buckets into 10 second intervals
         bucket_timestamp = (timestamp / ROLLUP_IN_SECONDS) * ROLLUP_IN_SECONDS
 
-        serialized_tags = serialize_tags(tags)
+        serialized_tags = serialize_tags(tags.merge(@default_tags))
         bucket_key = [type, key, unit, serialized_tags]
 
         @mutex.synchronize do
@@ -61,7 +60,7 @@ def add(type,
         end
       end
 
-      def flush
+      def flush(force: false)
         @mutex.synchronize do
           log_debug("[Metrics::Aggregator] current bucket state: #{@buckets}")
           # TODO
@@ -96,17 +95,15 @@ def ensure_thread
         false
       end
 
+      # important to sort for key consistency
       def serialize_tags(tags)
-        return [] unless tags
-
-        # important to sort for key consistency
-        tags.map do |k, v|
+        tags.flat_map do |k, v|
           if v.is_a?(Array)
             v.map { |x| [k.to_s, x.to_s] }
           else
-            [k.to_s, v.to_s]
+            [[k.to_s, v.to_s]]
           end
-        end.flatten.sort
+        end.sort
       end
     end
   end