app_profiler 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daf174f3e936f7c9e466d16f75cc866f779944ae781e39501dae6d51cd74da42
-  data.tar.gz: 42871b642bf002450af142941793c41a1bfd76d6b6c6932b45e6cca9c287cb58
+  metadata.gz: 15a1a7b3bd1e60dc10753ce4b8e4f2907461b09417aecde43fce3d4565d5f211
+  data.tar.gz: 811e16e5383f85f4e2aef6aaf50e832b8cf5714c2cacd730ce4f184c9d1f26c4
 SHA512:
-  metadata.gz: cf696efe9cfe2582aafd201e30fe6f82aae17f1b137e93a7d2e2b2c34256f4ace88de0d771fc398844c1010999b5c9424f1b2ab0026395ee88b2ad440a88d54a
-  data.tar.gz: eb47ff8a3c0131065400a702d447fb8c170c9d2769860921be61d082ad6affe1ca714bbd211fd2cfe2aec78a89a57bbd32fc76d950d5fa1531feb5b43e29dac9
+  metadata.gz: 6b6cd68d552a8ac41eebef2cec56ac8e1917c1e321c759297649a62d6c03a3ce7c6ffa06bee820320f62ac4abdde8b8fa26f539508841ea9440d7231160534a8
+  data.tar.gz: c320d9e84ceca4834b7c5400dd46cef4ce3f04a7e49530b4381461f1ccb91b91da9cdc2e6eff86202b218efc1ef96754a5f8b40e7bbe433d73f2b3486ea86522

data/lib/app_profiler/middleware.rb

@@ -4,6 +4,7 @@ require "rack"
 require "app_profiler/middleware/base_action"
 require "app_profiler/middleware/upload_action"
 require "app_profiler/middleware/view_action"
+require "app_profiler/sampler/config"
 
 module AppProfiler
   class Middleware
@@ -24,11 +25,11 @@ module AppProfiler
 
     def profile(env, params)
       response = nil
+      app_profiler_params = profile_params(params)
 
-      return yield unless params.valid?
-
-      params_hash = params.to_h
+      return yield unless app_profiler_params
 
+      params_hash = app_profiler_params.to_h
       return yield unless before_profile(env, params_hash)
 
       profile = AppProfiler.run(**params_hash) do
@@ -40,13 +41,21 @@ module AppProfiler
       action.call(
         profile,
         response: response,
-        autoredirect: params.autoredirect,
-        async: params.async,
+        autoredirect: app_profiler_params.autoredirect,
+        async: app_profiler_params.async,
       )
 
       response
     end
 
+    def profile_params(params)
+      return params if params.valid?
+
+      return unless AppProfiler.profile_sampler_enabled
+
+      AppProfiler::Sampler.profile_params(params, AppProfiler.profile_sampler_config)
+    end
+
     def before_profile(_env, _params)
       true
     end

data/lib/app_profiler/parameters.rb

@@ -7,7 +7,7 @@ module AppProfiler
     DEFAULT_INTERVALS = { "cpu" => 1000, "wall" => 1000, "object" => 2000, "retained" => 0 }.freeze
     MIN_INTERVALS = { "cpu" => 200, "wall" => 200, "object" => 400, "retained" => 0 }.freeze
 
-    attr_reader :autoredirect, :async, :backend
+    attr_reader :mode, :autoredirect, :async, :backend
 
     def initialize(mode: :wall, interval: nil, ignore_gc: false, autoredirect: false,
       async: false, backend: nil, metadata: {})
@@ -31,6 +31,7 @@ module AppProfiler
         ignore_gc: @ignore_gc,
         metadata: @metadata,
         backend: @backend,
+        async: @async,
       }
     end
   end

data/lib/app_profiler/railtie.rb

@@ -42,6 +42,9 @@ module AppProfiler
       AppProfiler.after_process_queue = app.config.app_profiler.after_process_queue
       AppProfiler.backend = app.config.app_profiler.profiler_backend || :stackprof
       AppProfiler.forward_metadata_on_upload = app.config.app_profiler.forward_metadata_on_upload || false
