debian-mirror-gitlab/spec/lib/gitlab/instrumentation_helper_spec.rb

214 lines
7.2 KiB
Ruby
Raw Normal View History

2019-12-26 22:10:19 +05:30
# frozen_string_literal: true
2020-04-22 19:07:51 +05:30
require 'spec_helper'
2019-12-26 22:10:19 +05:30
require 'rspec-parameterized'
2020-07-28 23:09:34 +05:30
RSpec.describe Gitlab::InstrumentationHelper do
2019-12-26 22:10:19 +05:30
using RSpec::Parameterized::TableSyntax
2020-04-22 19:07:51 +05:30
describe '.add_instrumentation_data', :request_store do
let(:payload) { {} }
subject { described_class.add_instrumentation_data(payload) }
2021-03-11 19:13:27 +05:30
before do
described_class.init_instrumentation_data
end
it 'includes DB counts' do
2020-04-22 19:07:51 +05:30
subject
2021-03-11 19:13:27 +05:30
expect(payload).to include(db_count: 0, db_cached_count: 0, db_write_count: 0)
2020-04-22 19:07:51 +05:30
end
context 'when Gitaly calls are made' do
it 'adds Gitaly data and omits Redis data' do
project = create(:project)
RequestStore.clear!
project.repository.exists?
subject
expect(payload[:gitaly_calls]).to eq(1)
expect(payload[:gitaly_duration_s]).to be >= 0
expect(payload[:redis_calls]).to be_nil
expect(payload[:redis_duration_ms]).to be_nil
end
end
context 'when Redis calls are made' do
it 'adds Redis data and omits Gitaly data' do
2020-06-23 00:09:42 +05:30
Gitlab::Redis::Cache.with { |redis| redis.set('test-cache', 123) }
Gitlab::Redis::Queues.with { |redis| redis.set('test-queues', 321) }
2020-04-22 19:07:51 +05:30
subject
2020-06-23 00:09:42 +05:30
# Aggregated payload
expect(payload[:redis_calls]).to eq(2)
2020-04-22 19:07:51 +05:30
expect(payload[:redis_duration_s]).to be >= 0
2020-06-23 00:09:42 +05:30
expect(payload[:redis_read_bytes]).to be >= 0
expect(payload[:redis_write_bytes]).to be >= 0
# Shared state payload
expect(payload[:redis_queues_calls]).to eq(1)
expect(payload[:redis_queues_duration_s]).to be >= 0
expect(payload[:redis_queues_read_bytes]).to be >= 0
expect(payload[:redis_queues_write_bytes]).to be >= 0
# Cache payload
expect(payload[:redis_cache_calls]).to eq(1)
expect(payload[:redis_cache_duration_s]).to be >= 0
expect(payload[:redis_cache_read_bytes]).to be >= 0
expect(payload[:redis_cache_write_bytes]).to be >= 0
# Gitaly
2020-04-22 19:07:51 +05:30
expect(payload[:gitaly_calls]).to be_nil
expect(payload[:gitaly_duration]).to be_nil
end
end
2021-01-29 00:20:46 +05:30
context 'when the request matched a Rack::Attack safelist' do
it 'logs the safelist name' do
Gitlab::Instrumentation::Throttle.safelist = 'foobar'
subject
expect(payload[:throttle_safelist]).to eq('foobar')
end
end
2021-03-11 19:13:27 +05:30
it 'logs cpu_s duration' do
subject
expect(payload).to include(:cpu_s)
end
2021-10-27 15:23:28 +05:30
it 'logs the process ID' do
subject
expect(payload).to include(:pid)
end
2021-03-11 19:13:27 +05:30
context 'when logging memory allocations' do
include MemoryInstrumentationHelper
before do
skip_memory_instrumentation!
end
it 'logs memory usage metrics' do
subject
expect(payload).to include(
:mem_objects,
:mem_bytes,
:mem_mallocs
)
end
end
2021-09-04 01:27:46 +05:30
2021-11-18 22:05:49 +05:30
it 'includes DB counts' do
subject
2021-09-30 23:02:18 +05:30
2021-11-18 22:05:49 +05:30
expect(payload).to include(db_replica_count: 0,
db_replica_cached_count: 0,
db_primary_count: 0,
db_primary_cached_count: 0,
db_primary_wal_count: 0,
db_replica_wal_count: 0,
db_primary_wal_cached_count: 0,
db_replica_wal_cached_count: 0)
end
2021-09-30 23:02:18 +05:30
2021-11-18 22:05:49 +05:30
context 'when replica caught up search was made' do
before do
Gitlab::SafeRequestStore[:caught_up_replica_pick_ok] = 2
Gitlab::SafeRequestStore[:caught_up_replica_pick_fail] = 1
2021-09-30 23:02:18 +05:30
end
2021-11-18 22:05:49 +05:30
it 'includes related metrics' do
subject
2021-09-30 23:02:18 +05:30
2021-11-18 22:05:49 +05:30
expect(payload).to include(caught_up_replica_pick_ok: 2)
expect(payload).to include(caught_up_replica_pick_fail: 1)
2021-09-04 01:27:46 +05:30
end
end
2021-11-18 22:05:49 +05:30
context 'when only a single counter was updated' do
2021-09-04 01:27:46 +05:30
before do
2021-11-18 22:05:49 +05:30
Gitlab::SafeRequestStore[:caught_up_replica_pick_ok] = 1
Gitlab::SafeRequestStore[:caught_up_replica_pick_fail] = nil
2021-09-04 01:27:46 +05:30
end
2021-11-18 22:05:49 +05:30
it 'includes only that counter into logging' do
2021-09-04 01:27:46 +05:30
subject
2021-11-18 22:05:49 +05:30
expect(payload).to include(caught_up_replica_pick_ok: 1)
expect(payload).not_to include(:caught_up_replica_pick_fail)
2021-09-04 01:27:46 +05:30
end
end
2021-12-11 22:18:48 +05:30
context 'when there is an uploaded file' do
it 'adds upload data' do
uploaded_file = UploadedFile.from_params({
'name' => 'dir/foo.txt',
'sha256' => 'sha256',
'remote_url' => 'http://localhost/file',
'remote_id' => '1234567890',
'etag' => 'etag1234567890',
'upload_duration' => '5.05',
'size' => '123456'
}, nil)
subject
expect(payload[:uploaded_file_upload_duration_s]).to eq(uploaded_file.upload_duration)
expect(payload[:uploaded_file_size_bytes]).to eq(uploaded_file.size)
end
end
2020-04-22 19:07:51 +05:30
end
2021-11-18 22:05:49 +05:30
describe 'duration calculations' do
where(:end_time, :start_time, :time_now, :expected_duration) do
2019-12-26 22:10:19 +05:30
"2019-06-01T00:00:00.000+0000" | nil | "2019-06-01T02:00:00.000+0000" | 2.hours.to_f
2020-05-24 23:13:21 +05:30
"2019-06-01T02:00:00.000+0000" | nil | "2019-06-01T02:00:00.001+0000" | 0.001
2019-12-26 22:10:19 +05:30
"2019-06-01T02:00:00.000+0000" | "2019-05-01T02:00:00.000+0000" | "2019-06-01T02:00:01.000+0000" | 1
2020-05-24 23:13:21 +05:30
nil | "2019-06-01T02:00:00.000+0000" | "2019-06-01T02:00:00.001+0000" | 0.001
2019-12-26 22:10:19 +05:30
nil | nil | "2019-06-01T02:00:00.001+0000" | nil
"2019-06-01T02:00:00.000+0200" | nil | "2019-06-01T02:00:00.000-0200" | 4.hours.to_f
2020-05-24 23:13:21 +05:30
1571825569.998168 | nil | "2019-10-23T12:13:16.000+0200" | 26.001832
2019-12-26 22:10:19 +05:30
1571825569 | nil | "2019-10-23T12:13:16.000+0200" | 27
"invalid_date" | nil | "2019-10-23T12:13:16.000+0200" | nil
"" | nil | "2019-10-23T12:13:16.000+0200" | nil
0 | nil | "2019-10-23T12:13:16.000+0200" | nil
-1 | nil | "2019-10-23T12:13:16.000+0200" | nil
"2019-06-01T02:00:00.000+0000" | nil | "2019-06-01T00:00:00.000+0000" | 0
2021-11-18 22:05:49 +05:30
Time.at(1571999233).utc | nil | "2019-10-25T12:29:16.000+0200" | 123
end
describe '.queue_duration_for_job' do
with_them do
let(:job) { { 'enqueued_at' => end_time, 'created_at' => start_time } }
it "returns the correct duration" do
travel_to(Time.iso8601(time_now)) do
expect(described_class.queue_duration_for_job(job)).to eq(expected_duration)
end
end
end
2019-12-26 22:10:19 +05:30
end
2021-11-18 22:05:49 +05:30
describe '.enqueue_latency_for_scheduled_job' do
with_them do
let(:job) { { 'enqueued_at' => end_time, 'scheduled_at' => start_time } }
2019-12-26 22:10:19 +05:30
2021-11-18 22:05:49 +05:30
it "returns the correct duration" do
travel_to(Time.iso8601(time_now)) do
expect(described_class.enqueue_latency_for_scheduled_job(job)).to eq(expected_duration)
end
2019-12-26 22:10:19 +05:30
end
end
end
end
end