dial 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c57fbfd8d0f023bcfd0606a5d61cfe84dd7b93d618dd844d50332b576dcce3d5
-  data.tar.gz: 27db795cf357bd7c878ea939c9c66374cc50f54e304466f91b9add37e0535a95
+  metadata.gz: dc0b70ff1d770bd0fc85123280a07bb683d649a059df325b2b9cad938ea346e2
+  data.tar.gz: ef4ab7cdb79f4e773b9d19d35d40624085a1ea15b47798fc9a092c476e4d5f25
 SHA512:
-  metadata.gz: ea4ba198fd052cdfed3a35d95a5424f6da32c94da85dec1cad9d78edd6b92e336d35afa76704349c5ef0475ac8a60f9ba90026b753109f4a0cea8caba994d3c4
-  data.tar.gz: 4d1578a97dd8439a4e6060698d24a0605f9747fd471d47844dd5f981f257790a00ecd4a5ed097377ef3af6d61062dd0b76d6023f5fd5dca0990a8f2642421c5a
+  metadata.gz: 5fd19ba186d0689ad63827557f944c0fcee39c41c0d77053450d1a81ff52bb74442f26e7eb4bb377efacea763f87903d467c858834da56483a3d4ddf01307acc
+  data.tar.gz: 45ccf2409afdc88cca32063aa3583737f00eaffea57f10701a9d6d2c45d066586c85e52eea2387ee9cacb2bc0712feca2159c16e711c52c1c8e2c4f8e34ef162

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [0.4.0] - 2025-08-30
+
+- Add sampling configuration to control percentage of requests profiled
+- Replace response body buffering with streaming response wrapper
+- Make prosopite logging thread-safe with thread-local storage
+- Fix missing namespace for VERNIER_PROFILE_OUT_FILE_EXTENSION in engine routes
+- Improve error handling and input validation
+
+## [0.3.2] - 2025-05-14
+
+- Consolidate railtie initializers
+
 ## [0.3.1] - 2025-05-03
 
 - Only show truncated summary + one full query in N+1 logs

data/README.md

@@ -43,6 +43,7 @@ mount Dial::Engine, at: "/" if Rails.env.development?
 # config/initializers/dial.rb
 
 Dial.configure do |config|
+  config.sampling_percentage = 50
   config.vernier_interval = 100
   config.vernier_allocation_interval = 10_000
   config.prosopite_ignore_queries += [/pg_sleep/i]
@@ -53,10 +54,11 @@ end
 
 Option | Description | Default
 :- | :- | :-
+`sampling_percentage` | Percentage of requests to profile. | `100` in development, `1` in production
+`content_security_policy_nonce` | Sets the content security policy nonce to use when inserting Dial's script. Can be a string, or a Proc which receives `env` and response `headers` as arguments and returns the nonce string. | Rails generated nonce or `nil`
 `vernier_interval` | Sets the `interval` option for vernier. | `200`
 `vernier_allocation_interval` | Sets the `allocation_interval` option for vernier. | `2_000`
 `prosopite_ignore_queries` | Sets the `ignore_queries` option for prosopite. | `[/schema_migrations/i]`
-`content_security_policy_nonce` | Sets the content security policy nonce to use when inserting Dial's script. Can be a string, or a Proc which receives `env` and response `headers` as arguments and returns the nonce string. | Rails generated nonce or `nil`
 
 ## Comparison with [rack-mini-profiler](https://github.com/MiniProfiler/rack-mini-profiler)
 
@@ -70,7 +72,7 @@ Option | Description | Default
 | Memory Profiling          | Yes (with memory_profiler)         | Yes (*overall usage only) (via vernier hook - graph)    |
 | View Profiling            | Yes                                | Yes (via vernier hook - marker table, chart)            |
 | Snapshot Sampling         | Yes                                | No                                                      |
-| Production Support        | Yes                                | No (WIP)                                                |
+| Production Support        | Yes                                | No                                                      |
 
 > [!NOTE]
 > SQL queries displayed in the profile are not annotated with the caller location by default. If you're not using the

data/lib/dial/configuration.rb

@@ -12,10 +12,11 @@ module Dial
   class Configuration
     def initialize
       @options = {
+        sampling_percentage: ::Rails.env.development? ? 100 : 1,
+        content_security_policy_nonce: -> (env, _headers) { env[NONCE] || "" },
         vernier_interval: VERNIER_INTERVAL,
         vernier_allocation_interval: VERNIER_ALLOCATION_INTERVAL,
         prosopite_ignore_queries: PROSOPITE_IGNORE_QUERIES,
-        content_security_policy_nonce: -> (env, _headers) { env[NONCE] || "" },
       }
 
       @options.keys.each do |key|
@@ -31,6 +32,7 @@ module Dial
 
     def freeze
       @options.freeze
+
       super
     end
   end

data/lib/dial/constants.rb