+      AppProfiler.profile_sampler_enabled = app.config.app_profiler.profile_sampler_enabled || false
+      AppProfiler.profile_sampler_config = app.config.app_profiler.profile_sampler_config ||
+        AppProfiler::Sampler::Config.new
     end
 
     initializer "app_profiler.add_middleware" do |app|

data/lib/app_profiler/request_parameters.rb

@@ -8,6 +8,10 @@ module AppProfiler
       @request = request
     end
 
+    def path
+      @request.env["PATH_INFO"]
+    end
+
     def autoredirect
       query_param("autoredirect") || profile_header_param("autoredirect")
     end

data/lib/app_profiler/sampler/config.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "app_profiler/sampler/stackprof_config"
+require "app_profiler/sampler/vernier_config"
+module AppProfiler
+  module Sampler
+    class Config
+      attr_reader :sample_rate, :paths, :cpu_interval, :backends_probability
+
+      SAMPLE_RATE = 0.001 # 0.1%
+      PATHS = ["/"]
+      BACKEND_PROBABILITES = { stackprof: 1.0, vernier: 0.0 }
+      @backends = {}
+
+      def initialize(sample_rate: SAMPLE_RATE,
+        paths: PATHS,
+        backends_probability: BACKEND_PROBABILITES,
+        backends_config: {
+          stackprof: StackprofConfig.new,
+        })
+
+        if sample_rate < 0.0 || sample_rate > 1.0
+          raise ArgumentError, "sample_rate must be between 0 and 1"
+        end
+
+        raise ArgumentError, "mode probabilities must sum to 1" unless backends_probability.values.sum == 1.0
+
+        @sample_rate = sample_rate
+        @paths = paths
+        @backends_config = backends_config
+        @backends_probability = backends_probability
+      end
+
+      def get_backend_config(backend_name)
+        @backends_config[backend_name]
+      end
+    end
+  end
+end

data/lib/app_profiler/sampler/stackprof_config.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module AppProfiler
+  module Sampler
+    class StackprofConfig
+      attr_reader :modes_probability
+
+      # Default values
+      WALL_INTERVAL = 5000
+      CPU_INTERVAL = 5000
+      OBJECT_INTERVAL = 1000
+
+      WALL_MODE_PROBABILITY = 0.8
+      CPU_MODE_PROBABILITY = 0.1
+      OBJECT_MODE_PROBABILITY = 0.1
+
+      def initialize(
+        wall_interval: WALL_INTERVAL,
+        cpu_interval: CPU_INTERVAL,
+        object_interval: OBJECT_INTERVAL,
+        wall_mode_probability: WALL_MODE_PROBABILITY,
+        cpu_mode_probability: CPU_MODE_PROBABILITY,
+        object_mode_probability: OBJECT_MODE_PROBABILITY
+      )
+        if wall_mode_probability + cpu_mode_probability + object_mode_probability != 1.0
+          raise ArgumentError, "mode probabilities must sum to 1"
+        end
+
+        @modes_probability = {}
+        @modes_interval = {}
+
+        AppProfiler::Backend::StackprofBackend::AVAILABLE_MODES.each do |mode|
+          case mode
+          when :wall
+            @modes_probability[mode] = wall_mode_probability
+            @modes_interval[mode] = wall_interval
+          when :cpu
+            @modes_probability[mode] = cpu_mode_probability
+            @modes_interval[mode] = cpu_interval
+          when :object
+            @modes_probability[mode] = object_mode_probability
+            @modes_interval[mode] = object_interval
+          end
+        end
+      end
+
+      def interval_for(mode)
+        @modes_interval[mode]
+      end
+    end
+  end
+end

