dial 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 204280e63f9f71fe949ccc5497b5e12e207ae681314caf73063163f785b7126b
-  data.tar.gz: 21c70e61114ef47f38e194b812c3b0f52aba68ba7976972b13700db90e1451a8
+  metadata.gz: d4f60345ab5528878505773aa1b5875d4e00164ac9e94968584a40ecbb18b251
+  data.tar.gz: 5d2d5399d37be584ed2dd17f39cd98ed45af05a66e2eb8609fd340ef54dbeeb9
 SHA512:
-  metadata.gz: e94c02266b0abd60727413d95bf7ec6238466dfa03725c904dac9443d1be63c448e05e7099d2c5ea44f7c153b155f8dd6176ca972103a0a3778bd8d7076b2f6e
-  data.tar.gz: a6207c9decc7cdd7c009e6d85b38745a53c49b9703740ea35c143ebbbe9f347784136c718f902de4050e9f7dbc02d9b339b3f0a3e28332db3d43c1105d25191a
+  metadata.gz: f78cf96c6482b571710c49363e00e7ffb5e65f8e07f180d9e5d99ce862af4d28c2032ff8757b565dc053699e0d4d044dfae26346de297b310c4324c659101216
+  data.tar.gz: 522ab5c9d3f3e556a71f440256a36d6f2bedc0abb5dccab05c147bc21a50332da581683188fcb1f672c58fc05773782d65fb575995d6adc0f0a856b9e78d6e8c

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.5.1] - 2025-09-27
+
+- Don't clean up stale storage data in railtie
+- Add enabled configuration option and force parameter for per-request profiling
+
 ## [0.5.0] - 2025-09-21
 
 - Add storage interface with Redis cluster and Memcached adapters for distributed deployments

data/README.md

@@ -41,9 +41,15 @@ mount Dial::Engine, at: "/"
 # config/initializers/dial.rb
 
 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.enabled = !Rails.env.production? # disable by default in production, use force_param to enable per request
+  config.force_param = "profile" # override param name to force profiling
+  if Rails.env.staging?
+    config.sampling_percentage = 50 # override sampling percentage in staging for A/B testing profiler impact
+  end
+  unless Rails.env.development?
+    config.storage = Dial::Storage::RedisAdapter # use Redis storage in non-development environments
+    config.storage_options = { client: Redis.new(url: ENV["REDIS_URL"]), ttl: 86400 }
+  end
   config.vernier_interval = 100
   config.vernier_allocation_interval = 10_000
   config.prosopite_ignore_queries += [/pg_sleep/i]
@@ -54,9 +60,11 @@ end
 
 Option | Description | Default
 :- | :- | :-
+`enabled` | Whether profiling is enabled. | `true`
+`force_param` | Request parameter name to force profiling even when disabled. Always profiles (bypasses sampling). | `"dial_force"`
 `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 }`
+`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`

data/lib/dial/configuration.rb

@@ -12,8 +12,10 @@ module Dial
   class Configuration
     def initialize
       @options = {
-        sampling_percentage: default_sampling_percentage,
-        storage: default_storage,
+        enabled: true,
+        force_param: FORCE_PARAM,
+        sampling_percentage: ::Rails.env.development? ? SAMPLING_PERCENTAGE_DEV : SAMPLING_PERCENTAGE_PROD,
+        storage: Storage::FileAdapter,
         storage_options: { ttl: STORAGE_TTL },
         content_security_policy_nonce: -> env, _headers { env[NONCE] || EMPTY_NONCE },
         vernier_interval: VERNIER_INTERVAL,
@@ -37,15 +39,5 @@ 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,6 +16,7 @@ module Dial
   NONCE = ::ActionDispatch::ContentSecurityPolicy::Request::NONCE
   REQUEST_TIMING = "dial_request_timing"
 
+  FORCE_PARAM = "dial_force"
   SAMPLING_PERCENTAGE_DEV = 100
   SAMPLING_PERCENTAGE_PROD = 1
   STORAGE_TTL = 60 * 60

data/lib/dial/middleware.rb

@@ -22,7 +22,8 @@ module Dial
         return @app.call env
       end
 
-      unless should_profile?
+      request = ::Rack::Request.new env
+      unless should_profile? request
         return @app.call env
       end
 
@@ -125,8 +126,12 @@ module Dial
       end
     end
 
-    def should_profile?
-      rand(100) < Dial._configuration.sampling_percentage
+    def should_profile? request
+      force_param = Dial._configuration.force_param
+      return true if request.params[force_param]
+
+      Dial._configuration.enabled &&
+        rand(100) < Dial._configuration.sampling_percentage
     end
   end
 

data/lib/dial/railtie.rb

@@ -10,9 +10,6 @@ require_relative "prosopite_logger"
 module Dial
   class Railtie < ::Rails::Railtie
     initializer "dial.setup", after: :load_config_initializers do |app|
-      # clean up stale storage data
-      Storage.cleanup
-
       app.config.after_initialize do
         # set up prosopite
         if ::ActiveRecord::Base.configurations.configurations.any? { |config| config.adapter == "postgresql" }

data/lib/dial/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dial
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Joshua Young