From 3560b11922fd180eea5cafd0e763e0e601c5c4ee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kamil=20Trzci=C5=84ski?= Date: Thu, 6 Dec 2018 20:49:31 +0100 Subject: Prefer to use correlation-id in logs This changes `correlation_id` to be `correlation-id` when passed via jobs --- spec/controllers/application_controller_spec.rb | 2 +- spec/initializers/lograge_spec.rb | 6 +++--- spec/lib/gitlab/json_logger_spec.rb | 4 ++-- spec/lib/gitlab/sidekiq_logging/structured_logger_spec.rb | 2 +- spec/lib/gitlab/sidekiq_middleware/correlation_injector_spec.rb | 2 +- spec/lib/gitlab/sidekiq_middleware/correlation_logger_spec.rb | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) (limited to 'spec') diff --git a/spec/controllers/application_controller_spec.rb b/spec/controllers/application_controller_spec.rb index c2bd7fd9808..20217e2b67f 100644 --- a/spec/controllers/application_controller_spec.rb +++ b/spec/controllers/application_controller_spec.rb @@ -465,7 +465,7 @@ describe ApplicationController do get :index end - expect(controller.last_payload).to include('correlation_id' => 'new-id') + expect(controller.last_payload).to include('correlation-id' => 'new-id') end context '422 errors' do diff --git a/spec/initializers/lograge_spec.rb b/spec/initializers/lograge_spec.rb index af54a777373..bf5dde7fe66 100644 --- a/spec/initializers/lograge_spec.rb +++ b/spec/initializers/lograge_spec.rb @@ -11,7 +11,7 @@ describe 'lograge', type: :request do it 'logs to api_json log' do # we assert receiving parameters by grape logger expect_any_instance_of(Gitlab::GrapeLogging::Formatters::LogrageWithTimestamp).to receive(:call) - .with(anything, anything, anything, a_hash_including("correlation_id" => "new-correlation-id")) + .with(anything, anything, anything, a_hash_including("correlation-id" => "new-correlation-id")) .and_call_original subject @@ -24,12 +24,12 @@ describe 'lograge', type: :request do it 'logs to production_json log' do # formatter receives a hash with correlation id expect(Lograge.formatter).to receive(:call) - .with(a_hash_including("correlation_id" => "new-correlation-id")) + .with(a_hash_including("correlation-id" => "new-correlation-id")) .and_call_original # a log file receives a line with correlation id expect(Lograge.logger).to receive(:send) - .with(anything, include('"correlation_id":"new-correlation-id"')) + .with(anything, include('"correlation-id":"new-correlation-id"')) .and_call_original subject diff --git a/spec/lib/gitlab/json_logger_spec.rb b/spec/lib/gitlab/json_logger_spec.rb index cff7dd58c8c..706601fe98f 100644 --- a/spec/lib/gitlab/json_logger_spec.rb +++ b/spec/lib/gitlab/json_logger_spec.rb @@ -18,7 +18,7 @@ describe Gitlab::JsonLogger do expect(data['severity']).to eq('INFO') expect(data['time']).to eq(now.utc.iso8601(3)) expect(data['message']).to eq('Hello world') - expect(data['correlation_id']).to eq('new-correlation-id') + expect(data['correlation-id']).to eq('new-correlation-id') end it 'formats hashes' do @@ -29,7 +29,7 @@ describe Gitlab::JsonLogger do expect(data['time']).to eq(now.utc.iso8601(3)) expect(data['hello']).to eq(1) expect(data['message']).to be_nil - expect(data['correlation_id']).to eq('new-correlation-id') + expect(data['correlation-id']).to eq('new-correlation-id') end end end diff --git a/spec/lib/gitlab/sidekiq_logging/structured_logger_spec.rb b/spec/lib/gitlab/sidekiq_logging/structured_logger_spec.rb index f773f370ee2..7484593268c 100644 --- a/spec/lib/gitlab/sidekiq_logging/structured_logger_spec.rb +++ b/spec/lib/gitlab/sidekiq_logging/structured_logger_spec.rb @@ -13,7 +13,7 @@ describe Gitlab::SidekiqLogging::StructuredLogger do "jid" => "da883554ee4fe414012f5f42", "created_at" => timestamp.to_f, "enqueued_at" => timestamp.to_f, - "correlation_id" => 'cid' + "correlation-id" => 'cid' } end let(:logger) { double() } diff --git a/spec/lib/gitlab/sidekiq_middleware/correlation_injector_spec.rb b/spec/lib/gitlab/sidekiq_middleware/correlation_injector_spec.rb index a138ad7c910..291e0624e96 100644 --- a/spec/lib/gitlab/sidekiq_middleware/correlation_injector_spec.rb +++ b/spec/lib/gitlab/sidekiq_middleware/correlation_injector_spec.rb @@ -37,7 +37,7 @@ describe Gitlab::SidekiqMiddleware::CorrelationInjector do expected_job_params = { "class" => "TestWorker", "args" => [1234], - "correlation_id" => "new-correlation-id" + "correlation-id" => "new-correlation-id" } expect(Sidekiq::Queues.jobs_by_worker).to a_hash_including( diff --git a/spec/lib/gitlab/sidekiq_middleware/correlation_logger_spec.rb b/spec/lib/gitlab/sidekiq_middleware/correlation_logger_spec.rb index 94ae4ffa184..35696286218 100644 --- a/spec/lib/gitlab/sidekiq_middleware/correlation_logger_spec.rb +++ b/spec/lib/gitlab/sidekiq_middleware/correlation_logger_spec.rb @@ -30,6 +30,6 @@ describe Gitlab::SidekiqMiddleware::CorrelationLogger do 'queue' => 'test', 'class' => TestWorker, 'args' => [1234], - 'correlation_id' => 'new-correlation-id') + 'correlation-id' => 'new-correlation-id') end end -- cgit v1.2.1