dial 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0cde97fba38cb1cf2eb253b525513f6e531f1e5b917eda64ebcae004e608fb6
-  data.tar.gz: 97e745b90b4bb7bfaae7ac64c8bb26325fe7927182877d316bf503b46e9712b8
+  metadata.gz: edead8fe405ee09b2ece6be004f6200ddd9394707a41da3509cbd168f3b88c67
+  data.tar.gz: 506f4b258c2b0acf117b1f4885ede6cf93ec739c1f21e0dc82b1f3da086f9a2c
 SHA512:
-  metadata.gz: b5efaaef24b3fa42ddbb732c70f0af3ba9d4240ddc1a4b520304a68b020ec88c5b1751e92c79b0d8c02fe20b521e73bf27adeefd9af5293a03bd33aeb8dc17e7
-  data.tar.gz: b9b65a06f97a67fd003e73b6b8337d0a9800fb78dc02b095f4878e4b3062a69915e4022e270669c870df3514d45d57c15132f45bf70c4b559eeacd9b3d050d26
+  metadata.gz: c8f6c3705814f0cc0ae49bddf462741cf74d6de0733bd08280f6b01123368afb6ad46a1f7bf09329ee1c16c53a1d651c34b39d7277efce651f72550cd8e06557
+  data.tar.gz: 22236134d9731d47eacbc6d931ed2484b4e5451c875e554dcd5fc5fea3db84e3aaaf429db3f318939de30d52aa49ff49251f5300fc8243bf41e247d40c11c555

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.2.3] - 2025-02-28
+
+- Add configuration API
+- Make default prosopite ignore queries case insensitive
+
 ## [0.2.2] - 2025-02-27
 
 - Increase default vernier allocation interval from 200 to 20k

data/README.md

@@ -33,6 +33,18 @@ bundle install
 mount Dial::Engine, at: "/" if Rails.env.development?
 ```
 
+4. (Optional) Configure the gem in an initializer:
+
+```ruby
+# config/initializers/dial.rb
+
+Dial.configure do |config|
+  config.vernier_interval = 100 # default: 200
+  config.vernier_allocation_interval = 10_000 # default: 20_000
+  config.prosopite_ignore_queries += [/pg_sleep/i] # default: [/schema_migrations/i]
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` to run the

data/lib/dial/configuration.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Dial
+  def self.configure
+    yield _configuration
+  end
+
+  def self._configuration
+    @_configuration ||= Configuration.new
+  end
+
+  class Configuration
+    def initialize
+      @options = {
+        vernier_interval: VERNIER_INTERVAL,
+        vernier_allocation_interval: VERNIER_ALLOCATION_INTERVAL,
+        prosopite_ignore_queries: PROSOPITE_IGNORE_QUERIES,
+      }
+
+      @options.keys.each do |key|
+        define_singleton_method(key) do
+          @options[key]
+        end
+
+        define_singleton_method("#{key}=") do |value|
+          @options[key] = value
+        end
+      end
+    end
+
+    def freeze
+      @options.freeze
+      super
+    end
+  end
+end

data/lib/dial/constants.rb

@@ -18,7 +18,7 @@ module Dial
   VERNIER_ALLOCATION_INTERVAL = 20_000
   VERNIER_PROFILE_OUT_RELATIVE_DIRNAME = "tmp/dial/profiles"
 
-  PROSOPITE_IGNORE_QUERIES = [/schema_migrations/].freeze
+  PROSOPITE_IGNORE_QUERIES = [/schema_migrations/i].freeze
   PROSOPITE_LOG_RELATIVE_DIRNAME = "log/dial"
   PROSOPITE_LOG_FILENAME = "#{Util.uuid}_prosopite_#{PROGRAM_ID}.log".freeze
 end

data/lib/dial/middleware.rb

@@ -28,7 +28,9 @@ module Dial
 
       status, headers, rack_body, ruby_vm_stat, gc_stat, gc_stat_heap, vernier_result = nil
       ::Prosopite.scan do
-        vernier_result = ::Vernier.profile interval: VERNIER_INTERVAL, allocation_interval: VERNIER_ALLOCATION_INTERVAL, hooks: [:memory_usage, :rails] do
+        vernier_result = ::Vernier.profile interval: Dial._configuration.vernier_interval, \
+                                           allocation_interval: Dial._configuration.vernier_allocation_interval, \
+                                           hooks: [:memory_usage, :rails] do
           ruby_vm_stat, gc_stat, gc_stat_heap = with_diffed_ruby_stats do
             status, headers, rack_body = @app.call env
           end

data/lib/dial/railtie.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "rails"
+require "active_record"
 require "prosopite"
 
 require_relative "middleware"
@@ -8,25 +9,25 @@ require_relative "prosopite_logger"
 
 module Dial
   class Railtie < ::Rails::Railtie
-    initializer "dial.use_middleware" do |app|
+    initializer "dial.use_middleware", after: :load_config_initializers do |app|
       app.middleware.insert_before 0, Middleware
     end
 
-    initializer "dial.set_up_vernier" do |app|
+    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" do |app|
+    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|
         File.delete profile_out_file rescue nil
       end
     end
 
-    initializer "dial.set_up_prosopite" do |app|
+    initializer "dial.set_up_prosopite", after: :load_config_initializers do |app|
       app.config.after_initialize do
-        if ::ActiveRecord::Base.connection.adapter_name == "PostgreSQL"
+        if ::ActiveRecord::Base.configurations.configurations.any? { |config| config.adapter == "postgresql" }
           require "pg_query"
         end
 
@@ -34,17 +35,24 @@ module Dial
         FileUtils.mkdir_p File.dirname prosopite_log_pathname
         FileUtils.touch prosopite_log_pathname
         ::Prosopite.custom_logger = ProsopiteLogger.new prosopite_log_pathname
-
-        ::Prosopite.ignore_queries = PROSOPITE_IGNORE_QUERIES
       end
     end
 
-    initializer "dial.clean_up_prosopite_log_files" do |app|
+    initializer "dial.clean_up_prosopite_log_files", after: :load_config_initializers do |app|
       stale_files("#{query_log_dir_pathname}/*.log").each do |query_log_file|
         File.delete query_log_file rescue nil
       end
     end
 
+    initializer "dial.setup", after: :load_config_initializers do |app|
+      app.config.after_initialize do
+        Dial._configuration.freeze
+
+        # set static configuration options
+        ::Prosopite.ignore_queries = Dial._configuration.prosopite_ignore_queries
+      end
+    end
+
     private
 
     def stale_files glob_pattern

data/lib/dial/version.rb

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

data/lib/dial.rb

@@ -3,5 +3,7 @@
 require_relative "dial/util"
 require_relative "dial/constants"
 
+require_relative "dial/configuration"
+
 require_relative "dial/railtie"
 require_relative "dial/engine"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: dial
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Joshua Young
 bindir: bin
 cert_chain: []
-date: 2025-02-27 00:00:00.000000000 Z
+date: 2025-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -123,6 +123,7 @@ files:
 - README.md
 - dial.gemspec
 - lib/dial.rb
+- lib/dial/configuration.rb
 - lib/dial/constants.rb
 - lib/dial/engine.rb
 - lib/dial/engine/routes.rb