app_profiler 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69d1e8d957672c105e954b64a547955e4e1c499d3d70b529e1de1b56b2fb7d51
-  data.tar.gz: d7f022da1ebf4ead06ebadae4ded97260276afb12cb885866d76f53e520171c8
+  metadata.gz: 11304574ae151e5775c7cbac93ace38b9784c25bec088b39b4288eae719a0d1e
+  data.tar.gz: d0a698c95c617c4a337c9e31953b374f5f3a9d6126df942674928491c81e97c5
 SHA512:
-  metadata.gz: 831da45ae0c02c629fc0e1788a6b1a220872b4c449291d72df9adbfdbfada6bf0ab815fe41e5034ad5376176b6235cfcbb83d00e4688a1ba4150faedb5ed5820
-  data.tar.gz: 0177d93977123800440539da265fac443023d8f654f74d64ccd7c4f9a74ed2750c83c2472a7e8285b065a79589fb6024280b4767ee6df148722d34339396cb72
+  metadata.gz: b511cd5273c64b1f58597e6a12e668b78e2d5037e63626e4cb34927b3814fb0fb7962fee01973a6be71d928f04596a71525fac3c62bbaadabea6b49121dbae5c
+  data.tar.gz: 507918c0fcb2d4e2321b5401bdd243a3a74fdc256576bdd4be0eddf7441a73bbed4738a9a880d6e507918db0d2a6d9c05bc10adb67a3b6741b7e22fdf16e67e2

data/lib/app_profiler/middleware/upload_action.rb

@@ -4,16 +4,19 @@ module AppProfiler
   class Middleware
     class UploadAction < BaseAction
       class << self
-        def call(profile, response: nil, autoredirect: nil)
-          profile_upload = profile.upload
-
-          return unless response
-
-          append_headers(
-            response,
-            upload: profile_upload,
-            autoredirect: autoredirect.nil? ? AppProfiler.autoredirect : autoredirect
-          )
+        def call(profile, response: nil, autoredirect: nil, async: false)
+          if async
+            profile.enqueue_upload
+            response[1][AppProfiler.profile_async_header] = true
+          else
+            profile_upload = profile.upload
+
+            append_headers(
+              response,
+              upload: profile_upload,
+              autoredirect: autoredirect.nil? ? AppProfiler.autoredirect : autoredirect
+            ) if response
+          end
         end
 
         private

data/lib/app_profiler/middleware.rb

@@ -14,16 +14,15 @@ module AppProfiler
       @app = app
     end
 
-    def call(env)
-      profile(env) do
+    def call(env, params = AppProfiler::RequestParameters.new(Rack::Request.new(env)))
+      profile(env, params) do
         @app.call(env)
       end
     end
 
     private
 
-    def profile(env)
-      params   = AppProfiler::RequestParameters.new(Rack::Request.new(env))
+    def profile(env, params)
       response = nil
 
       return yield unless params.valid?
@@ -42,6 +41,7 @@ module AppProfiler
         profile,
         response: response,
         autoredirect: params.autoredirect,
+        async: params.async
       )
 
       response

data/lib/app_profiler/parameters.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "rack"
+
+module AppProfiler
+  class Parameters
+    DEFAULT_INTERVALS = { "cpu" => 1000, "wall" => 1000, "object" => 2000 }.freeze
+    MIN_INTERVALS = { "cpu" => 200, "wall" => 200, "object" => 400 }.freeze
+    MODES = DEFAULT_INTERVALS.keys.freeze
+
+    attr_reader :autoredirect, :async
+
+    def initialize(mode: :wall, interval: nil, ignore_gc: false, autoredirect: false, async: false, metadata: {})
+      @mode = mode.to_sym
+      @interval = [interval&.to_i || DEFAULT_INTERVALS.fetch(@mode.to_s), MIN_INTERVALS.fetch(@mode.to_s)].max
+      @ignore_gc = !!ignore_gc
+      @autoredirect = autoredirect
+      @metadata = { context: AppProfiler.context }.merge(metadata)
+      @async = async
+    end
+
+    def valid?
+      true
+    end
+
+    def to_h
+      {
+        mode: @mode,
+        interval: @interval,
+        ignore_gc: @ignore_gc,
+        metadata: @metadata,
+      }
+    end
+  end
+end

