Class: AllStak::Integrations::ActiveRecordIntegration::Subscriber

Inherits:
Object
  • Object
show all
Defined in:
lib/allstak/integrations/active_record.rb

Overview

Subscribes to ‘sql.active_record` via ActiveSupport::Notifications and records every ORM-level query with timing, status, and connection metadata.

Skips:

* schema / EXPLAIN / SAVEPOINT / TRANSACTION / nil SQL
* our own AllStak internal transport (there is none on AR side, but guarded)

Duplicates are avoided because ActiveRecord fires a single ‘sql.active_record` event per executed command — whether it’s from an ORM query, a ‘find_by_sql`, or `connection.execute`. Raw-SQL executions done through the AR connection are therefore captured via the same subscriber without double-counting.

Constant Summary collapse

IGNORED_NAMES = 
[
  "SCHEMA", "EXPLAIN", "TRANSACTION", "SAVEPOINT", "RELEASE SAVEPOINT"
].freeze

Class Method Summary collapse

Class Method Details

.install! ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/allstak/integrations/active_record.rb', line 20

def self.install!
  return if @installed
  return unless defined?(::ActiveSupport::Notifications)

  ::ActiveSupport::Notifications.subscribe("sql.active_record") do |*args|
    begin
      event = ::ActiveSupport::Notifications::Event.new(*args)
      name = event.payload[:name].to_s
      sql  = event.payload[:sql].to_s
      next if sql.empty?
      next if IGNORED_NAMES.include?(name)
      next unless AllStak.initialized?

      client = AllStak.client
      config = client.config
      next unless config.capture_sql

      status = event.payload[:exception] ? "error" : "success"
      error_message = event.payload[:exception].is_a?(Array) ? event.payload[:exception].last.to_s : nil
      rows = event.payload[:row_count].to_i rescue -1

      db_name = nil
      db_type = nil
      if defined?(::ActiveRecord::Base) && ::ActiveRecord::Base.respond_to?(:connection_db_config)
        begin
          cfg = ::ActiveRecord::Base.connection_db_config
          db_name = cfg.database rescue nil
          db_type = cfg.adapter  rescue nil
        rescue
        end
      end

      client.database.record(
        sql: sql,
        duration_ms: event.duration.to_i,
        status: status,
        error_message: error_message,
        database_name: db_name,
        database_type: db_type,
        rows_affected: rows >= 0 ? rows : -1,
        trace_id: client.tracing.current_trace_id,
        span_id: client.tracing.current_span_id
      )

      # Query breadcrumb so the recent SQL trail lands on the next
      # captured exception in this thread. The SQL is truncated for the
      # breadcrumb message; value-pattern PII scrubbing still runs on the
      # wire path. Auto-gated via config.enable_auto_breadcrumbs.
      client.errors.add_breadcrumb(
        type: "query",
        message: sql.length > 300 ? "#{sql[0, 300]}…" : sql,
        level: status == "error" ? "error" : "info",
        data: {
          "name"       => name.empty? ? nil : name,
          "durationMs" => event.duration.to_i,
          "status"     => status,
          "db"         => db_name,
          "dbType"     => db_type
        }.reject { |_, v| v.nil? },
        auto: true
      )
    rescue => e
      # never raise into host
      AllStak.logger.debug("[AllStak] AR subscriber error: #{e.message}") rescue nil
    end
  end

  @installed = true
end

.installed? ⇒ Boolean

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/allstak/integrations/active_record.rb', line 90

def self.installed?
  @installed == true
end