2019-12-04 20:38:33 +05:30
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2016-01-14 18:37:52 +05:30
|
|
|
require 'spec_helper'
|
|
|
|
|
2020-07-28 23:09:34 +05:30
|
|
|
RSpec.describe Gitlab::Metrics::Instrumentation do
|
2018-03-17 18:26:18 +05:30
|
|
|
let(:env) { {} }
|
|
|
|
let(:transaction) { Gitlab::Metrics::WebTransaction.new(env) }
|
2016-01-14 18:37:52 +05:30
|
|
|
|
|
|
|
before do
|
|
|
|
@dummy = Class.new do
|
|
|
|
def self.foo(text = 'foo')
|
|
|
|
text
|
|
|
|
end
|
|
|
|
|
2020-11-24 15:15:51 +05:30
|
|
|
def self.wat(text = 'wat')
|
|
|
|
text
|
|
|
|
end
|
|
|
|
private_class_method :wat
|
|
|
|
|
2016-06-16 23:09:34 +05:30
|
|
|
class << self
|
|
|
|
def buzz(text = 'buzz')
|
|
|
|
text
|
|
|
|
end
|
|
|
|
private :buzz
|
|
|
|
|
|
|
|
def flaky(text = 'flaky')
|
|
|
|
text
|
|
|
|
end
|
|
|
|
protected :flaky
|
|
|
|
end
|
|
|
|
|
2016-01-14 18:37:52 +05:30
|
|
|
def bar(text = 'bar')
|
|
|
|
text
|
|
|
|
end
|
2016-06-16 23:09:34 +05:30
|
|
|
|
|
|
|
def wadus(text = 'wadus')
|
|
|
|
text
|
|
|
|
end
|
|
|
|
private :wadus
|
|
|
|
|
|
|
|
def chaf(text = 'chaf')
|
|
|
|
text
|
|
|
|
end
|
|
|
|
protected :chaf
|
2016-01-14 18:37:52 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
allow(@dummy).to receive(:name).and_return('Dummy')
|
|
|
|
end
|
|
|
|
|
2016-09-13 17:45:13 +05:30
|
|
|
describe '.series' do
|
|
|
|
it 'returns a String' do
|
|
|
|
expect(described_class.series).to be_an_instance_of(String)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2016-01-14 18:37:52 +05:30
|
|
|
describe '.configure' do
|
|
|
|
it 'yields self' do
|
|
|
|
described_class.configure do |c|
|
|
|
|
expect(c).to eq(described_class)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
describe '.instrument_method' do
|
|
|
|
describe 'with metrics enabled' do
|
|
|
|
before do
|
|
|
|
allow(Gitlab::Metrics).to receive(:enabled?).and_return(true)
|
|
|
|
|
|
|
|
described_class.instrument_method(@dummy, :foo)
|
|
|
|
end
|
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
it 'instruments the Class' do
|
|
|
|
target = @dummy.singleton_class
|
|
|
|
|
|
|
|
expect(described_class.instrumented?(target)).to eq(true)
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'defines a proxy method' do
|
|
|
|
mod = described_class.proxy_module(@dummy.singleton_class)
|
|
|
|
|
|
|
|
expect(mod.method_defined?(:foo)).to eq(true)
|
2016-01-14 18:37:52 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
it 'calls the instrumented method with the correct arguments' do
|
|
|
|
expect(@dummy.foo).to eq('foo')
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'tracks the call duration upon calling the method' do
|
2017-09-10 17:25:29 +05:30
|
|
|
allow(Gitlab::Metrics).to receive(:method_call_threshold)
|
|
|
|
.and_return(0)
|
2016-01-14 18:37:52 +05:30
|
|
|
|
2017-09-10 17:25:29 +05:30
|
|
|
allow(described_class).to receive(:transaction)
|
|
|
|
.and_return(transaction)
|
2016-01-14 18:37:52 +05:30
|
|
|
|
2020-01-01 13:55:28 +05:30
|
|
|
expect_next_instance_of(Gitlab::Metrics::MethodCall) do |instance|
|
|
|
|
expect(instance).to receive(:measure)
|
|
|
|
end
|
2016-01-14 18:37:52 +05:30
|
|
|
|
|
|
|
@dummy.foo
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'does not track method calls below a given duration threshold' do
|
2017-09-10 17:25:29 +05:30
|
|
|
allow(Gitlab::Metrics).to receive(:method_call_threshold)
|
|
|
|
.and_return(100)
|
2016-01-14 18:37:52 +05:30
|
|
|
|
2016-06-16 23:09:34 +05:30
|
|
|
expect(transaction).not_to receive(:add_metric)
|
2016-01-14 18:37:52 +05:30
|
|
|
|
|
|
|
@dummy.foo
|
|
|
|
end
|
2016-02-05 20:25:01 +05:30
|
|
|
|
|
|
|
it 'generates a method with the correct arity when using methods without arguments' do
|
|
|
|
dummy = Class.new do
|
|
|
|
def self.test; end
|
|
|
|
end
|
|
|
|
|
|
|
|
described_class.instrument_method(dummy, :test)
|
|
|
|
|
|
|
|
expect(dummy.method(:test).arity).to eq(0)
|
|
|
|
end
|
2016-06-02 11:05:42 +05:30
|
|
|
|
|
|
|
describe 'when a module is instrumented multiple times' do
|
|
|
|
it 'calls the instrumented method with the correct arguments' do
|
|
|
|
described_class.instrument_method(@dummy, :foo)
|
|
|
|
|
|
|
|
expect(@dummy.foo).to eq('foo')
|
|
|
|
end
|
|
|
|
end
|
2016-01-14 18:37:52 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
describe 'with metrics disabled' do
|
|
|
|
before do
|
|
|
|
allow(Gitlab::Metrics).to receive(:enabled?).and_return(false)
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'does not instrument the method' do
|
|
|
|
described_class.instrument_method(@dummy, :foo)
|
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
target = @dummy.singleton_class
|
|
|
|
|
|
|
|
expect(described_class.instrumented?(target)).to eq(false)
|
2016-01-14 18:37:52 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
describe '.instrument_instance_method' do
|
|
|
|
describe 'with metrics enabled' do
|
|
|
|
before do
|
|
|
|
allow(Gitlab::Metrics).to receive(:enabled?).and_return(true)
|
|
|
|
|
2017-09-10 17:25:29 +05:30
|
|
|
described_class
|
|
|
|
.instrument_instance_method(@dummy, :bar)
|
2016-01-14 18:37:52 +05:30
|
|
|
end
|
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
it 'instruments instances of the Class' do
|
|
|
|
expect(described_class.instrumented?(@dummy)).to eq(true)
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'defines a proxy method' do
|
|
|
|
mod = described_class.proxy_module(@dummy)
|
|
|
|
|
|
|
|
expect(mod.method_defined?(:bar)).to eq(true)
|
2016-01-14 18:37:52 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
it 'calls the instrumented method with the correct arguments' do
|
|
|
|
expect(@dummy.new.bar).to eq('bar')
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'tracks the call duration upon calling the method' do
|
2017-09-10 17:25:29 +05:30
|
|
|
allow(Gitlab::Metrics).to receive(:method_call_threshold)
|
|
|
|
.and_return(0)
|
2016-01-14 18:37:52 +05:30
|
|
|
|
2017-09-10 17:25:29 +05:30
|
|
|
allow(described_class).to receive(:transaction)
|
|
|
|
.and_return(transaction)
|
2016-01-14 18:37:52 +05:30
|
|
|
|
2020-01-01 13:55:28 +05:30
|
|
|
expect_next_instance_of(Gitlab::Metrics::MethodCall) do |instance|
|
|
|
|
expect(instance).to receive(:measure)
|
|
|
|
end
|
2016-01-14 18:37:52 +05:30
|
|
|
|
|
|
|
@dummy.new.bar
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'does not track method calls below a given duration threshold' do
|
2017-09-10 17:25:29 +05:30
|
|
|
allow(Gitlab::Metrics).to receive(:method_call_threshold)
|
|
|
|
.and_return(100)
|
2016-01-14 18:37:52 +05:30
|
|
|
|
2016-06-16 23:09:34 +05:30
|
|
|
expect(transaction).not_to receive(:add_metric)
|
2016-01-14 18:37:52 +05:30
|
|
|
|
|
|
|
@dummy.new.bar
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
describe 'with metrics disabled' do
|
|
|
|
before do
|
|
|
|
allow(Gitlab::Metrics).to receive(:enabled?).and_return(false)
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'does not instrument the method' do
|
2017-09-10 17:25:29 +05:30
|
|
|
described_class
|
|
|
|
.instrument_instance_method(@dummy, :bar)
|
2016-01-14 18:37:52 +05:30
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
expect(described_class.instrumented?(@dummy)).to eq(false)
|
2016-01-14 18:37:52 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
describe '.instrument_class_hierarchy' do
|
|
|
|
before do
|
|
|
|
allow(Gitlab::Metrics).to receive(:enabled?).and_return(true)
|
|
|
|
|
|
|
|
@child1 = Class.new(@dummy) do
|
|
|
|
def self.child1_foo; end
|
2017-08-17 22:00:37 +05:30
|
|
|
|
2016-01-14 18:37:52 +05:30
|
|
|
def child1_bar; end
|
|
|
|
end
|
|
|
|
|
|
|
|
@child2 = Class.new(@child1) do
|
|
|
|
def self.child2_foo; end
|
2017-08-17 22:00:37 +05:30
|
|
|
|
2016-01-14 18:37:52 +05:30
|
|
|
def child2_bar; end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'recursively instruments a class hierarchy' do
|
|
|
|
described_class.instrument_class_hierarchy(@dummy)
|
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
expect(described_class.instrumented?(@child1.singleton_class)).to eq(true)
|
|
|
|
expect(described_class.instrumented?(@child2.singleton_class)).to eq(true)
|
2016-01-14 18:37:52 +05:30
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
expect(described_class.instrumented?(@child1)).to eq(true)
|
|
|
|
expect(described_class.instrumented?(@child2)).to eq(true)
|
2016-01-14 18:37:52 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
it 'does not instrument the root module' do
|
|
|
|
described_class.instrument_class_hierarchy(@dummy)
|
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
expect(described_class.instrumented?(@dummy)).to eq(false)
|
2016-01-14 18:37:52 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
describe '.instrument_methods' do
|
|
|
|
before do
|
|
|
|
allow(Gitlab::Metrics).to receive(:enabled?).and_return(true)
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'instruments all public class methods' do
|
|
|
|
described_class.instrument_methods(@dummy)
|
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
expect(described_class.instrumented?(@dummy.singleton_class)).to eq(true)
|
2016-06-16 23:09:34 +05:30
|
|
|
expect(@dummy.method(:foo).source_location.first).to match(/instrumentation\.rb/)
|
2020-11-24 15:15:51 +05:30
|
|
|
expect(@dummy.public_methods).to include(:foo)
|
2016-06-16 23:09:34 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
it 'instruments all protected class methods' do
|
|
|
|
described_class.instrument_methods(@dummy)
|
|
|
|
|
|
|
|
expect(described_class.instrumented?(@dummy.singleton_class)).to eq(true)
|
|
|
|
expect(@dummy.method(:flaky).source_location.first).to match(/instrumentation\.rb/)
|
2020-11-24 15:15:51 +05:30
|
|
|
expect(@dummy.protected_methods).to include(:flaky)
|
2016-06-16 23:09:34 +05:30
|
|
|
end
|
|
|
|
|
2020-11-24 15:15:51 +05:30
|
|
|
it 'instruments all private class methods' do
|
2016-06-16 23:09:34 +05:30
|
|
|
described_class.instrument_methods(@dummy)
|
|
|
|
|
|
|
|
expect(described_class.instrumented?(@dummy.singleton_class)).to eq(true)
|
|
|
|
expect(@dummy.method(:buzz).source_location.first).to match(/instrumentation\.rb/)
|
2020-11-24 15:15:51 +05:30
|
|
|
expect(@dummy.private_methods).to include(:buzz)
|
|
|
|
expect(@dummy.private_methods).to include(:wat)
|
2016-01-14 18:37:52 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
it 'only instruments methods directly defined in the module' do
|
|
|
|
mod = Module.new do
|
|
|
|
def kittens
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
@dummy.extend(mod)
|
|
|
|
|
|
|
|
described_class.instrument_methods(@dummy)
|
|
|
|
|
2016-06-16 23:09:34 +05:30
|
|
|
expect(@dummy).not_to respond_to(:_original_kittens)
|
2016-01-14 18:37:52 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
it 'can take a block to determine if a method should be instrumented' do
|
|
|
|
described_class.instrument_methods(@dummy) do
|
|
|
|
false
|
|
|
|
end
|
|
|
|
|
2016-06-16 23:09:34 +05:30
|
|
|
expect(@dummy).not_to respond_to(:_original_foo)
|
2016-01-14 18:37:52 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
describe '.instrument_instance_methods' do
|
|
|
|
before do
|
|
|
|
allow(Gitlab::Metrics).to receive(:enabled?).and_return(true)
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'instruments all public instance methods' do
|
|
|
|
described_class.instrument_instance_methods(@dummy)
|
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
expect(described_class.instrumented?(@dummy)).to eq(true)
|
2016-06-16 23:09:34 +05:30
|
|
|
expect(@dummy.new.method(:bar).source_location.first).to match(/instrumentation\.rb/)
|
2020-11-24 15:15:51 +05:30
|
|
|
expect(@dummy.public_instance_methods).to include(:bar)
|
2016-06-16 23:09:34 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
it 'instruments all protected instance methods' do
|
|
|
|
described_class.instrument_instance_methods(@dummy)
|
|
|
|
|
|
|
|
expect(described_class.instrumented?(@dummy)).to eq(true)
|
|
|
|
expect(@dummy.new.method(:chaf).source_location.first).to match(/instrumentation\.rb/)
|
2020-11-24 15:15:51 +05:30
|
|
|
expect(@dummy.protected_instance_methods).to include(:chaf)
|
2016-06-16 23:09:34 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
it 'instruments all private instance methods' do
|
|
|
|
described_class.instrument_instance_methods(@dummy)
|
|
|
|
|
|
|
|
expect(described_class.instrumented?(@dummy)).to eq(true)
|
|
|
|
expect(@dummy.new.method(:wadus).source_location.first).to match(/instrumentation\.rb/)
|
2020-11-24 15:15:51 +05:30
|
|
|
expect(@dummy.private_instance_methods).to include(:wadus)
|
2016-01-14 18:37:52 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
it 'only instruments methods directly defined in the module' do
|
|
|
|
mod = Module.new do
|
|
|
|
def kittens
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
@dummy.include(mod)
|
|
|
|
|
|
|
|
described_class.instrument_instance_methods(@dummy)
|
|
|
|
|
2016-06-16 23:09:34 +05:30
|
|
|
expect(@dummy.new.method(:kittens).source_location.first).not_to match(/instrumentation\.rb/)
|
2016-01-14 18:37:52 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
it 'can take a block to determine if a method should be instrumented' do
|
|
|
|
described_class.instrument_instance_methods(@dummy) do
|
|
|
|
false
|
|
|
|
end
|
|
|
|
|
2016-06-16 23:09:34 +05:30
|
|
|
expect(@dummy.new.method(:bar).source_location.first).not_to match(/instrumentation\.rb/)
|
2016-01-14 18:37:52 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|