data/lib/app_profiler/profile.rb

@@ -56,6 +56,10 @@ module AppProfiler
       nil
     end
 
+    def enqueue_upload
+      AppProfiler.storage.enqueue_upload(self)
+    end
+
     def file
       @file ||= path.tap do |p|
         p.dirname.mkpath

data/lib/app_profiler/railtie.rb

@@ -28,11 +28,14 @@ module AppProfiler
         "APP_PROFILER_SPEEDSCOPE_URL", "https://speedscope.app"
       )
       AppProfiler.profile_header = app.config.app_profiler.profile_header || "X-Profile"
+      AppProfiler.profile_async_header = app.config.app_profiler.profile_async_header || "X-Profile-Async"
       AppProfiler.profile_root = app.config.app_profiler.profile_root || Rails.root.join(
         "tmp", "app_profiler"
       )
       AppProfiler.context = app.config.app_profiler.context || Rails.env
       AppProfiler.profile_url_formatter = app.config.app_profiler.profile_url_formatter
+      AppProfiler.upload_queue_max_length = app.config.app_profiler.upload_queue_max_length || 10
+      AppProfiler.upload_queue_interval_secs = app.config.app_profiler.upload_queue_interval_secs || 5
     end
 
     initializer "app_profiler.add_middleware" do |app|

data/lib/app_profiler/request_parameters.rb

@@ -4,10 +4,6 @@ require "rack"
 
 module AppProfiler
   class RequestParameters
-    DEFAULT_INTERVALS = { "cpu" => 1000, "wall" => 1000, "object" => 2000 }.freeze
-    MIN_INTERVALS = { "cpu" => 200, "wall" => 200, "object" => 400 }.freeze
-    MODES = DEFAULT_INTERVALS.keys.freeze
-
     def initialize(request)
       @request = request
     end
@@ -16,17 +12,21 @@ module AppProfiler
       query_param("autoredirect") || profile_header_param("autoredirect")
     end
 
+    def async
+      query_param("async")
+    end
+
     def valid?
       if mode.blank?
         return false
       end
 
-      unless MODES.include?(mode)
+      unless Parameters::MODES.include?(mode)
         AppProfiler.logger.info("[Profiler] unsupported profiling mode=#{mode}")
         return false
       end
 
-      if interval.to_i < MIN_INTERVALS[mode]
+      if interval.to_i < Parameters::MIN_INTERVALS[mode]
         return false
       end
 
@@ -56,7 +56,7 @@ module AppProfiler
     end
 
     def interval
-      query_param("interval") || profile_header_param("interval") || DEFAULT_INTERVALS[mode]
+      query_param("interval") || profile_header_param("interval") || Parameters::DEFAULT_INTERVALS[mode]
     end
 
     def request_id

data/lib/app_profiler/server.rb

@@ -180,6 +180,14 @@ module AppProfiler
       class Transport
         attr_reader :socket
 
+        def initialize
+          start
+        end
+
+        def start
+          raise(NotImplementedError)
+        end
+
         def client
           raise(NotImplementedError)
         end
@@ -190,13 +198,26 @@ module AppProfiler
       end
 
       class UNIX < Transport
-        def initialize
-          super
+        class << self
+          def unlink_socket(path, pid)
+            ->(_) do
+              if Process.pid == pid && File.exist?(path)
+                begin
+                  File.unlink(path)
+                rescue SystemCallError
+                  # Let not raise in a finalizer
+                end
+              end
+            end
+          end
+        end
 
