dial 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc0b70ff1d770bd0fc85123280a07bb683d649a059df325b2b9cad938ea346e2
-  data.tar.gz: ef4ab7cdb79f4e773b9d19d35d40624085a1ea15b47798fc9a092c476e4d5f25
+  metadata.gz: 204280e63f9f71fe949ccc5497b5e12e207ae681314caf73063163f785b7126b
+  data.tar.gz: 21c70e61114ef47f38e194b812c3b0f52aba68ba7976972b13700db90e1451a8
 SHA512:
-  metadata.gz: 5fd19ba186d0689ad63827557f944c0fcee39c41c0d77053450d1a81ff52bb74442f26e7eb4bb377efacea763f87903d467c858834da56483a3d4ddf01307acc
-  data.tar.gz: 45ccf2409afdc88cca32063aa3583737f00eaffea57f10701a9d6d2c45d066586c85e52eea2387ee9cacb2bc0712feca2159c16e711c52c1c8e2c4f8e34ef162
+  metadata.gz: e94c02266b0abd60727413d95bf7ec6238466dfa03725c904dac9443d1be63c448e05e7099d2c5ea44f7c153b155f8dd6176ca972103a0a3778bd8d7076b2f6e
+  data.tar.gz: a6207c9decc7cdd7c009e6d85b38745a53c49b9703740ea35c143ebbbe9f347784136c718f902de4050e9f7dbc02d9b339b3f0a3e28332db3d43c1105d25191a

data/CHANGELOG.md

@@ -1,12 +1,16 @@
 ## [Unreleased]
 
+## [0.5.0] - 2025-09-21
+
+- Add storage interface with Redis cluster and Memcached adapters for distributed deployments
+
 ## [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
+- Fix missing namespace for VERNIER_PROFILE_OUT_FILE_EXTENSION in engine routes
+- Make prosopite logging thread-safe with thread-local storage
+- Replace response body buffering with streaming response wrapper
+- Add sampling configuration to control percentage of requests profiled
 
 ## [0.3.2] - 2025-05-14
 

data/README.md

