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

248 lines
6.5 KiB
Ruby
Raw Normal View History

2019-12-04 20:38:33 +05:30
# frozen_string_literal: true
require 'spec_helper'
2020-07-28 23:09:34 +05:30
RSpec.describe Gitlab::Metrics do
2017-09-10 17:25:29 +05:30
include StubENV
describe '.settings' do
it 'returns a Hash' do
expect(described_class.settings).to be_an_instance_of(Hash)
end
end
describe '.enabled?' do
it 'returns a boolean' do
2017-09-10 17:25:29 +05:30
expect(described_class.enabled?).to be_in([true, false])
end
end
describe '.prometheus_metrics_enabled_unmemoized' do
subject { described_class.send(:prometheus_metrics_enabled_unmemoized) }
context 'prometheus metrics enabled in config' do
before do
2018-03-17 18:26:18 +05:30
allow(Gitlab::CurrentSettings).to receive(:prometheus_metrics_enabled).and_return(true)
2017-09-10 17:25:29 +05:30
end
context 'when metrics folder is present' do
before do
allow(described_class).to receive(:metrics_folder_present?).and_return(true)
end
it 'metrics are enabled' do
expect(subject).to eq(true)
end
end
context 'when metrics folder is missing' do
before do
allow(described_class).to receive(:metrics_folder_present?).and_return(false)
end
it 'metrics are disabled' do
expect(subject).to eq(false)
end
end
end
end
describe '.prometheus_metrics_enabled?' do
it 'returns a boolean' do
expect(described_class.prometheus_metrics_enabled?).to be_in([true, false])
end
end
2016-06-02 11:05:42 +05:30
describe '.measure' do
context 'without a transaction' do
it 'returns the return value of the block' do
2017-08-17 22:00:37 +05:30
val = described_class.measure(:foo) { 10 }
2016-06-02 11:05:42 +05:30
expect(val).to eq(10)
end
end
context 'with a transaction' do
2018-03-17 18:26:18 +05:30
let(:transaction) { Gitlab::Metrics::WebTransaction.new({}) }
2016-06-02 11:05:42 +05:30
before do
2017-09-10 17:25:29 +05:30
allow(described_class).to receive(:current_transaction)
.and_return(transaction)
2016-06-02 11:05:42 +05:30
end
it 'adds a metric to the current transaction' do
2020-10-24 23:57:45 +05:30
expect(transaction).to receive(:observe).with(:gitlab_foo_real_duration_seconds, a_kind_of(Numeric))
2016-06-02 11:05:42 +05:30
2020-10-24 23:57:45 +05:30
expect(transaction).to receive(:observe).with(:gitlab_foo_cpu_duration_seconds, a_kind_of(Numeric))
2016-06-02 11:05:42 +05:30
2017-08-17 22:00:37 +05:30
described_class.measure(:foo) { 10 }
2016-06-02 11:05:42 +05:30
end
it 'returns the return value of the block' do
2017-08-17 22:00:37 +05:30
val = described_class.measure(:foo) { 10 }
2016-06-02 11:05:42 +05:30
expect(val).to eq(10)
end
end
end
2016-09-13 17:45:13 +05:30
describe '#series_prefix' do
it 'returns a String' do
expect(described_class.series_prefix).to be_an_instance_of(String)
end
end
describe '.add_event' do
context 'without a transaction' do
it 'does nothing' do
2017-09-10 17:25:29 +05:30
expect_any_instance_of(Gitlab::Metrics::Transaction)
.not_to receive(:add_event)
2016-09-13 17:45:13 +05:30
2017-08-17 22:00:37 +05:30
described_class.add_event(:meow)
2016-09-13 17:45:13 +05:30
end
end
context 'with a transaction' do
it 'adds an event' do
2018-03-17 18:26:18 +05:30
transaction = Gitlab::Metrics::WebTransaction.new({})
2016-09-13 17:45:13 +05:30
expect(transaction).to receive(:add_event).with(:meow)
2017-09-10 17:25:29 +05:30
expect(described_class).to receive(:current_transaction)
.and_return(transaction)
2016-09-13 17:45:13 +05:30
2017-08-17 22:00:37 +05:30
described_class.add_event(:meow)
2016-09-13 17:45:13 +05:30
end
end
end
2017-09-10 17:25:29 +05:30
shared_examples 'prometheus metrics API' do
describe '#counter' do
2018-03-17 18:26:18 +05:30
subject { described_class.counter(:counter, 'doc') }
2017-09-10 17:25:29 +05:30
describe '#increment' do
it 'successfully calls #increment without arguments' do
expect { subject.increment }.not_to raise_exception
end
it 'successfully calls #increment with 1 argument' do
expect { subject.increment({}) }.not_to raise_exception
end
it 'successfully calls #increment with 2 arguments' do
expect { subject.increment({}, 1) }.not_to raise_exception
end
end
end
describe '#summary' do
subject { described_class.summary(:summary, 'doc') }
describe '#observe' do
it 'successfully calls #observe with 2 arguments' do
expect { subject.observe({}, 2) }.not_to raise_exception
end
end
end
describe '#gauge' do
subject { described_class.gauge(:gauge, 'doc') }
describe '#set' do
it 'successfully calls #set with 2 arguments' do
expect { subject.set({}, 1) }.not_to raise_exception
end
end
end
describe '#histogram' do
subject { described_class.histogram(:histogram, 'doc') }
describe '#observe' do
it 'successfully calls #observe with 2 arguments' do
expect { subject.observe({}, 2) }.not_to raise_exception
end
end
end
end
context 'prometheus metrics disabled' do
before do
allow(described_class).to receive(:prometheus_metrics_enabled?).and_return(false)
end
it_behaves_like 'prometheus metrics API'
describe '#null_metric' do
2018-03-17 18:26:18 +05:30
subject { described_class.send(:provide_metric, :test) }
2017-09-10 17:25:29 +05:30
it { is_expected.to be_a(Gitlab::Metrics::NullMetric) }
end
describe '#counter' do
subject { described_class.counter(:counter, 'doc') }
it { is_expected.to be_a(Gitlab::Metrics::NullMetric) }
end
describe '#summary' do
subject { described_class.summary(:summary, 'doc') }
it { is_expected.to be_a(Gitlab::Metrics::NullMetric) }
end
describe '#gauge' do
subject { described_class.gauge(:gauge, 'doc') }
it { is_expected.to be_a(Gitlab::Metrics::NullMetric) }
end
describe '#histogram' do
subject { described_class.histogram(:histogram, 'doc') }
it { is_expected.to be_a(Gitlab::Metrics::NullMetric) }
end
end
context 'prometheus metrics enabled' do
let(:metrics_multiproc_dir) { Dir.mktmpdir }
before do
stub_const('Prometheus::Client::Multiprocdir', metrics_multiproc_dir)
allow(described_class).to receive(:prometheus_metrics_enabled?).and_return(true)
end
it_behaves_like 'prometheus metrics API'
describe '#null_metric' do
2018-03-17 18:26:18 +05:30
subject { described_class.send(:provide_metric, :test) }
2017-09-10 17:25:29 +05:30
it { is_expected.to be_nil }
end
describe '#counter' do
subject { described_class.counter(:name, 'doc') }
it { is_expected.not_to be_a(Gitlab::Metrics::NullMetric) }
end
describe '#summary' do
subject { described_class.summary(:name, 'doc') }
it { is_expected.not_to be_a(Gitlab::Metrics::NullMetric) }
end
describe '#gauge' do
subject { described_class.gauge(:name, 'doc') }
it { is_expected.not_to be_a(Gitlab::Metrics::NullMetric) }
end
describe '#histogram' do
subject { described_class.histogram(:name, 'doc') }
it { is_expected.not_to be_a(Gitlab::Metrics::NullMetric) }
end
end
end