summaryrefslogtreecommitdiff
path: root/lib/gitlab/sidekiq_logging/json_formatter.rb
blob: a6281bbdf26ad43f9a3ef917ca60b4bb4e939130 (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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# frozen_string_literal: true

# This is needed for sidekiq-cluster
require 'json'

module Gitlab
  module SidekiqLogging
    class JSONFormatter
      TIMESTAMP_FIELDS = %w[created_at scheduled_at enqueued_at started_at retried_at failed_at completed_at].freeze

      def call(severity, timestamp, progname, data)
        output = {
          severity: severity,
          time: timestamp.utc.iso8601(3)
        }

        case data
        when String
          output[:message] = data
        when Hash
          output.merge!(data)

          # jobstr is redundant and can include information we wanted to
          # exclude (like arguments)
          output.delete(:jobstr)

          convert_to_iso8601!(output)
          convert_retry_to_integer!(output)
          process_args!(output)
        end

        output.to_json + "\n"
      end

      private

      def convert_to_iso8601!(payload)
        TIMESTAMP_FIELDS.each do |key|
          value = payload[key]
          payload[key] = format_time(value) if value.present?
        end
      end

      def format_time(timestamp)
        return timestamp unless timestamp.is_a?(Numeric)

        Time.at(timestamp).utc.iso8601(3)
      end

      def convert_retry_to_integer!(payload)
        payload['retry'] =
          case payload['retry']
          when Integer
            payload['retry']
          when false, nil
            0
          when true
            Sidekiq::JobRetry::DEFAULT_MAX_RETRY_ATTEMPTS
          else
            -1
          end
      end

      def process_args!(payload)
        return unless payload['args']

        payload['args'] = Gitlab::ErrorTracking::Processor::SidekiqProcessor
                            .loggable_arguments(payload['args'], payload['class'])
      end
    end
  end
end