Commit f519cec2 authored by GitLab Bot's avatar GitLab Bot

Add latest changes from gitlab-org/gitlab@master

parent 157f9a45
---
title: Notify user when over 1000 epics in roadmap
merge_request: 19419
author:
type: added
---
title: Flatten exception details in API and controller logs
merge_request: 20434
author:
type: changed
...@@ -44,16 +44,7 @@ unless Sidekiq.server? ...@@ -44,16 +44,7 @@ unless Sidekiq.server?
# https://github.com/roidrage/lograge#logging-errors--exceptions # https://github.com/roidrage/lograge#logging-errors--exceptions
exception = event.payload[:exception_object] exception = event.payload[:exception_object]
if exception ::Gitlab::ExceptionLogFormatter.format!(exception, payload)
payload[:exception] = {
class: exception.class.name,
message: exception.message
}
if exception.backtrace
payload[:exception][:backtrace] = Gitlab::Profiler.clean_backtrace(exception.backtrace)
end
end
payload payload
end end
......
...@@ -67,20 +67,18 @@ NOTE: **Note:** Starting with GitLab 12.5, if an error occurs, an ...@@ -67,20 +67,18 @@ NOTE: **Note:** Starting with GitLab 12.5, if an error occurs, an
"queue_duration": 274.35, "queue_duration": 274.35,
"correlation_id": "KjDVUhNvvV3", "correlation_id": "KjDVUhNvvV3",
"cpu_s": 2.837645135999999, "cpu_s": 2.837645135999999,
"exception": { "exception.class": "NameError",
"class": "NameError", "exception.message": "undefined local variable or method `adsf' for #<Admin::DashboardController:0x00007ff3c9648588>",
"message": "undefined local variable or method `adsf' for #<Admin::DashboardController:0x00007ff3c9648588>", "exception.backtrace": [
"backtrace": [ "app/controllers/admin/dashboard_controller.rb:11:in `index'",
"app/controllers/admin/dashboard_controller.rb:11:in `index'", "ee/app/controllers/ee/admin/dashboard_controller.rb:14:in `index'",
"ee/app/controllers/ee/admin/dashboard_controller.rb:14:in `index'", "ee/lib/gitlab/ip_address_state.rb:10:in `with'",
"ee/lib/gitlab/ip_address_state.rb:10:in `with'", "ee/app/controllers/ee/application_controller.rb:43:in `set_current_ip_address'",
"ee/app/controllers/ee/application_controller.rb:43:in `set_current_ip_address'", "lib/gitlab/session.rb:11:in `with_session'",
"lib/gitlab/session.rb:11:in `with_session'", "app/controllers/application_controller.rb:450:in `set_session_storage'",
"app/controllers/application_controller.rb:450:in `set_session_storage'", "app/controllers/application_controller.rb:444:in `set_locale'",
"app/controllers/application_controller.rb:444:in `set_locale'", "ee/lib/gitlab/jira/middleware.rb:19:in `call'"
"ee/lib/gitlab/jira/middleware.rb:19:in `call'" ]
]
}
} }
``` ```
......
# frozen_string_literal: true
module Gitlab
module ExceptionLogFormatter
def self.format!(exception, payload)
return unless exception
# Elasticsearch/Fluentd don't handle nested structures well.
# Use periods to flatten the fields.
payload.merge!(
'exception.class' => exception.class.name,
'exception.message' => exception.message
)
if exception.backtrace
payload['exception.backtrace'] = Gitlab::Profiler.clean_backtrace(exception.backtrace)
end
end
end
end
...@@ -11,19 +11,11 @@ module Gitlab ...@@ -11,19 +11,11 @@ module Gitlab
# precedence so the logger never sees it. We need to # precedence so the logger never sees it. We need to
# store and retrieve the exception from the environment. # store and retrieve the exception from the environment.
exception = request.env[::API::Helpers::API_EXCEPTION_ENV] exception = request.env[::API::Helpers::API_EXCEPTION_ENV]
data = {}
return {} unless exception.is_a?(Exception) return data unless exception.is_a?(Exception)
data = { Gitlab::ExceptionLogFormatter.format!(exception, data)
exception: {
class: exception.class.to_s,
message: exception.message
}
}
if exception.backtrace
data[:exception][:backtrace] = Gitlab::Profiler.clean_backtrace(exception.backtrace)
end
data data
end end
......
...@@ -15989,6 +15989,9 @@ msgstr "" ...@@ -15989,6 +15989,9 @@ msgstr ""
msgid "Some email servers do not support overriding the email sender name. Enable this option to include the name of the author of the issue, merge request or comment in the email body instead." msgid "Some email servers do not support overriding the email sender name. Enable this option to include the name of the author of the issue, merge request or comment in the email body instead."
msgstr "" msgstr ""
msgid "Some of your epics may not be visible. A roadmap is limited to the first 1,000 epics, in your selected sort order."
msgstr ""
msgid "Someone edited the issue at the same time you did. Please check out %{linkStart}the issue%{linkEnd} and make sure your changes will not unintentionally remove theirs." msgid "Someone edited the issue at the same time you did. Please check out %{linkStart}the issue%{linkEnd} and make sure your changes will not unintentionally remove theirs."
msgstr "" msgstr ""
......
...@@ -110,9 +110,9 @@ describe 'lograge', type: :request do ...@@ -110,9 +110,9 @@ describe 'lograge', type: :request do
log_data = JSON.parse(log_output.string) log_data = JSON.parse(log_output.string)
expect(log_data['exception']['class']).to eq('RuntimeError') expect(log_data['exception.class']).to eq('RuntimeError')
expect(log_data['exception']['message']).to eq('bad request') expect(log_data['exception.message']).to eq('bad request')
expect(log_data['exception']['backtrace']).to eq(Gitlab::Profiler.clean_backtrace(backtrace)) expect(log_data['exception.backtrace']).to eq(Gitlab::Profiler.clean_backtrace(backtrace))
end end
end end
end end
......
...@@ -24,10 +24,8 @@ describe Gitlab::GrapeLogging::Loggers::ExceptionLogger do ...@@ -24,10 +24,8 @@ describe Gitlab::GrapeLogging::Loggers::ExceptionLogger do
let(:expected) do let(:expected) do
{ {
exception: { 'exception.class' => 'RuntimeError',
class: 'RuntimeError', 'exception.message' => 'This is a test'
message: 'This is a test'
}
} }
end end
...@@ -39,7 +37,7 @@ describe Gitlab::GrapeLogging::Loggers::ExceptionLogger do ...@@ -39,7 +37,7 @@ describe Gitlab::GrapeLogging::Loggers::ExceptionLogger do
before do before do
current_backtrace = caller current_backtrace = caller
allow(exception).to receive(:backtrace).and_return(current_backtrace) allow(exception).to receive(:backtrace).and_return(current_backtrace)
expected[:exception][:backtrace] = Gitlab::Profiler.clean_backtrace(current_backtrace) expected['exception.backtrace'] = Gitlab::Profiler.clean_backtrace(current_backtrace)
end end
it 'includes the backtrace' do it 'includes the backtrace' do
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment