Module: NewRelic::Agent::Instrumentation::ActiveRecordHelper

Defined in:
lib/new_relic/agent/instrumentation/active_record_helper.rb

Defined Under Namespace

Modules: InstanceIdentification

Constant Summary collapse

ACTIVE_RECORD = 
'ActiveRecord'.freeze
OTHER = 
'other'.freeze
MAKARA_SUFFIX = 
'_makara'.freeze
SPACE = 
' '.freeze
OPERATION_NAMES =

These are used primarily to optimize and avoid allocation on well known operations coming in. Anything not matching the list is fine, it just needs to get downcased directly for use.

{
  'Find' => 'find',
  'Load' => 'find',
  'Count' => 'find',
  'Exists' => 'find',
  'Create' => 'create',
  'Columns' => 'columns',
  'Indexes' => 'indexes',
  'Destroy' => 'destroy',
  'Update' => 'update',
  'Save' => 'save'
}.freeze
PRODUCT_NAMES = 
{
  'mysql' => 'MySQL',
  'mysql2' => 'MySQL',

  'postgresql' => 'Postgres',

  'sqlite3' => 'SQLite',

  # https://rubygems.org/gems/trilogy
  'trilogy' => 'MySQL',

  # https://rubygems.org/gems/activerecord-jdbcpostgresql-adapter
  'jdbcmysql' => 'MySQL',

  # https://rubygems.org/gems/activerecord-jdbcpostgresql-adapter
  'jdbcpostgresql' => 'Postgres',

  # https://rubygems.org/gems/activerecord-postgis-adapter
  'postgis' => 'Postgres',

  # https://rubygems.org/gems/activerecord-jdbcsqlite3-adapter
  'jdbcsqlite3' => 'SQLite',

  # https://rubygems.org/gems/activerecord-jdbcderby-adapter
  'derby' => 'Derby',
  'jdbcderby' => 'Derby',

  # https://rubygems.org/gems/activerecord-jdbc-adapter
  'jdbc' => 'JDBC',

  # https://rubygems.org/gems/activerecord-jdbcmssql-adapter
  'jdbcmssql' => 'MSSQL',
  'mssql' => 'MSSQL',

  # https://rubygems.org/gems/activerecord-sqlserver-adapter
  'sqlserver' => 'MSSQL',

  # https://rubygems.org/gems/activerecord-odbc-adapter
  'odbc' => 'ODBC',

  # https://rubygems.org/gems/activerecord-oracle_enhanced-adapter
  'oracle_enhanced' => 'Oracle',

  # https://rubygems.org/gems/activerecord-amazon-timestream-adapter
  'amazon_timestream' => 'Timestream'
}.freeze
ACTIVE_RECORD_DEFAULT_PRODUCT_NAME = 
'ActiveRecord'.freeze

Class Method Summary collapse

Class Method Details

.bare_adapter_name(adapter_name) ⇒ Object

convert vendor (makara, etc.) wrapper names to their bare names ex: postgresql_makara -> postgresql



101
102
103
104
105
106
107
108
 
# File 'lib/new_relic/agent/instrumentation/active_record_helper.rb', line 101

def bare_adapter_name(adapter_name)
  # TODO: OLD RUBIES - RUBY_VERSION < 2.5
  # With Ruby 2.5+ we could use #delete_suffix instead of #chomp for a
  # potential speed boost
  return adapter_name.chomp(MAKARA_SUFFIX) if adapter_name&.end_with?(MAKARA_SUFFIX)

  adapter_name
end

.instrument_additional_methods ⇒ Object

Used by both the AR 3.x and 4.x instrumentation



15
16
17
18
 
# File 'lib/new_relic/agent/instrumentation/active_record_helper.rb', line 15

def instrument_additional_methods
  instrument_save_methods
  instrument_relation_methods
end

.instrument_relation_methods ⇒ Object 



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
89
90
91
92
93
 
# File 'lib/new_relic/agent/instrumentation/active_record_helper.rb', line 40

