summaryrefslogtreecommitdiff
path: root/lib/gitlab/tracing/rails/active_record_subscriber.rb
blob: 32f5658e57e5ae70bd6835342b34a633102f4cf3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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
# frozen_string_literal: true

module Gitlab
  module Tracing
    module Rails
      class ActiveRecordSubscriber
        include RailsCommon

        ACTIVE_RECORD_NOTIFICATION_TOPIC = 'sql.active_record'
        OPERATION_NAME_PREFIX = 'active_record:'
        DEFAULT_OPERATION_NAME = 'sqlquery'

        # Instruments Rails ActiveRecord events for opentracing.
        # Returns a lambda, which, when called will unsubscribe from the notifications
        def self.instrument
          subscriber = new

          subscription = ActiveSupport::Notifications.subscribe(ACTIVE_RECORD_NOTIFICATION_TOPIC) do |_, start, finish, _, payload|
            subscriber.notify(start, finish, payload)
          end

          create_unsubscriber [subscription]
        end

        # For more information on the payloads: https://guides.rubyonrails.org/active_support_instrumentation.html
        def notify(start, finish, payload)
          generate_span_for_notification(notification_name(payload), start, finish, payload, tags_for_notification(payload))
        end

        private

        def notification_name(payload)
          OPERATION_NAME_PREFIX + (payload[:name].presence || DEFAULT_OPERATION_NAME)
        end

        def tags_for_notification(payload)
          {
            'component' =>        'ActiveRecord',
            'span.kind' =>        'client',
            'db.type' =>          'sql',
            'db.connection_id' => payload[:connection_id],
            'db.cached' =>        payload[:cached] || false,
            'db.statement' =>     payload[:sql]
          }
        end
      end
    end
  end
end