Module: Datadog::Contrib::ActiveRecord::Events::SQL

Includes:
Datadog::Contrib::ActiveRecord::Event
Defined in:
lib/ddtrace/contrib/active_record/events/sql.rb

Overview

Defines instrumentation for sql.active_record event

Constant Summary collapse

EVENT_NAME = 
'sql.active_record'.freeze
PAYLOAD_CACHE = 
'CACHE'.freeze

Class Method Summary collapse

Methods included from Datadog::Contrib::ActiveRecord::Event

included

Class Method Details

.event_name ⇒ Object 



21
22
23
 
# File 'lib/ddtrace/contrib/active_record/events/sql.rb', line 21

def event_name
  self::EVENT_NAME
end

.process(span, event, _id, payload) ⇒ Object 



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
 
# File 'lib/ddtrace/contrib/active_record/events/sql.rb', line 29

def process(span, event, _id, payload)
  config = Utils.connection_config(payload[:connection], payload[:connection_id])
  settings = Datadog.configuration[:active_record, config]
  adapter_name = Datadog::Utils::Database.normalize_vendor(config[:adapter])
  service_name = if settings.service_name != Datadog::Utils::Database::VENDOR_DEFAULT
                   settings.service_name
                 else
                   adapter_name
                 end

  span.name = "#{adapter_name}.query"
  span.service = service_name
  span.resource = payload.fetch(:sql)
  span.span_type = Datadog::Ext::SQL::TYPE

  # Tag as an external peer service
  span.set_tag(Datadog::Ext::Integration::TAG_PEER_SERVICE, span.service)

  # Set analytics sample rate
  if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
    Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
  end

  # Find out if the SQL query has been cached in this request. This meta is really
  # helpful to users because some spans may have 0ns of duration because the query
  # is simply cached from memory, so the notification is fired with start == finish.
  cached = payload[:cached] || (payload[:name] == PAYLOAD_CACHE)

  span.set_tag(Ext::TAG_DB_VENDOR, adapter_name)
  span.set_tag(Ext::TAG_DB_NAME, config[:database])
  span.set_tag(Ext::TAG_DB_CACHED, cached) if cached
  span.set_tag(Datadog::Ext::NET::TARGET_HOST, config[:host]) if config[:host]
  span.set_tag(Datadog::Ext::NET::TARGET_PORT, config[:port]) if config[:port]
rescue StandardError => e
  Datadog.logger.debug(e.message)
end

.span_name ⇒ Object 



25
26
27
 
# File 'lib/ddtrace/contrib/active_record/events/sql.rb', line 25

def span_name
  Ext::SPAN_SQL
end