app_profiler 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c36371d12c24dfed23e6e492b5c3912e01480bfd7a5973bf1f311a86adc86d3
-  data.tar.gz: 1b78da495c55cee24ab6b0d6f8d8194ca6cfb27030de7a4ba90db37fa60e3988
+  metadata.gz: 15a1a7b3bd1e60dc10753ce4b8e4f2907461b09417aecde43fce3d4565d5f211
+  data.tar.gz: 811e16e5383f85f4e2aef6aaf50e832b8cf5714c2cacd730ce4f184c9d1f26c4
 SHA512:
-  metadata.gz: bd4e66293f491f25caba2a352b509012344bdc6e04c880cb4c3d60d00f3dc38cab50b9c59cf0cbe14c36adc2591610bd004addc28521cf077b7d3b7c91585947
-  data.tar.gz: 036c9de32a86b5e99e1d244fe1200aa3e0dabdf6d610d91c34aa6621bf8a194b9a769a8a9bae254432d2e2bfae67b137a1209c4214bb2c2ce774aa9db9bea907
+  metadata.gz: 6b6cd68d552a8ac41eebef2cec56ac8e1917c1e321c759297649a62d6c03a3ce7c6ffa06bee820320f62ac4abdde8b8fa26f539508841ea9440d7231160534a8
+  data.tar.gz: c320d9e84ceca4834b7c5400dd46cef4ce3f04a7e49530b4381461f1ccb91b91da9cdc2e6eff86202b218efc1ef96754a5f8b40e7bbe433d73f2b3486ea86522

data/lib/app_profiler/backend/base_backend.rb

@@ -3,10 +3,6 @@
 module AppProfiler
   module Backend
     class BaseBackend
-      def self.name
-        raise NotImplementedError
-      end
-
       def run(params = {}, &block)
         raise NotImplementedError
       end
@@ -31,6 +27,10 @@ module AppProfiler
         def run_lock
           @run_lock ||= Mutex.new
         end
+
+        def name
+          raise NotImplementedError
+        end
       end
 
       protected

data/lib/app_profiler/backend/stackprof_backend.rb

@@ -16,8 +16,10 @@ module AppProfiler
         :object,
       ].freeze
 
-      def self.name
-        :stackprof
+      class << self
+        def name
+          :stackprof
+        end
       end
 
       def run(params = {})
@@ -44,7 +46,7 @@ module AppProfiler
         StackProf.start(**DEFAULTS, **params)
       rescue => error
         AppProfiler.logger.info(
-          "[Profiler] failed to start the profiler error_class=#{error.class} error_message=#{error.message}"
+          "[Profiler] failed to start the profiler error_class=#{error.class} error_message=#{error.message}",
         )
         release_run_lock
         # This is a boolean instead of nil because StackProf#start returns a
@@ -66,7 +68,7 @@ module AppProfiler
         BaseProfile.from_stackprof(stackprof_profile)
       rescue => error
         AppProfiler.logger.info(
-          "[Profiler] failed to obtain the profile error_class=#{error.class} error_message=#{error.message}"
+          "[Profiler] failed to obtain the profile error_class=#{error.class} error_message=#{error.message}",
         )
         nil
       end

data/lib/app_profiler/backend/vernier_backend.rb

@@ -15,8 +15,10 @@ module AppProfiler
         :retained,
       ].freeze
 
-      def self.name
-        :vernier
+      class << self
+        def name
+          :vernier
+        end
       end
 
       def run(params = {})
@@ -48,7 +50,7 @@ module AppProfiler
         @collector.start
       rescue => error
         AppProfiler.logger.info(
-          "[Profiler] failed to start the profiler error_class=#{error.class} error_message=#{error.message}"
+          "[Profiler] failed to start the profiler error_class=#{error.class} error_message=#{error.message}",
         )
         release_run_lock
         # This is a boolean instead of nil to be consistent with the stackprof backend behaviour
@@ -83,7 +85,7 @@ module AppProfiler
         BaseProfile.from_vernier(data)
       rescue => error
         AppProfiler.logger.info(
-          "[Profiler] failed to obtain the profile error_class=#{error.class} error_message=#{error.message}"
+          "[Profiler] failed to obtain the profile error_class=#{error.class} error_message=#{error.message}",
         )
         nil
       end

data/lib/app_profiler/middleware/upload_action.rb

