Add structured logging for Rails processes
This introduces JSON logging for Rails views saved to a file called
`development_json.log`, `production_json.log`, etc.
For example, instead of this unparsable log:
```
Started GET "/" for 127.0.0.1 at 2012-03-10 14:28:14 +0100
Processing by HomeController#index as HTML
Rendered text template within layouts/application (0.0ms)
Rendered layouts/_assets.html.erb (2.0ms)
Rendered layouts/_top.html.erb (2.6ms)
Rendered layouts/_about.html.erb (0.3ms)
Rendered layouts/_google_analytics.html.erb (0.4ms)
Completed 200 OK in 79ms (Views: 78.8ms | ActiveRecord: 0.0ms)
```
We get a single line with this:
```
{"method":"GET","path":"/,"format":"html","controller":"HomeController","action":"index","status":200,"duration":79,"view":78.8,"db":0.0,"location":"http://localhost/","time":"2017-07-18 09:35:17 -0700"}
```
Part of #20060
2017-07-17 22:54:13 +00:00
|
|
|
# Only use Lograge for Rails
|
|
|
|
unless Sidekiq.server?
|
|
|
|
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)
|
|
|
|
# Add request parameters to log output
|
|
|
|
config.lograge.custom_options = lambda do |event|
|
2018-02-28 15:45:41 +00:00
|
|
|
params = event.payload[:params]
|
|
|
|
.except(*%w(controller action format))
|
|
|
|
.each_pair
|
|
|
|
.map { |k, v| { key: k, value: v } }
|
|
|
|
|
2017-09-19 10:55:37 +00:00
|
|
|
payload = {
|
2019-06-25 17:54:42 +00:00
|
|
|
time: Time.now.utc.iso8601(3),
|
2018-02-28 15:45:41 +00:00
|
|
|
params: params,
|
2017-07-28 05:48:03 +00:00
|
|
|
remote_ip: event.payload[:remote_ip],
|
|
|
|
user_id: event.payload[:user_id],
|
2018-09-05 21:40:36 +00:00
|
|
|
username: event.payload[:username],
|
2019-02-11 00:43:44 +00:00
|
|
|
ua: event.payload[:ua],
|
|
|
|
queue_duration: event.payload[:queue_duration]
|
Add structured logging for Rails processes
This introduces JSON logging for Rails views saved to a file called
`development_json.log`, `production_json.log`, etc.
For example, instead of this unparsable log:
```
Started GET "/" for 127.0.0.1 at 2012-03-10 14:28:14 +0100
Processing by HomeController#index as HTML
Rendered text template within layouts/application (0.0ms)
Rendered layouts/_assets.html.erb (2.0ms)
Rendered layouts/_top.html.erb (2.6ms)
Rendered layouts/_about.html.erb (0.3ms)
Rendered layouts/_google_analytics.html.erb (0.4ms)
Completed 200 OK in 79ms (Views: 78.8ms | ActiveRecord: 0.0ms)
```
We get a single line with this:
```
{"method":"GET","path":"/,"format":"html","controller":"HomeController","action":"index","status":200,"duration":79,"view":78.8,"db":0.0,"location":"http://localhost/","time":"2017-07-18 09:35:17 -0700"}
```
Part of #20060
2017-07-17 22:54:13 +00:00
|
|
|
}
|
2017-09-19 10:55:37 +00:00
|
|
|
|
|
|
|
gitaly_calls = Gitlab::GitalyClient.get_request_count
|
2019-03-27 10:56:36 +00:00
|
|
|
|
|
|
|
if gitaly_calls > 0
|
|
|
|
payload[:gitaly_calls] = gitaly_calls
|
|
|
|
payload[:gitaly_duration] = Gitlab::GitalyClient.query_time_ms
|
|
|
|
end
|
|
|
|
|
2019-07-17 23:34:27 +00:00
|
|
|
rugged_calls = Gitlab::RuggedInstrumentation.query_count
|
|
|
|
|
|
|
|
if rugged_calls > 0
|
|
|
|
payload[:rugged_calls] = rugged_calls
|
|
|
|
payload[:rugged_duration_ms] = Gitlab::RuggedInstrumentation.query_time_ms
|
|
|
|
end
|
|
|
|
|
2018-06-06 07:47:53 +00:00
|
|
|
payload[:response] = event.payload[:response] if event.payload[:response]
|
2019-02-18 20:57:22 +00:00
|
|
|
payload[Labkit::Correlation::CorrelationId::LOG_KEY] = Labkit::Correlation::CorrelationId.current_id
|
2017-09-19 10:55:37 +00:00
|
|
|
|
|
|
|
payload
|
Add structured logging for Rails processes
This introduces JSON logging for Rails views saved to a file called
`development_json.log`, `production_json.log`, etc.
For example, instead of this unparsable log:
```
Started GET "/" for 127.0.0.1 at 2012-03-10 14:28:14 +0100
Processing by HomeController#index as HTML
Rendered text template within layouts/application (0.0ms)
Rendered layouts/_assets.html.erb (2.0ms)
Rendered layouts/_top.html.erb (2.6ms)
Rendered layouts/_about.html.erb (0.3ms)
Rendered layouts/_google_analytics.html.erb (0.4ms)
Completed 200 OK in 79ms (Views: 78.8ms | ActiveRecord: 0.0ms)
```
We get a single line with this:
```
{"method":"GET","path":"/,"format":"html","controller":"HomeController","action":"index","status":200,"duration":79,"view":78.8,"db":0.0,"location":"http://localhost/","time":"2017-07-18 09:35:17 -0700"}
```
Part of #20060
2017-07-17 22:54:13 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|