summaryrefslogtreecommitdiff
path: root/spec/lib/gitlab/sidekiq_logging
diff options
context:
space:
mode:
authorSean McGivern <sean@gitlab.com>2019-01-18 16:21:38 +0000
committerSean McGivern <sean@gitlab.com>2019-01-22 10:54:12 +0000
commit9d2be75674c5d073bc8020a4ace1b7bff5bb16fb (patch)
tree4113b1ed5ce2322d96c033edfb720adb74d3ac81 /spec/lib/gitlab/sidekiq_logging
parent5e01cf72249725cb6e0c8aa3d28325d9b4942566 (diff)
downloadgitlab-ce-9d2be75674c5d073bc8020a4ace1b7bff5bb16fb.tar.gz
Limit Sidekiq args logging to 10 KB of JSON
When logging arguments from Sidekiq to JSON, restrict the size of `args` to 10 KB (when converted to JSON). This is to avoid blowing up with excessively large job payloads.
Diffstat (limited to 'spec/lib/gitlab/sidekiq_logging')
-rw-r--r--spec/lib/gitlab/sidekiq_logging/structured_logger_spec.rb31
1 files changed, 26 insertions, 5 deletions
diff --git a/spec/lib/gitlab/sidekiq_logging/structured_logger_spec.rb b/spec/lib/gitlab/sidekiq_logging/structured_logger_spec.rb
index f773f370ee2..a9d15f1d522 100644
--- a/spec/lib/gitlab/sidekiq_logging/structured_logger_spec.rb
+++ b/spec/lib/gitlab/sidekiq_logging/structured_logger_spec.rb
@@ -82,15 +82,36 @@ describe Gitlab::SidekiqLogging::StructuredLogger do
end.to raise_error(ArgumentError)
end
end
+
+ context 'when the job args are bigger than the maximum allowed' do
+ it 'keeps args from the front until they exceed the limit' do
+ Timecop.freeze(timestamp) do
+ job['args'] = [
+ 1,
+ 2,
+ 'a' * (described_class::MAXIMUM_JOB_ARGUMENTS_LENGTH / 2),
+ 'b' * (described_class::MAXIMUM_JOB_ARGUMENTS_LENGTH / 2),
+ 3
+ ]
+
+ expected_args = job['args'].take(3) + ['...']
+
+ expect(logger).to receive(:info).with(start_payload.merge('args' => expected_args)).ordered
+ expect(logger).to receive(:info).with(end_payload.merge('args' => expected_args)).ordered
+ expect(subject).to receive(:log_job_start).and_call_original
+ expect(subject).to receive(:log_job_done).and_call_original
+
+ subject.call(job, 'test_queue') { }
+ end
+ end
+ end
end
context 'with SIDEKIQ_LOG_ARGUMENTS disabled' do
- it 'logs start and end of job' do
+ it 'logs start and end of job without args' do
Timecop.freeze(timestamp) do
- start_payload.delete('args')
-
- expect(logger).to receive(:info).with(start_payload).ordered
- expect(logger).to receive(:info).with(end_payload).ordered
+ expect(logger).to receive(:info).with(start_payload.except('args')).ordered
+ expect(logger).to receive(:info).with(end_payload.except('args')).ordered
expect(subject).to receive(:log_job_start).and_call_original
expect(subject).to receive(:log_job_done).and_call_original