@@ -14,7 +14,7 @@ module AppProfiler
             append_headers(
               response,
               upload: profile_upload,
-              autoredirect: autoredirect.nil? ? AppProfiler.autoredirect : autoredirect
+              autoredirect: autoredirect.nil? ? AppProfiler.autoredirect : autoredirect,
             ) if response
           end
         end

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/profile.rb

@@ -15,20 +15,22 @@ module AppProfiler
 
     delegate :[], to: :@data
 
-    # This function should not be called if `StackProf.results` returns nil.
-    def self.from_stackprof(data)
-      options = INTERNAL_METADATA_KEYS.map { |key| [key, data[:metadata]&.delete(key)] }.to_h
+    class << self
+      # This function should not be called if `StackProf.results` returns nil.
+      def from_stackprof(data)
+        options = INTERNAL_METADATA_KEYS.map { |key| [key, data[:metadata]&.delete(key)] }.to_h
 
-      StackprofProfile.new(data, **options).tap do |profile|
-        raise ArgumentError, "invalid profile data" unless profile.valid?
+        StackprofProfile.new(data, **options).tap do |profile|
+          raise ArgumentError, "invalid profile data" unless profile.valid?
+        end
       end
-    end
 
-    def self.from_vernier(data)
-      options = INTERNAL_METADATA_KEYS.map { |key| [key, data[:meta]&.delete(key)] }.to_h
+      def from_vernier(data)
+        options = INTERNAL_METADATA_KEYS.map { |key| [key, data[:meta]&.delete(key)] }.to_h
 
-      VernierProfile.new(data, **options).tap do |profile|
-        raise ArgumentError, "invalid profile data" unless profile.valid?
+        VernierProfile.new(data, **options).tap do |profile|
+          raise ArgumentError, "invalid profile data" unless profile.valid?
+        end
       end
     end
 
@@ -44,7 +46,7 @@ module AppProfiler
       AppProfiler.storage.upload(self).tap do |upload|
         if upload && defined?(upload.url)
           AppProfiler.logger.info(
-            <<~INFO.squish
+            <<~INFO.squish,
               [Profiler] data uploaded:
               profile_url=#{upload.url}
               profile_viewer_url=#{AppProfiler.profile_url(upload)}
@@ -54,7 +56,7 @@ module AppProfiler
       end
     rescue => error
       AppProfiler.logger.info(
-        "[Profiler] failed to upload profile error_class=#{error.class} error_message=#{error.message}"
+        "[Profiler] failed to upload profile error_class=#{error.class} error_message=#{error.message}",
       )
       nil
     end
@@ -78,6 +80,10 @@ module AppProfiler
       @data
     end
 
+    def metadata
+      @data[:metadata]
+    end
+
     def mode
       raise NotImplementedError
     end

data/lib/app_profiler/railtie.rb

@@ -41,6 +41,10 @@ module AppProfiler
       AppProfiler.profile_enqueue_failure = app.config.app_profiler.profile_enqueue_failure
       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/server.rb

@@ -280,7 +280,7 @@ module AppProfiler
         @listen_thread = nil
 
         @logger.info(
-          "[AppProfiler::Server] listening on addr=#{@transport.socket.addr}"
+          "[AppProfiler::Server] listening on addr=#{@transport.socket.addr}",
         )
         @pid = Process.pid
       end
@@ -342,7 +342,7 @@ module AppProfiler
                 end
               rescue => e
                 @logger.error(
-                  "[AppProfiler::Server] exception #{e} responding to request #{request}: #{e.message}"
+                  "[AppProfiler::Server] exception #{e} responding to request #{request}: #{e.message}",
                 )
               ensure
                 session.close

data/lib/app_profiler/storage/base_storage.rb

@@ -6,12 +6,14 @@ module AppProfiler
       class_attribute :bucket_name, default: "profiles"
       class_attribute :credentials, default: {}
 
-      def self.upload(_profile)
-        raise NotImplementedError
-      end
+      class << self
+        def upload(_profile)
+          raise NotImplementedError
+        end
 
-      def self.enqueue_upload(_profile)
-        raise NotImplementedError
+        def enqueue_upload(_profile)
+          raise NotImplementedError
+        end
       end
     end
   end

data/lib/app_profiler/storage/google_cloud_storage.rb

@@ -15,6 +15,10 @@ module AppProfiler
         def upload(profile, _params = {})
           file = profile.file.open
 
+          metadata = if AppProfiler.forward_metadata_on_upload && profile.metadata.present?
+            profile.metadata
+          end
+
           ActiveSupport::Notifications.instrument(
             "gcs_upload.app_profiler",
             file_size: file.size,
@@ -24,6 +28,7 @@ module AppProfiler
               gcs_filename(profile),
               content_type: "application/json",
               content_encoding: "gzip",
+              metadata: metadata,
             )
           ensure
             profile.file.unlink

data/lib/app_profiler/version.rb

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

data/lib/app_profiler/viewer/speedscope_remote_viewer/base_middleware.rb

@@ -9,17 +9,57 @@ module AppProfiler
       class BaseMiddleware
         class Sanitizer < Rails::HTML::Sanitizer.best_supported_vendor.safe_list_sanitizer
           self.allowed_tags = Set.new([
-            "strong", "em", "b", "i", "p", "code", "pre", "tt", "samp", "kbd", "var", "sub",
-            "sup", "dfn", "cite", "big", "small", "address", "hr", "br", "div", "span", "h1",
-            "h2", "h3", "h4", "h5", "h6", "ul", "ol", "li", "dl", "dt", "dd", "abbr", "acronym",
-            "a", "img", "blockquote", "del", "ins", "script",
+            "strong",
+            "em",
+            "b",
+            "i",
+            "p",
+            "code",
+            "pre",
+            "tt",
+            "samp",
+            "kbd",
+            "var",
+            "sub",
+            "sup",
+            "dfn",
+            "cite",
+            "big",
+            "small",
+            "address",
+            "hr",
+            "br",
+            "div",
+            "span",
+            "h1",
+            "h2",
+            "h3",
+            "h4",
+            "h5",
+            "h6",
+            "ul",
+            "ol",
+            "li",
+            "dl",
+            "dt",
+            "dd",
+            "abbr",
+            "acronym",
+            "a",
+            "img",
+            "blockquote",
+            "del",
+            "ins",
+            "script",
           ])
         end
 
         private_constant(:Sanitizer)
 
-        def self.id(file)
-          file.basename.to_s.delete_suffix(".json")
+        class << self
+          def id(file)
+            file.basename.to_s.delete_suffix(".json")
+          end
         end
 
         def initialize(app)
@@ -87,7 +127,7 @@ module AppProfiler
                   </p>
                 HTML
               end
-            end
+            end,
           )
         end
 