+        def start
           FileUtils.mkdir_p(PROFILER_TEMPFILE_PATH)
           @socket_file = File.join(PROFILER_TEMPFILE_PATH, "app-profiler-#{Process.pid}.sock")
           File.unlink(@socket_file) if File.exist?(@socket_file) && File.socket?(@socket_file)
           @socket = UNIXServer.new(@socket_file)
+          ObjectSpace.define_finalizer(self, self.class.unlink_socket(@socket_file, Process.pid))
         end
 
         def client
@@ -207,15 +228,23 @@ module AppProfiler
           File.unlink(@socket_file) if File.exist?(@socket_file) && File.socket?(@socket_file)
           @socket.close
         end
+
+        def abandon
+          @socket.close
+        end
       end
 
       class TCP < Transport
         SERVER_ADDRESS = "127.0.0.1" # it is ONLY safe to run this bound to localhost
 
         def initialize(port = 0)
+          @port_argument = port
           super()
+        end
+
+        def start
           FileUtils.mkdir_p(PROFILER_TEMPFILE_PATH)
-          @socket = TCPServer.new(SERVER_ADDRESS, port)
+          @socket = TCPServer.new(SERVER_ADDRESS, @port_argument)
           @port = @socket.addr[1]
           @port_file = Tempfile.new("profileserver-#{Process.pid}-port-#{@port}-", PROFILER_TEMPFILE_PATH)
         end
@@ -228,6 +257,11 @@ module AppProfiler
           @port_file.unlink
           @socket.close
         end
+
+        def abandon
+          @port_file.close # NB: Tempfile finalizer checks Process.pid to avoid unlinking inherited IOs.
+          @socket.close
+        end
       end
 
       def initialize(transport, logger)
@@ -247,13 +281,16 @@ module AppProfiler
           "[AppProfiler::Server] listening on addr=#{@transport.socket.addr}"
         )
         @pid = Process.pid
-        at_exit { stop }
       end
 
       def client
         @transport.client
       end
 
+      def join(...)
+        @listen_thread.join(...)
+      end
+
       def serve
         return unless @listen_thread.nil?
 
@@ -261,7 +298,15 @@ module AppProfiler
 
         @listen_thread = Thread.new do
           loop do
-            Thread.new(@transport.socket.accept) do |session|
+            session = begin
+              @transport.socket.accept
+            rescue
+              @transport.close
+              @transport.start
+              next
+            end
+
+            Thread.new(session) do |session|
               request = session.gets
 
               if request.nil?
@@ -306,18 +351,23 @@ module AppProfiler
       end
 
       def stop
-        return unless @pid == Process.pid
-
         @listen_thread.kill
-        @transport.stop
+        if @pid == Process.pid
+          @transport.stop
+        else
+          @transport.abandon
+        end
       end
     end
 
     private_constant :ProfileApplication, :ProfileServer
 
+    @pid = Process.pid
+    @profile_server = nil
+
     class << self
       def reset
-        profile_servers.clear
+        self.profile_server = nil
 
         DEFAULTS.each do |config, value|
           class_variable_set(:"@@#{config}", value) # rubocop:disable Style/ClassVars
@@ -327,7 +377,7 @@ module AppProfiler
       def start(logger = Logger.new(IO::NULL))
         return if profile_server
 
-        profile_servers[Process.pid] = ProfileServer.new(AppProfiler::Server.transport, logger)
+        self.profile_server = ProfileServer.new(AppProfiler::Server.transport, logger)
         profile_server.serve
         profile_server
       end
@@ -341,20 +391,25 @@ module AppProfiler
       def stop
         return unless profile_server
 
-        profile_server.stop
-        profile_servers.delete(Process.pid)
+        server = profile_server
+        server.stop
+        self.profile_server = nil
+        server
       end
 
       private
 
       def profile_server
-        profile_servers[Process.pid]
+        if @pid != Process.pid
+          @profile_server&.stop
+          @profile_server = nil
+        end
+        @profile_server
       end
 
-      # It is possible there will be a server pre-fork, this is to distinguish
-      # the child server from its parent via PID
-      def profile_servers
-        @profile_servers ||= {}
+      def profile_server=(server)
+        @pid = Process.pid
+        @profile_server = server
       end
     end
   end

