summaryrefslogtreecommitdiff
path: root/config/initializers/lograge.rb
blob: a2c0fd5cd5c0d44a52a4fe15de7ad1362f892d55 (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
# Only use Lograge for Rails
unless Gitlab::Runtime.sidekiq?
  filename = File.join(Rails.root, 'log', "#{Rails.env}_json.log")

  Rails.application.configure do
    config.lograge.enabled = true
    # Store the lograge JSON files in a separate file
    config.lograge.keep_original_rails_log = true
    # Don't use the Logstash formatter since this requires logstash-event, an
    # unmaintained gem that monkey patches `Time`
    config.lograge.formatter = Lograge::Formatters::Json.new
    config.lograge.logger = ActiveSupport::Logger.new(filename)
    config.lograge.before_format = lambda do |data, payload|
      data.delete(:error)
      data
    end

    # This isn't a user-reachable controller; we use it to check for a
    # valid CSRF token in the API
    config.lograge.ignore_actions = ['Gitlab::RequestForgeryProtection::Controller#index']

    # Add request parameters to log output
    config.lograge.custom_options = lambda do |event|
      params = event.payload[:params]
        .except(*%w(controller action format))
        .each_pair
        .map { |k, v| { key: k, value: v } }

      payload = {
        time: Time.now.utc.iso8601(3),
        params: Gitlab::Utils::LogLimitedArray.log_limited_array(params, sentinel: { key: 'truncated', value: '...' }),
        remote_ip: event.payload[:remote_ip],
        user_id: event.payload[:user_id],
        username: event.payload[:username],
        ua: event.payload[:ua],
        queue_duration: event.payload[:queue_duration]
      }

      ::Gitlab::InstrumentationHelper.add_instrumentation_data(payload)

      payload[:response] = event.payload[:response] if event.payload[:response]
      payload[:etag_route] = event.payload[:etag_route] if event.payload[:etag_route]
      payload[Labkit::Correlation::CorrelationId::LOG_KEY] = Labkit::Correlation::CorrelationId.current_id

      if cpu_s = Gitlab::Metrics::System.thread_cpu_duration(::Gitlab::RequestContext.instance.start_thread_cpu_time)
        payload[:cpu_s] = cpu_s
      end

      # https://github.com/roidrage/lograge#logging-errors--exceptions
      exception = event.payload[:exception_object]

      ::Gitlab::ExceptionLogFormatter.format!(exception, payload)

      payload
    end
  end
end