@@ -21,8 +21,8 @@ module Dial
   VERNIER_INTERVAL = 200
   VERNIER_ALLOCATION_INTERVAL = 2_000
   VERNIER_PROFILE_OUT_RELATIVE_DIRNAME = "tmp/dial/profiles"
+  VERNIER_PROFILE_OUT_FILE_EXTENSION = ".json.gz"
   VERNIER_VIEWER_URL = "https://vernier.prof"
 
   PROSOPITE_IGNORE_QUERIES = [/schema_migrations/i].freeze
-  PROSOPITE_LOG_IO = StringIO.new
 end

data/lib/dial/engine/routes.rb

@@ -4,14 +4,33 @@ Dial::Engine.routes.draw do
   scope path: "/dial", as: "dial" do
     get "profile", to: lambda { |env|
       uuid = env[::Rack::QUERY_STRING].sub "uuid=", ""
-      path = String ::Rails.root.join Dial::VERNIER_PROFILE_OUT_RELATIVE_DIRNAME, "#{uuid}.json.gz"
 
-      if File.exist? path
-        [
-          200,
-          { "Content-Type" => "application/json", "Access-Control-Allow-Origin" => Dial::VERNIER_VIEWER_URL },
-          [File.read(path)]
+      # Validate UUID format (should end with _vernier)
+      unless uuid.match?(/\A[0-9a-f-]+_vernier\z/)
+        return [
+          400,
+          { "Content-Type" => "text/plain" },
+          ["Bad Request"]
         ]
+      end
+
+      path = String ::Rails.root.join Dial::VERNIER_PROFILE_OUT_RELATIVE_DIRNAME, (uuid + Dial::VERNIER_PROFILE_OUT_FILE_EXTENSION)
+
+      if File.exist? path
+        begin
+          content = File.read path
+          [
+            200,
+            { "Content-Type" => "application/json", "Access-Control-Allow-Origin" => Dial::VERNIER_VIEWER_URL },
+            [content]
+          ]
+        rescue
+          [
+            500,
+            { "Content-Type" => "text/plain" },
+            ["Internal Server Error"]
+          ]
+        end
       else
         [
           404,

data/lib/dial/middleware/panel.rb

@@ -192,7 +192,7 @@ module Dial
       def formatted_profile_output env, profile_out_filename
         url_base = ::Rails.application.routes.url_helpers.dial_url host: env[::Rack::HTTP_HOST]
         prefix = "/" unless url_base.end_with? "/"
-        uuid = profile_out_filename.delete_suffix ".json.gz"
+        uuid = profile_out_filename.delete_suffix VERNIER_PROFILE_OUT_FILE_EXTENSION
         profile_out_url = URI.encode_www_form_component url_base + "#{prefix}dial/profile?uuid=#{uuid}"
 
         "<a href='https://vernier.prof/from-url/#{profile_out_url}' target='_blank'>View profile</a>"

data/lib/dial/middleware.rb

@@ -3,6 +3,7 @@
 require "vernier"
 require "prosopite"
 
+require_relative "prosopite"
 require_relative "middleware/panel"
 require_relative "middleware/ruby_stat"
 require_relative "middleware/rails_stat"
@@ -21,9 +22,13 @@ module Dial
         return @app.call env
       end
 
+      unless should_profile?
+        return @app.call env
+      end
+
       start_time = Process.clock_gettime Process::CLOCK_MONOTONIC
 
-      profile_out_filename = "#{Util.uuid}_vernier.json.gz"
+      profile_out_filename = "#{Util.uuid}_vernier" + VERNIER_PROFILE_OUT_FILE_EXTENSION
       profile_out_pathname = "#{profile_out_dir_pathname}/#{profile_out_filename}"
 
       status, headers, rack_body, ruby_vm_stat, gc_stat, gc_stat_heap, vernier_result = nil
@@ -48,19 +53,12 @@ module Dial
       finish_time = Process.clock_gettime Process::CLOCK_MONOTONIC
       env[REQUEST_TIMING] = ((finish_time - start_time) * 1_000).round 2
 
-      body = String.new.tap do |str|
-        rack_body.each { |chunk| str << chunk }
-        rack_body.close if rack_body.respond_to? :close
-
-        str.sub! "</body>", <<~HTML
-            #{Panel.html env, headers, profile_out_filename, query_logs, ruby_vm_stat, gc_stat, gc_stat_heap, server_timing}
-          </body>
-        HTML
-      end
+      panel_html = Panel.html env, headers, profile_out_filename, query_logs, ruby_vm_stat, gc_stat, gc_stat_heap, server_timing
+      body = PanelInjector.new rack_body, panel_html
 
-      headers[CONTENT_LENGTH] = body.bytesize.to_s
+      headers.delete CONTENT_LENGTH
 
-      [status, headers, [body]]
+      [status, headers, body]
     end
 
     private
@@ -89,13 +87,13 @@ module Dial
     def clear_query_logs!
       [].tap do |query_logs|
         entry = section = count = nil
-        PROSOPITE_LOG_IO.string.lines.each do |line|
+        ProsopiteLogger.log_io.string.lines.each do |line|
           entry, section, count = process_query_log_line line, entry, section, count
           query_logs << entry if entry && section.nil?
         end
 
-        PROSOPITE_LOG_IO.truncate 0
-        PROSOPITE_LOG_IO.rewind
+        ProsopiteLogger.log_io.truncate 0
+        ProsopiteLogger.log_io.rewind
       end
     end
 
@@ -126,5 +124,42 @@ module Dial
     def profile_out_dir_pathname
       ::Rails.root.join VERNIER_PROFILE_OUT_RELATIVE_DIRNAME
     end
+
+    def should_profile?
+      rand(100) < Dial._configuration.sampling_percentage
+    end
+  end
+
+  class PanelInjector
+    def initialize original_body, panel_html
+      @original_body = original_body
+      @panel_html = panel_html
+      @injected = false
+    end
+
+    def each
+      @original_body.each do |chunk|
+        if !@injected && chunk.include?("</body>")
+          @injected = true
+          yield chunk.sub("</body>", "#{@panel_html}\n</body>")
+        else
+          yield chunk
+        end
+      end
+
+      yield @panel_html unless @injected
+    ensure
+      close
+    end
+
+    def close
+      @original_body.close if @original_body.respond_to? :close
+    end
+
+    def call stream
+      each { |chunk| stream.write chunk }
+    ensure
+      close
+    end
   end
 end

data/lib/dial/prosopite.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "active_support/core_ext/string/filters"
+
 module Dial
   module Prosopite
     def send_notifications

data/lib/dial/prosopite_logger.rb

@@ -4,5 +4,20 @@ require "logger"
 
 module Dial
   class ProsopiteLogger < Logger
+    def self.log_io
+      Thread.current[:dial_prosopite_log_io] ||= StringIO.new
+    end
+
+    def initialize
+      super StringIO.new
+    end
+
+    def add severity, message = nil, progname = nil
+      return if severity < level
+
+      progname = @progname if progname.nil?
+      formatted_message = format_message format_severity(severity), Time.now, progname, message
+      self.class.log_io.write formatted_message
+    end
   end
 end

data/lib/dial/railtie.rb

@@ -4,42 +4,32 @@ require "rails"
 require "active_record"
 require "prosopite"
 
-require_relative "prosopite"
 require_relative "middleware"
 require_relative "prosopite_logger"
 
 module Dial
   class Railtie < ::Rails::Railtie
-    initializer "dial.use_middleware", after: :load_config_initializers do |app|
+    initializer "dial.setup", after: :load_config_initializers do |app|
+      # use middleware
       app.middleware.insert_before 0, Middleware
-    end
-
-    initializer "dial.set_up_vernier", after: :load_config_initializers do |app|
-      app.config.after_initialize do
-        FileUtils.mkdir_p ::Rails.root.join VERNIER_PROFILE_OUT_RELATIVE_DIRNAME
-      end
-    end
 
-    initializer "dial.clean_up_vernier_profile_out_files", after: :load_config_initializers do |app|
-      stale_files("#{profile_out_dir_pathname}/*.json.gz").each do |profile_out_file|
+      # clean up stale vernier profile output files
+      stale_files("#{profile_out_dir_pathname}/*" + VERNIER_PROFILE_OUT_FILE_EXTENSION).each do |profile_out_file|
         File.delete profile_out_file rescue nil
       end
-    end
 
-    initializer "dial.set_up_prosopite", after: :load_config_initializers do |app|
       app.config.after_initialize do
+        # set up vernier
+        FileUtils.mkdir_p ::Rails.root.join VERNIER_PROFILE_OUT_RELATIVE_DIRNAME
+
+        # set up prosopite
         if ::ActiveRecord::Base.configurations.configurations.any? { |config| config.adapter == "postgresql" }
           require "pg_query"
         end
+        ::Prosopite.custom_logger = ProsopiteLogger.new
 
-        ::Prosopite.custom_logger = ProsopiteLogger.new PROSOPITE_LOG_IO
-      end
-    end
-
-    initializer "dial.setup", after: :load_config_initializers do |app|
-      app.config.after_initialize do
+        # finalize configuration
         Dial._configuration.freeze
-
         ::Prosopite.ignore_queries = Dial._configuration.prosopite_ignore_queries
       end
     end

data/lib/dial/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dial
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/dial.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative "dial/util"
 require_relative "dial/constants"
+require_relative "dial/util"
 
 require_relative "dial/configuration"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dial
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Joshua Young
@@ -138,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.7.1
 specification_version: 4
 summary: A modern profiler for your Rails application
 test_files: []