data/lib/app_profiler/storage/base_storage.rb

@@ -9,6 +9,10 @@ module AppProfiler
       def self.upload(_profile)
         raise NotImplementedError
       end
+
+      def self.enqueue_upload(_profile)
+        raise NotImplementedError
+      end
     end
   end
 end

data/lib/app_profiler/storage/file_storage.rb

@@ -21,6 +21,10 @@ module AppProfiler
         def upload(profile)
           Location.new(profile.file)
         end
+
+        def enqueue_upload(profile)
+          upload(profile)
+        end
       end
     end
   end

data/lib/app_profiler/storage/google_cloud_storage.rb

@@ -28,8 +28,59 @@ module AppProfiler
           end
         end
 
+        def enqueue_upload(profile)
+          mutex.synchronize do
+            process_queue_thread unless @process_queue_thread&.alive?
+
+            @queue ||= init_queue
+            begin
+              @queue.push(profile, true) # non-blocking push, raises ThreadError if queue is full
+            rescue ThreadError
+              AppProfiler.logger.info("[AppProfiler] upload queue is full, profile discarded")
+            end
+          end
+        end
+
+        def reset_queue # for testing
+          init_queue
+          @process_queue_thread&.kill
+          @process_queue_thread = nil
+        end
+
         private
 
+        def mutex
+          @mutex ||= Mutex.new
+        end
+
+        def init_queue
+          @queue = SizedQueue.new(AppProfiler.upload_queue_max_length)
+        end
+
+        def process_queue_thread
+          @process_queue_thread ||= Thread.new do
+            loop do
+              process_queue
+              sleep(AppProfiler.upload_queue_interval_secs)
+            end
+          end
+          @process_queue_thread.priority = -1 # low priority
+        end
+
+        def process_queue
+          queue = nil
+          mutex.synchronize do
+            break if @queue.nil? || @queue.empty?
+
+            queue = @queue
+            init_queue
+          end
+
+          return unless queue
+
+          queue.size.times { queue.pop(false).upload }
+        end
+
         def gcs_filename(profile)
           File.join(profile.context.to_s, profile.file.basename)
         end

data/lib/app_profiler/version.rb

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

data/lib/app_profiler.rb

@@ -26,6 +26,7 @@ module AppProfiler
   end
 
   require "app_profiler/middleware"
+  require "app_profiler/parameters"
   require "app_profiler/request_parameters"
   require "app_profiler/profiler"
   require "app_profiler/profile"
@@ -38,6 +39,7 @@ module AppProfiler
   mattr_accessor :speedscope_host, default: "https://speedscope.app"
   mattr_accessor :autoredirect, default: false
   mattr_reader   :profile_header, default: "X-Profile"
+  mattr_accessor :profile_async_header, default: "X-Profile-Async"
   mattr_accessor :context, default: nil
   mattr_reader   :profile_url_formatter,
     default: DefaultProfileFormatter
@@ -46,6 +48,8 @@ module AppProfiler
   mattr_accessor :viewer, default: Viewer::SpeedscopeViewer
   mattr_accessor :middleware, default: Middleware
   mattr_accessor :server, default: Server
+  mattr_accessor :upload_queue_max_length, default: 10
+  mattr_accessor :upload_queue_interval_secs, default: 5
 
   class << self
     def run(*args, &block)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_profiler
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Gannon McGibbon
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-23 00:00:00.000000000 Z
+date: 2023-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -139,6 +139,7 @@ files:
 - lib/app_profiler/middleware/base_action.rb
 - lib/app_profiler/middleware/upload_action.rb
 - lib/app_profiler/middleware/view_action.rb
+- lib/app_profiler/parameters.rb
 - lib/app_profiler/profile.rb
 - lib/app_profiler/profiler.rb
 - lib/app_profiler/railtie.rb
@@ -174,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Collect performance profiles for your Rails application.