data/lib/app_profiler/sampler/vernier_config.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module AppProfiler
+  module Sampler
+    class VernierConfig
+      attr_reader :modes_probability
+
+      WALL_INTERVAL = 5000
+      RETAINED_INTERVAL = 5000
+
+      WALL_MODE_PROBABILITY = 1.0
+      RETAINED_MODE_PROBABILITY = 0.0
+
+      def initialize(
+        wall_interval: WALL_INTERVAL,
+        retained_interval: RETAINED_INTERVAL,
+        wall_mode_probability: WALL_MODE_PROBABILITY,
+        retained_mode_probability: RETAINED_MODE_PROBABILITY
+      )
+        if wall_mode_probability + retained_mode_probability != 1.0
+          raise ArgumentError, "mode probabilities must sum to 1"
+        end
+
+        @modes_probability = {}
+        @modes_interval = {}
+
+        AppProfiler::Backend::VernierBackend::AVAILABLE_MODES.each do |mode|
+          case mode
+          when :wall
+            @modes_probability[mode] = wall_mode_probability
+            @modes_interval[mode] = wall_interval
+          when :retained
+            @modes_probability[mode] = retained_mode_probability
+            @modes_interval[mode] = retained_interval
+          end
+        end
+      end
+
+      def interval_for(mode)
+        @modes_interval[mode]
+      end
+    end
+  end
+end

data/lib/app_profiler/sampler.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "app_profiler/sampler/config"
+module AppProfiler
+  module Sampler
+    class << self
+      def profile_params(request, config)
+        random = Kernel.rand
+        return unless sample?(random, config, request)
+
+        get_profile_params(config, random)
+      end
+
+      private
+
+      def sample?(random, config, request)
+        return false if random > config.sample_rate
+
+        path = request.path
+        return false unless config.paths.any? { |p| path.match?(p) }
+
+        true
+      end
+
+      def get_profile_params(config, random)
+        backend_name = select_random(config.backends_probability, random)
+        backend_config = config.get_backend_config(backend_name)
+
+        mode = select_random(backend_config.modes_probability, random)
+        interval = backend_config.interval_for(mode)
+
+        AppProfiler::Parameters.new(
+          backend: backend_name,
+          mode: mode,
+          async: true,
+          interval: interval,
+        )
+      end
+
+      # Given options with probabilities, select one based on range.
+      # For example, given options {a: 0.1, b: 0.2, c: 0.7} and random 0.5,
+      # it will return :c
+      # Assumes all probabilities sum to 1
+
+      def select_random(options, random)
+        current = 0
+        options = options.sort_by do |_, probability|
+          probability
+        end
+
+        options.each do |o, probabilty|
+          current += probabilty
+          if random <= current
+            return o
+          end
+        end
+      end
+    end
+  end
+end

data/lib/app_profiler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AppProfiler
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/app_profiler.rb

@@ -38,6 +38,7 @@ module AppProfiler
   require "app_profiler/profile"
   require "app_profiler/backend"
   require "app_profiler/server"
+  require "app_profiler/sampler"
 
   mattr_accessor :logger, default: Logger.new($stdout)
   mattr_accessor :root
@@ -62,6 +63,8 @@ module AppProfiler
   mattr_reader :profile_enqueue_failure, default: nil
   mattr_reader :after_process_queue, default: nil
   mattr_accessor :forward_metadata_on_upload, default: false
+  mattr_accessor :profile_sampler_enabled, default: false
+  mattr_accessor :profile_sampler_config
 
   class << self
     def run(*args, backend: nil, **kwargs, &block)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_profiler
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Gannon McGibbon
@@ -13,7 +13,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-01 00:00:00.000000000 Z
+date: 2024-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -149,6 +149,10 @@ files:
 - lib/app_profiler/profile/vernier.rb
 - lib/app_profiler/railtie.rb
 - lib/app_profiler/request_parameters.rb
+- lib/app_profiler/sampler.rb
+- lib/app_profiler/sampler/config.rb
+- lib/app_profiler/sampler/stackprof_config.rb
+- lib/app_profiler/sampler/vernier_config.rb
 - lib/app_profiler/server.rb
 - lib/app_profiler/storage/base_storage.rb
 - lib/app_profiler/storage/file_storage.rb
@@ -180,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: Collect performance profiles for your Rails application.