data/lib/app_profiler/viewer/speedscope_remote_viewer/middleware.rb

@@ -12,7 +12,7 @@ module AppProfiler
         def initialize(app)
           super
           @speedscope = Rack::File.new(
-            File.join(AppProfiler.root, "node_modules/speedscope/dist/release")
+            File.join(AppProfiler.root, "node_modules/speedscope/dist/release"),
           )
         end
 
@@ -33,7 +33,7 @@ module AppProfiler
           end || raise(ArgumentError)
 
           render(
-            <<~HTML
+            <<~HTML,
               <script type="text/javascript">
                 var graph = #{profile.read};
                 var json = JSON.stringify(graph);

data/lib/app_profiler/yarn/command.rb

@@ -49,7 +49,7 @@ module AppProfiler
         exec("which", "yarn", silent: true) do
           raise(
             YarnError,
-            <<~MSG.squish
+            <<~MSG.squish,
               `yarn` command not found.
               Please install `yarn` or make it available in PATH.
             MSG

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
@@ -61,6 +62,9 @@ module AppProfiler
   mattr_reader :profile_enqueue_success, default: nil
   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)
@@ -70,7 +74,7 @@ module AppProfiler
         profiler.run(*args, **kwargs, &block)
       rescue BackendError => e
         logger.error(
-          "[AppProfiler.run] exception #{e} configuring backend #{backend}: #{e.message}"
+          "[AppProfiler.run] exception #{e} configuring backend #{backend}: #{e.message}",
         )
         yield
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_profiler
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Gannon McGibbon
@@ -10,10 +10,10 @@ authors:
 - Jon Simpson
 - Kevin Jalbert
 - Scott Francis
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-18 00:00:00.000000000 Z
+date: 2024-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -127,7 +127,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - gems@shopify.com
 executables: []
@@ -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
@@ -165,7 +169,7 @@ homepage: https://github.com/Shopify/app_profiler
 licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -180,8 +184,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key: 
+rubygems_version: 3.5.17
+signing_key:
 specification_version: 4
 summary: Collect performance profiles for your Rails application.
 test_files: []