app/models/concerns/database_event_tracking.rb


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
50
51
52
53

# frozen_string_literal: true

module DatabaseEventTracking
  extend ActiveSupport::Concern

  included do
    after_create_commit :publish_database_create_event
    after_destroy_commit :publish_database_destroy_event
    after_update_commit :publish_database_update_event
  end

  def publish_database_create_event
    publish_database_event('create')
  end

  def publish_database_destroy_event
    publish_database_event('destroy')
  end

  def publish_database_update_event
    publish_database_event('update')
  end

  def publish_database_event(name)
    return unless Feature.enabled?(:product_intelligence_database_event_tracking)

    # Gitlab::Tracking#event is triggering Snowplow event
    # Snowplow events are sent with usage of
    # https://snowplow.github.io/snowplow-ruby-tracker/SnowplowTracker/AsyncEmitter.html
    # that reports data asynchronously and does not impact performance nor carries a risk of
    # rollback in case of error

    Gitlab::Tracking.event(
      self.class.to_s,
      "database_event_#{name}",
      label: self.class.table_name,
      namespace: try(:group) || try(:namespace),
      property: name,
      **filtered_record_attributes
    )
  rescue StandardError => err
    # this rescue should be a dead code due to utilization of AsyncEmitter, however
    # since this concern is expected to be included in every model, it is better to
    # prevent against any unexpected outcome
    Gitlab::ErrorTracking.track_and_raise_for_dev_exception(err)
  end

  def filtered_record_attributes
    attributes
      .with_indifferent_access
      .slice(*self.class::SNOWPLOW_ATTRIBUTES)
  end
end