kotovalexarian-likes-gitlab
/
gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Show backtrace when logging to kubernetes.log 

Just the error message and error class alone makes it hard to determine
the full context of any errors, so we need to know where the error is
occuring as well.
This commit is contained in:
Thong Kuah 2019-03-04 16:28:28 +13:00
parent d0a0d3d3d5
commit 5eb2d6ea02
6 changed files with 31 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
app/services/clusters/applications/base_helm_service.rb
View File

@ -19,7 +19,8 @@ module Clusters
app_id: app.id,
project_ids: app.cluster.project_ids,
group_ids: app.cluster.group_ids,
message: error.message
message: error.message,
backtrace: Gitlab::Profiler.clean_backtrace(error.backtrace)
}
logger.error(meta)

5
changelogs/unreleased/add_backtrace_to_kubernetes_log.yml Normal file
View File

@ -0,0 +1,5 @@
---
title: Show error backtrace when logging errors to kubernetes.log
merge_request: 25726
author:
type: other

9
spec/services/clusters/applications/check_installation_progress_service_spec.rb
View File

@ -36,6 +36,7 @@ describe Clusters::Applications::CheckInstallationProgressService, '#execute' do
shared_examples 'error logging' do
context 'when installation raises a Kubeclient::HttpError' do
let(:cluster) { create(:cluster, :provided_by_user, :project) }
let(:logger) { service.send(:logger) }
before do
application.update!(cluster: cluster)
@ -51,7 +52,13 @@ describe Clusters::Applications::CheckInstallationProgressService, '#execute' do
end
it 'should log error' do
expect(service.send(:logger)).to receive(:error)
expect(logger).to receive(:error)
service.execute
end
it 'logs error backtrace' do
expect(logger).to receive(:error).with(hash_including(backtrace: instance_of(Array)))
service.execute
end

12
spec/services/clusters/applications/install_service_spec.rb
View File

@ -51,6 +51,7 @@ describe Clusters::Applications::InstallService do
{
exception: 'Kubeclient::HttpError',
message: 'system failure',
backtrace: instance_of(Array),
service: 'Clusters::Applications::InstallService',
app_id: application.id,
project_ids: application.cluster.project_ids,
@ -61,15 +62,16 @@ describe Clusters::Applications::InstallService do
expect(Gitlab::Sentry).to receive(:track_acceptable_exception).with(
error,
extra: {
extra: hash_including(
exception: 'Kubeclient::HttpError',
message: 'system failure',
backtrace: instance_of(Array),
service: 'Clusters::Applications::InstallService',
app_id: application.id,
project_ids: application.cluster.project_ids,
group_ids: [],
error_code: 500
}
)
)
service.execute
@ -99,6 +101,7 @@ describe Clusters::Applications::InstallService do
exception: 'StandardError',
error_code: nil,
message: 'something bad happened',
backtrace: instance_of(Array),
service: 'Clusters::Applications::InstallService',
app_id: application.id,
project_ids: application.cluster.projects.pluck(:id),
@ -108,15 +111,16 @@ describe Clusters::Applications::InstallService do
expect(Gitlab::Sentry).to receive(:track_acceptable_exception).with(
error,
extra: {
extra: hash_including(
exception: 'StandardError',
error_code: nil,
message: 'something bad happened',
backtrace: instance_of(Array),
service: 'Clusters::Applications::InstallService',
app_id: application.id,
project_ids: application.cluster.projects.pluck(:id),
group_ids: []
}
)
)
service.execute

4
spec/services/clusters/applications/patch_service_spec.rb
View File

@ -53,6 +53,7 @@ describe Clusters::Applications::PatchService do
{
exception: 'Kubeclient::HttpError',
message: 'system failure',
backtrace: instance_of(Array),
service: 'Clusters::Applications::PatchService',
app_id: application.id,
project_ids: application.cluster.project_ids,
@ -66,6 +67,7 @@ describe Clusters::Applications::PatchService do
extra: {
exception: 'Kubeclient::HttpError',
message: 'system failure',
backtrace: instance_of(Array),
service: 'Clusters::Applications::PatchService',
app_id: application.id,
project_ids: application.cluster.project_ids,
@ -101,6 +103,7 @@ describe Clusters::Applications::PatchService do
exception: 'StandardError',
error_code: nil,
message: 'something bad happened',
backtrace: instance_of(Array),
service: 'Clusters::Applications::PatchService',
app_id: application.id,
project_ids: application.cluster.projects.pluck(:id),
@ -114,6 +117,7 @@ describe Clusters::Applications::PatchService do
exception: 'StandardError',
error_code: nil,
message: 'something bad happened',
backtrace: instance_of(Array),
service: 'Clusters::Applications::PatchService',
app_id: application.id,
project_ids: application.cluster.projects.pluck(:id),

4
spec/services/clusters/applications/upgrade_service_spec.rb
View File

@ -53,6 +53,7 @@ describe Clusters::Applications::UpgradeService do
{
exception: 'Kubeclient::HttpError',
message: 'system failure',
backtrace: instance_of(Array),
service: 'Clusters::Applications::UpgradeService',
app_id: application.id,
project_ids: application.cluster.project_ids,
@ -66,6 +67,7 @@ describe Clusters::Applications::UpgradeService do
extra: {
exception: 'Kubeclient::HttpError',
message: 'system failure',
backtrace: instance_of(Array),
service: 'Clusters::Applications::UpgradeService',
app_id: application.id,
project_ids: application.cluster.project_ids,
@ -101,6 +103,7 @@ describe Clusters::Applications::UpgradeService do
exception: 'StandardError',
error_code: nil,
message: 'something bad happened',
backtrace: instance_of(Array),
service: 'Clusters::Applications::UpgradeService',
app_id: application.id,
project_ids: application.cluster.projects.pluck(:id),
@ -114,6 +117,7 @@ describe Clusters::Applications::UpgradeService do
exception: 'StandardError',
error_code: nil,
message: 'something bad happened',
backtrace: instance_of(Array),
service: 'Clusters::Applications::UpgradeService',
app_id: application.id,
project_ids: application.cluster.projects.pluck(:id),