@@ -19,9 +19,7 @@ Utilizes [vernier](https://github.com/jhawthorn/vernier) for profiling and
 1. Add the gem to your Rails application's Gemfile:
 
 ```ruby
-group :development do
-  gem "dial"
-end
+gem "dial"
 ```
 
 2. Install the gem:
@@ -34,7 +32,7 @@ bundle install
 
 ```ruby
 # this will mount the engine at /dial
-mount Dial::Engine, at: "/" if Rails.env.development?
+mount Dial::Engine, at: "/"
 ```
 
 4. (Optional) Configure the gem in an initializer:
@@ -44,6 +42,8 @@ mount Dial::Engine, at: "/" if Rails.env.development?
 
 Dial.configure do |config|
   config.sampling_percentage = 50
+  config.storage = Dial::Storage::RedisAdapter
+  config.storage_options = { client: Redis.new(url: ENV["REDIS_URL"]), ttl: 86400 }
   config.vernier_interval = 100
   config.vernier_allocation_interval = 10_000
   config.prosopite_ignore_queries += [/pg_sleep/i]
@@ -55,11 +55,62 @@ end
 Option | Description | Default
 :- | :- | :-
 `sampling_percentage` | Percentage of requests to profile. | `100` in development, `1` in production
+`storage` | Storage adapter class for profile data | `Dial::Storage::FileAdapter`
+`storage_options` | Options hash passed to storage adapter | `{ ttl: 3600 }`
 `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]`
 
+## Storage Backends
+
+### File Storage (Default)
+
+Profile data is stored as files on disk with polled expiration. Only suitable for development and single-server deployments.
+
+```ruby
+Dial.configure do |config|
+  config.storage = Dial::Storage::FileAdapter
+  config.storage_options = { ttl: 86400 }
+end
+```
+
+### Redis Storage
+
+Profile data is stored in Redis with automatic expiration. Supports both single Redis instances and Redis Cluster.
+
+```ruby
+# Single Redis instance
+Dial.configure do |config|
+  config.storage = Dial::Storage::RedisAdapter
+  config.storage_options = { client: Redis.new(url: "redis://localhost:6379"), ttl: 86400 }
+end
+
+# Redis Cluster
+Dial.configure do |config|
+  config.storage = Dial::Storage::RedisAdapter
+  config.storage_options = {
+    client: Redis::Cluster.new(nodes: [
+      "redis://node1:7000",
+      "redis://node2:7001",
+      "redis://node3:7002"
+    ]),
+    ttl: 86400
+  }
+end
+```
+
+### Memcached Storage
+
+Profile data is stored in Memcached with automatic expiration.
+
+```ruby
+Dial.configure do |config|
+  config.storage = Dial::Storage::MemcachedAdapter
+  config.storage_options = { client: Dalli::Client.new("localhost:11211"), ttl: 86400 }
+end
+```
+
 ## Comparison with [rack-mini-profiler](https://github.com/MiniProfiler/rack-mini-profiler)
 
 |                           | rack-mini-profiler                 | Dial                                                    |
@@ -72,18 +123,18 @@ 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                                                      |
-
-> [!NOTE]
-> SQL queries displayed in the profile are not annotated with the caller location by default. If you're not using the
-> [marginalia](https://github.com/basecamp/marginalia) gem to annotate your queries, you will need to extend your
-> application's [ActiveRecord QueryLogs](https://edgeapi.rubyonrails.org/classes/ActiveRecord/QueryLogs.html) yourself.
+| Storage Backends          | Redis, Memcached, File, Memory     | Redis, Memcached, File                                  |
+| Production Ready          | Yes                                | Yes                                                     |
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` to run the
 tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
+### Testing Storage Adapters
+
+To test the Redis and Memcached storage adapters, you'll need running instances: `docker compose -f docker-compose.storage.yml up`
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/joshuay03/dial.

data/lib/dial/configuration.rb

@@ -12,8 +12,10 @@ module Dial
   class Configuration
     def initialize
       @options = {
-        sampling_percentage: ::Rails.env.development? ? 100 : 1,
-        content_security_policy_nonce: -> (env, _headers) { env[NONCE] || "" },
+        sampling_percentage: default_sampling_percentage,
+        storage: default_storage,
+        storage_options: { ttl: STORAGE_TTL },
+        content_security_policy_nonce: -> env, _headers { env[NONCE] || EMPTY_NONCE },
         vernier_interval: VERNIER_INTERVAL,
         vernier_allocation_interval: VERNIER_ALLOCATION_INTERVAL,
         prosopite_ignore_queries: PROSOPITE_IGNORE_QUERIES,
@@ -35,5 +37,15 @@ module Dial
 
       super
     end
+
+    private
+
+    def default_sampling_percentage
+      ::Rails.env.development? ? SAMPLING_PERCENTAGE_DEV : SAMPLING_PERCENTAGE_PROD
+    end
+
+    def default_storage
+      Storage::FileAdapter
+    end
   end
 end

data/lib/dial/constants.rb

@@ -16,7 +16,10 @@ module Dial
   NONCE = ::ActionDispatch::ContentSecurityPolicy::Request::NONCE
   REQUEST_TIMING = "dial_request_timing"
 
-  FILE_STALE_SECONDS = 60 * 60
+  SAMPLING_PERCENTAGE_DEV = 100
+  SAMPLING_PERCENTAGE_PROD = 1
+  STORAGE_TTL = 60 * 60
+  EMPTY_NONCE = ""
 
   VERNIER_INTERVAL = 200
   VERNIER_ALLOCATION_INTERVAL = 2_000

data/lib/dial/engine/routes.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
+require "uri"
+
 Dial::Engine.routes.draw do
   scope path: "/dial", as: "dial" do
     get "profile", to: lambda { |env|
-      uuid = env[::Rack::QUERY_STRING].sub "uuid=", ""
-
-      # Validate UUID format (should end with _vernier)
-      unless uuid.match?(/\A[0-9a-f-]+_vernier\z/)
+      query_params = URI.decode_www_form(env[::Rack::QUERY_STRING]).to_h
+      profile_key = query_params["key"]
+      unless profile_key && profile_key.match?(/\A[0-9a-f-]+_vernier\z/i)
         return [
           400,
           { "Content-Type" => "text/plain" },
@@ -14,28 +15,27 @@ Dial::Engine.routes.draw do
         ]
       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
+      profile_storage_key = Dial::Storage.profile_storage_key profile_key
+      begin
+        content = Dial::Storage.fetch profile_storage_key
+        if content
           [
             200,
             { "Content-Type" => "application/json", "Access-Control-Allow-Origin" => Dial::VERNIER_VIEWER_URL },
             [content]
           ]
-        rescue
+        else
           [
-            500,
+            404,
             { "Content-Type" => "text/plain" },
-            ["Internal Server Error"]
+            ["Not Found"]
           ]
         end
-      else
+      rescue
         [
-          404,
+          500,
           { "Content-Type" => "text/plain" },
-          ["Not Found"]
+          ["Internal Server Error"]
         ]
       end
     }

data/lib/dial/middleware/panel.rb

@@ -7,7 +7,7 @@ module Dial
     QUERY_CHARS_TRUNCATION_THRESHOLD = 100
 
     class << self
-      def html env, headers, profile_out_filename, query_logs, ruby_vm_stat, gc_stat, gc_stat_heap, server_timing
+      def html env, headers, profile_key, query_logs, ruby_vm_stat, gc_stat, gc_stat_heap, server_timing
         <<~HTML
           <style>#{style}</style>
 
@@ -16,7 +16,7 @@ module Dial
               <span id="dial-preview-header">
                 #{formatted_rails_route_info env} |
                 #{formatted_request_timing env} |
-                #{formatted_profile_output env, profile_out_filename}
+                #{formatted_profile_output env, profile_key}
               </span>
               <span id="dial-preview-rails-version">#{formatted_rails_version}</span>
               <span id="dial-preview-rack-version">#{formatted_rack_version}</span>
@@ -189,11 +189,10 @@ module Dial
         "<b>Request timing:</b> #{env[REQUEST_TIMING]}ms"
       end
 
-      def formatted_profile_output env, profile_out_filename
+      def formatted_profile_output env, profile_key
         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 VERNIER_PROFILE_OUT_FILE_EXTENSION
-        profile_out_url = URI.encode_www_form_component url_base + "#{prefix}dial/profile?uuid=#{uuid}"
+        profile_out_url = URI.encode_www_form_component url_base + "#{prefix}dial/profile?key=#{profile_key}"
 
         "<a href='https://vernier.prof/from-url/#{profile_out_url}' target='_blank'>View profile</a>"
       end

data/lib/dial/middleware.rb

@@ -28,9 +28,6 @@ module Dial
 
       start_time = Process.clock_gettime Process::CLOCK_MONOTONIC
 
-      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
       ::Prosopite.scan do
         vernier_result = ::Vernier.profile interval: Dial._configuration.vernier_interval, \
@@ -41,19 +38,19 @@ module Dial
           end
         end
       end
-      server_timing = server_timing headers
 
       unless headers[CONTENT_TYPE]&.include? CONTENT_TYPE_HTML
         return [status, headers, rack_body]
       end
 
-      write_vernier_result! vernier_result, profile_out_pathname
-      query_logs = clear_query_logs!
-
       finish_time = Process.clock_gettime Process::CLOCK_MONOTONIC
       env[REQUEST_TIMING] = ((finish_time - start_time) * 1_000).round 2
 
-      panel_html = Panel.html env, headers, profile_out_filename, query_logs, ruby_vm_stat, gc_stat, gc_stat_heap, server_timing
+      profile_key = Storage.generate_profile_key
+      store_profile_data! vernier_result, (Storage.profile_storage_key profile_key)
+      query_logs = clear_query_logs!
+      server_timing = server_timing headers
+      panel_html = Panel.html env, headers, profile_key, query_logs, ruby_vm_stat, gc_stat, gc_stat_heap, server_timing
       body = PanelInjector.new rack_body, panel_html
 
       headers.delete CONTENT_LENGTH
@@ -75,12 +72,19 @@ module Dial
       ]
     end
 
-    def write_vernier_result! result, pathname
-      Thread.new do
-        Thread.current.name = "Dial::Middleware#write_vernier_result!"
+    def store_profile_data! vernier_result, profile_storage_key
+      Thread.new(vernier_result, profile_storage_key) do |vernier_result, profile_storage_key|
+        Thread.current.name = "Dial::Middleware#store_profile_data!"
         Thread.current.report_on_exception = false
 
-        result.write out: pathname
+        # TODO: Support StringIO in vernier's #write method to avoid temp file I/O
+        Tempfile.create(["vernier_profile", ".json"]) do |temp_file|
+          vernier_result.write out: temp_file.path
+          profile_data = File.read(temp_file.path)
+          Storage.store profile_storage_key, profile_data
+        end
+
+        Storage.cleanup
       end
     end
 
@@ -121,10 +125,6 @@ module Dial
       end
     end
 
-    def profile_out_dir_pathname
-      ::Rails.root.join VERNIER_PROFILE_OUT_RELATIVE_DIRNAME
-    end
-
     def should_profile?
       rand(100) < Dial._configuration.sampling_percentage
     end

data/lib/dial/railtie.rb

@@ -10,18 +10,10 @@ require_relative "prosopite_logger"
 module Dial
   class Railtie < ::Rails::Railtie
     initializer "dial.setup", after: :load_config_initializers do |app|
-      # use middleware
-      app.middleware.insert_before 0, Middleware
-
-      # 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
+      # clean up stale storage data
+      Storage.cleanup
 
       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"
@@ -34,17 +26,9 @@ module Dial
       end
     end
 
-    private
-
-    def stale_files glob_pattern
-      Dir.glob(glob_pattern).select do |file|
-        timestamp = Util.uuid_timestamp Util.file_name_uuid File.basename file
-        timestamp < Time.now - FILE_STALE_SECONDS
-      end
-    end
-
-    def profile_out_dir_pathname
-      ::Rails.root.join VERNIER_PROFILE_OUT_RELATIVE_DIRNAME
+    initializer "dial.middleware", before: :build_middleware_stack do |app|
+      # use middleware
+      app.middleware.insert_before 0, Middleware
     end
   end
 end

data/lib/dial/storage/file_adapter.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "zlib"
+require "fileutils"
+
+module Dial
+  class Storage
+    class FileAdapter
+      def initialize options = {}
+        @ttl = options[:ttl] || STORAGE_TTL
+        @profile_dir = ::Rails.root.join VERNIER_PROFILE_OUT_RELATIVE_DIRNAME
+        FileUtils.mkdir_p @profile_dir
+      rescue Errno::ENOENT
+        FileUtils.mkdir_p File.dirname @profile_dir
+        FileUtils.mkdir_p @profile_dir
+      end
+
+      def store key, data, ttl: nil
+        ttl ||= @ttl
+        store_profile key, data, ttl
+      end
+
+      def fetch key
+        fetch_profile key
+      end
+
+      def delete key
+        delete_profile key
+      end
+
+      def cleanup
+        expired_files("#{@profile_dir}/*").each { |file| File.delete file rescue nil }
+      end
+
+      private
+
+      def store_profile key, data, ttl
+        uuid = extract_uuid key
+        path = profile_path uuid
+        File.binwrite path, data
+        set_file_expiry path, ttl
+      end
+
+      def fetch_profile key
+        uuid = extract_uuid key
+        path = profile_path uuid
+        File.binread path if File.exist? path
+      end
+
+      def delete_profile key
+        uuid = extract_uuid key
+        path = profile_path uuid
+        File.delete path if File.exist? path
+      end
+
+      def extract_uuid key
+        Storage.extract_uuid key
+      end
+
+      def profile_path uuid
+        @profile_dir.join "#{uuid}#{VERNIER_PROFILE_OUT_FILE_EXTENSION}"
+      end
+
+      def expired_files glob_pattern
+        Dir.glob(glob_pattern).select { |file| file_expired? file }
+      end
+
+      def set_file_expiry path, ttl
+        expire_time = Time.now + ttl
+        File.utime expire_time, expire_time, path
+      end
+
+      def file_expired? path
+        return false unless File.exist? path
+
+        File.mtime(path) < Time.now
+      end
+    end
+  end
+end

data/lib/dial/storage/memcached_adapter.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Dial
+  class Storage
+    class MemcachedAdapter
+      def initialize options = {}
+        raise ArgumentError, "Memcached client required" unless options[:client]
+
+        @client = options[:client]
+        @ttl = options[:ttl] || STORAGE_TTL
+      end
+
+      def store key, data, ttl: nil
+        ttl ||= @ttl
+        @client.set (Storage.format_key key), data, ttl
+      end
+
+      def fetch key
+        @client.get Storage.format_key key
+      end
+
+      def delete key
+        @client.delete Storage.format_key key
+      end
+    end
+  end
+end

data/lib/dial/storage/redis_adapter.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Dial
+  class Storage
+    class RedisAdapter
+      def initialize options = {}
+        raise ArgumentError, "Redis client required" unless options[:client]
+
+        @client = options[:client]
+        @ttl = options[:ttl] || STORAGE_TTL
+      end
+
+      def store key, data, ttl: nil
+        ttl ||= @ttl
+        @client.setex (Storage.format_key key), ttl, data
+      end
+
+      def fetch key
+        @client.get Storage.format_key key
+      end
+
+      def delete key
+        @client.del Storage.format_key key
+      end
+    end
+  end
+end

data/lib/dial/storage.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative "storage/file_adapter"
+require_relative "storage/redis_adapter"
+require_relative "storage/memcached_adapter"
+
+module Dial
+  class Storage
+    SUPPORTED_ADAPTERS = [FileAdapter, RedisAdapter, MemcachedAdapter].freeze
+
+    @mutex = Mutex.new
+
+    class << self
+      def validate_key! key
+        unless key.match?(/\A.+_vernier:.+\z/)
+          raise ArgumentError, "Invalid key format: #{key}. Expected format: '<uuid>_vernier:<suffix>'"
+        end
+      end
+
+      def extract_uuid key
+        validate_key! key
+        key.split(":", 2).first
+      end
+
+      # Format key for Redis Cluster compatibility (hash tags)
+      def format_key key
+        uuid = extract_uuid key
+        suffix = key.split(":", 2).last
+        "{#{uuid}}:#{suffix}"
+      end
+
+      def profile_storage_key profile_key
+        "#{profile_key}:profile"
+      end
+
+      def generate_profile_key
+        "#{Util.uuid}_vernier"
+      end
+
+      def adapter
+        return @adapter if @adapter
+
+        @mutex.synchronize do
+          @adapter ||= build_adapter
+        end
+      end
+
+      def store key, data, ttl: nil
+        adapter.store key, data, ttl: ttl
+      end
+
+      def fetch key
+        adapter.fetch key
+      end
+
+      def delete key
+        adapter.delete key
+      end
+
+      def cleanup
+        adapter.cleanup if adapter.respond_to? :cleanup
+      end
+
+      private
+
+      def build_adapter
+        config = Dial._configuration
+        unless SUPPORTED_ADAPTERS.include? storage_class = config.storage
+          raise ArgumentError, "Unsupported storage type: #{storage_class}. Supported adapters: #{SUPPORTED_ADAPTERS.map(&:name).join ', '}"
+        end
+
+        storage_class.new config.storage_options
+      end
+    end
+  end
+end

data/lib/dial/version.rb

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

data/lib/dial.rb

@@ -4,6 +4,7 @@ require_relative "dial/constants"
 require_relative "dial/util"
 
 require_relative "dial/configuration"
+require_relative "dial/storage"
 
 require_relative "dial/railtie"
 require_relative "dial/engine"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dial
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Joshua Young
@@ -116,6 +116,10 @@ files:
 - lib/dial/prosopite.rb
 - lib/dial/prosopite_logger.rb
 - lib/dial/railtie.rb
+- lib/dial/storage.rb
+- lib/dial/storage/file_adapter.rb
+- lib/dial/storage/memcached_adapter.rb
+- lib/dial/storage/redis_adapter.rb
 - lib/dial/util.rb
 - lib/dial/version.rb
 homepage: https://github.com/joshuay03/dial
@@ -138,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 3.7.2
 specification_version: 4
 summary: A modern profiler for your Rails application
 test_files: []