Contents

# frozen_string_literal: true

require "active_support/notifications"
require "active_record/explain_registry"

module ActiveRecord
  class ExplainSubscriber # :nodoc:
    def start(name, id, payload)
      # unused
    end

    def finish(name, id, payload)
      if ExplainRegistry.collect? && !ignore_payload?(payload)
        ExplainRegistry.queries << payload.values_at(:sql, :binds)
      end
    end

    # SCHEMA queries cannot be EXPLAINed, also we do not want to run EXPLAIN on
    # our own EXPLAINs no matter how loopingly beautiful that would be.
    #
    # On the other hand, we want to monitor the performance of our real database
    # queries, not the performance of the access to the query cache.
    IGNORED_PAYLOADS = %w(SCHEMA EXPLAIN)
    EXPLAINED_SQLS = /\A\s*(\/\*.*\*\/)?\s*(with|select|update|delete|insert)\b/i
    def ignore_payload?(payload)
      payload[:exception] ||
        payload[:cached] ||
        IGNORED_PAYLOADS.include?(payload[:name]) ||
        !payload[:sql].match?(EXPLAINED_SQLS)
    end

    ActiveSupport::Notifications.subscribe("sql.active_record", new)
  end
end

Version data entries

59 entries across 58 versions & 7 rubygems

Version	Path
activerecord-8.0.2	lib/active_record/explain_subscriber.rb
trusty-cms-7.0.9.1	vendor/bundle/ruby/3.3.0/gems/activerecord-7.0.8.7/lib/active_record/explain_subscriber.rb
minato_ruby_api_client-0.2.2	vendor/bundle/ruby/3.2.0/gems/activerecord-7.1.3.4/lib/active_record/explain_subscriber.rb
activerecord-8.0.1	lib/active_record/explain_subscriber.rb
activerecord-8.0.0.1	lib/active_record/explain_subscriber.rb
activerecord-7.2.2.1	lib/active_record/explain_subscriber.rb
activerecord-7.1.5.1	lib/active_record/explain_subscriber.rb
activerecord-7.0.8.7	lib/active_record/explain_subscriber.rb
activerecord-8.0.0	lib/active_record/explain_subscriber.rb
activerecord-7.2.2	lib/active_record/explain_subscriber.rb
activerecord-7.1.5	lib/active_record/explain_subscriber.rb
activerecord-8.0.0.rc2	lib/active_record/explain_subscriber.rb
activerecord-7.2.1.2	lib/active_record/explain_subscriber.rb
activerecord-7.1.4.2	lib/active_record/explain_subscriber.rb
activerecord-7.0.8.6	lib/active_record/explain_subscriber.rb
activerecord-8.0.0.rc1	lib/active_record/explain_subscriber.rb
activerecord-7.2.1.1	lib/active_record/explain_subscriber.rb
activerecord-7.1.4.1	lib/active_record/explain_subscriber.rb
activerecord-7.0.8.5	lib/active_record/explain_subscriber.rb
activerecord-8.0.0.beta1	lib/active_record/explain_subscriber.rb