def instrument_relation_methods
  ::ActiveRecord::Relation.class_eval do
    alias_method(:update_all_without_newrelic, :update_all)

    def update_all(*args, &blk)
      ::NewRelic::Agent.with_database_metric_name(self.name, nil, ACTIVE_RECORD) do
        update_all_without_newrelic(*args, &blk)
      end
    end

    alias_method(:delete_all_without_newrelic, :delete_all)

    if RUBY_VERSION < '2.7.0'
      def delete_all(*args, &blk)
        ::NewRelic::Agent.with_database_metric_name(self.name, nil, ACTIVE_RECORD) do
          delete_all_without_newrelic(*args, &blk)
        end
      end
    else
      def delete_all(*args, **kwargs, &blk)
        ::NewRelic::Agent.with_database_metric_name(self.name, nil, ACTIVE_RECORD) do
          delete_all_without_newrelic(*args, **kwargs, &blk)
        end
      end
    end

    alias_method(:destroy_all_without_newrelic, :destroy_all)

    def destroy_all(*args, &blk)
      ::NewRelic::Agent.with_database_metric_name(self.name, nil, ACTIVE_RECORD) do
        destroy_all_without_newrelic(*args, &blk)
      end
    end

    alias_method(:calculate_without_newrelic, :calculate)

    def calculate(*args, &blk)
      ::NewRelic::Agent.with_database_metric_name(self.name, nil, ACTIVE_RECORD) do
        calculate_without_newrelic(*args, &blk)
      end
    end

    if method_defined?(:pluck)
      alias_method(:pluck_without_newrelic, :pluck)

      def pluck(*args, &blk)
        ::NewRelic::Agent.with_database_metric_name(self.name, nil, ACTIVE_RECORD) do
          pluck_without_newrelic(*args, &blk)
        end
      end

    end
  end
end

.instrument_save_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/new_relic/agent/instrumentation/active_record_helper.rb', line 20

def instrument_save_methods
  ::ActiveRecord::Base.class_eval do
    alias_method(:save_without_newrelic, :save)

    def save(*args, &blk)
      ::NewRelic::Agent.with_database_metric_name(self.class.name, nil, ACTIVE_RECORD) do
        save_without_newrelic(*args, &blk)
      end
    end

    alias_method(:save_without_newrelic!, :save!)

    def save!(*args, &blk)
      ::NewRelic::Agent.with_database_metric_name(self.class.name, nil, ACTIVE_RECORD) do
        save_without_newrelic!(*args, &blk)
      end
    end
  end
end

.map_operation(raw_operation) ⇒ Object 



158
159
160
161
162
163
 
# File 'lib/new_relic/agent/instrumentation/active_record_helper.rb', line 158

def map_operation(raw_operation)
  direct_op = OPERATION_NAMES[raw_operation]
  return direct_op if direct_op

  raw_operation.downcase
end

.map_product(adapter_name) ⇒ Object 



214
215
216
 
# File 'lib/new_relic/agent/instrumentation/active_record_helper.rb', line 214

def map_product(adapter_name)
  PRODUCT_NAMES.fetch(adapter_name, ACTIVE_RECORD_DEFAULT_PRODUCT_NAME)
end

.model_from_splits(splits) ⇒ Object 



128
129
130
131
132
 
# File 'lib/new_relic/agent/instrumentation/active_record_helper.rb', line 128

def model_from_splits(splits)
  if splits.length == 2
    splits.first
  end
end

.operation_from_splits(splits, sql) ⇒ Object 



134
135
136
137
138
139
140
 
# File 'lib/new_relic/agent/instrumentation/active_record_helper.rb', line 134

def operation_from_splits(splits, sql)
  if splits.length == 2
    map_operation(splits[1])
  else
    NewRelic::Agent::Database.parse_operation_from_query(sql) || OTHER
  end
end

.product_operation_collection_for(name, sql, adapter_name) ⇒ Object 



110
111
112
113
114
115
116
 
# File 'lib/new_relic/agent/instrumentation/active_record_helper.rb', line 110

def product_operation_collection_for(name, sql, adapter_name)
  product = map_product(bare_adapter_name(adapter_name))
  splits = split_name(name)
  model = model_from_splits(splits)
  operation = operation_from_splits(splits, sql)
  NewRelic::Agent::Datastores::MetricHelper.product_operation_collection_for(product, operation, model, ACTIVE_RECORD)
end

.split_name(name) ⇒ Object 



120
121
122
123
124
125
126
 
# File 'lib/new_relic/agent/instrumentation/active_record_helper.rb', line 120

def split_name(name)
  if name&.respond_to?(:split)
    name.split(SPACE)
  else
    NewRelic::EMPTY_ARRAY
  end
end