summaryrefslogtreecommitdiff
path: root/lib/gitlab/sidekiq_middleware/instrumentation_logger.rb
blob: b542aa4fe4c701c77b5ec82c85bdab1e0e81ea17 (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
# frozen_string_literal: true

module Gitlab
  module SidekiqMiddleware
    class InstrumentationLogger
      def self.keys
        @keys ||= [
          :cpu_s,
          :gitaly_calls,
          :gitaly_duration_s,
          :rugged_calls,
          :rugged_duration_s,
          :elasticsearch_calls,
          :elasticsearch_duration_s,
          :elasticsearch_timed_out_count,
          *::Gitlab::Memory::Instrumentation::KEY_MAPPING.values,
          *::Gitlab::Instrumentation::Redis.known_payload_keys,
          *::Gitlab::Metrics::Subscribers::ActiveRecord.known_payload_keys,
          *::Gitlab::Metrics::Subscribers::ExternalHttp::KNOWN_PAYLOAD_KEYS,
          *::Gitlab::Metrics::Subscribers::RackAttack::PAYLOAD_KEYS
        ]
      end

      def call(worker, job, queue)
        ::Gitlab::InstrumentationHelper.init_instrumentation_data

        yield

      ensure
        # The Sidekiq logger is called outside the middleware block, so
        # we need to modify the job hash to pass along this information
        # since RequestStore is only active in the Sidekiq middleware.
        #
        # Modifying the job hash in a middleware is permitted by Sidekiq
        # because Sidekiq keeps a pristine copy of the original hash
        # before sending it to the middleware:
        # https://github.com/mperham/sidekiq/blob/53bd529a0c3f901879925b8390353129c465b1f2/lib/sidekiq/processor.rb#L115-L118
        job[:instrumentation] = {}.tap do |instrumentation_values|
          ::Gitlab::InstrumentationHelper.add_instrumentation_data(instrumentation_values)
          instrumentation_values.slice!(*self.class.keys)
        end
      end
    end
  end
end