debian-mirror-gitlab/spec/lib/gitlab/metrics/requests_rack_middleware_spec.rb

164 lines
6.4 KiB
Ruby
Raw Normal View History

2019-12-04 20:38:33 +05:30
# frozen_string_literal: true
2017-09-10 17:25:29 +05:30
require 'spec_helper'
2021-01-29 00:20:46 +05:30
RSpec.describe Gitlab::Metrics::RequestsRackMiddleware, :aggregate_failures do
2017-09-10 17:25:29 +05:30
let(:app) { double('app') }
2020-01-01 13:55:28 +05:30
2017-09-10 17:25:29 +05:30
subject { described_class.new(app) }
describe '#call' do
let(:status) { 100 }
let(:env) { { 'REQUEST_METHOD' => 'GET' } }
let(:stack_result) { [status, {}, 'body'] }
before do
allow(app).to receive(:call).and_return(stack_result)
end
context '@app.call succeeds with 200' do
before do
allow(app).to receive(:call).and_return([200, nil, nil])
end
2018-03-17 18:26:18 +05:30
RSpec::Matchers.define :a_positive_execution_time do
match { |actual| actual > 0 }
end
2017-09-10 17:25:29 +05:30
2021-01-29 00:20:46 +05:30
it 'tracks request count and duration' do
expect(described_class).to receive_message_chain(:http_requests_total, :increment).with(method: 'get', status: '200', feature_category: 'unknown')
2021-01-03 14:25:43 +05:30
expect(described_class).to receive_message_chain(:http_request_duration_seconds, :observe).with({ method: 'get' }, a_positive_execution_time)
2017-09-10 17:25:29 +05:30
2021-01-29 00:20:46 +05:30
subject.call(env)
2017-09-10 17:25:29 +05:30
end
2020-04-22 19:07:51 +05:30
context 'request is a health check endpoint' do
2021-01-03 14:25:43 +05:30
['/-/liveness', '/-/liveness/', '/-/%6D%65%74%72%69%63%73'].each do |path|
context "when path is #{path}" do
before do
env['PATH_INFO'] = path
end
2020-04-22 19:07:51 +05:30
2021-01-29 00:20:46 +05:30
it 'increments health endpoint counter rather than overall counter and does not record duration' do
2021-01-03 14:25:43 +05:30
expect(described_class).not_to receive(:http_request_duration_seconds)
2021-01-29 00:20:46 +05:30
expect(described_class).not_to receive(:http_requests_total)
expect(described_class).to receive_message_chain(:http_health_requests_total, :increment).with(method: 'get', status: '200')
2020-04-22 19:07:51 +05:30
2021-01-03 14:25:43 +05:30
subject.call(env)
end
2020-04-22 19:07:51 +05:30
end
end
end
context 'request is not a health check endpoint' do
2021-01-03 14:25:43 +05:30
['/-/ordinary-requests', '/-/', '/-/health/subpath'].each do |path|
context "when path is #{path}" do
before do
env['PATH_INFO'] = path
end
2021-01-29 00:20:46 +05:30
it 'increments regular counters and tracks duration' do
expect(described_class).to receive_message_chain(:http_requests_total, :increment).with(method: 'get', status: '200', feature_category: 'unknown')
2021-01-03 14:25:43 +05:30
expect(described_class).not_to receive(:http_health_requests_total)
expect(described_class)
.to receive_message_chain(:http_request_duration_seconds, :observe)
.with({ method: 'get' }, a_positive_execution_time)
subject.call(env)
end
2020-04-22 19:07:51 +05:30
end
end
end
2017-09-10 17:25:29 +05:30
end
context '@app.call throws exception' do
let(:http_request_duration_seconds) { double('http_request_duration_seconds') }
2021-01-29 00:20:46 +05:30
let(:http_requests_total) { double('http_requests_total') }
2017-09-10 17:25:29 +05:30
before do
allow(app).to receive(:call).and_raise(StandardError)
allow(described_class).to receive(:http_request_duration_seconds).and_return(http_request_duration_seconds)
2021-01-29 00:20:46 +05:30
allow(described_class).to receive(:http_requests_total).and_return(http_requests_total)
2017-09-10 17:25:29 +05:30
end
2021-01-29 00:20:46 +05:30
it 'tracks the correct metrics' do
2017-09-10 17:25:29 +05:30
expect(described_class).to receive_message_chain(:rack_uncaught_errors_count, :increment)
2021-01-29 00:20:46 +05:30
expect(described_class).to receive_message_chain(:http_requests_total, :increment).with(method: 'get', status: 'undefined', feature_category: 'unknown')
expect(described_class.http_request_duration_seconds).not_to receive(:observe)
2017-09-10 17:25:29 +05:30
expect { subject.call(env) }.to raise_error(StandardError)
end
2021-01-29 00:20:46 +05:30
end
2017-09-10 17:25:29 +05:30
2021-01-29 00:20:46 +05:30
context 'feature category header' do
context 'when a feature category header is present' do
before do
allow(app).to receive(:call).and_return([200, { described_class::FEATURE_CATEGORY_HEADER => 'issue_tracking' }, nil])
end
2017-09-10 17:25:29 +05:30
2021-01-29 00:20:46 +05:30
it 'adds the feature category to the labels for http_requests_total' do
expect(described_class).to receive_message_chain(:http_requests_total, :increment).with(method: 'get', status: '200', feature_category: 'issue_tracking')
expect(described_class).not_to receive(:http_health_requests_total)
2017-09-10 17:25:29 +05:30
2021-01-29 00:20:46 +05:30
subject.call(env)
end
2019-12-21 20:55:43 +05:30
2021-01-29 00:20:46 +05:30
it 'does not record a feature category for health check endpoints' do
env['PATH_INFO'] = '/-/liveness'
2021-01-03 14:25:43 +05:30
2021-01-29 00:20:46 +05:30
expect(described_class).to receive_message_chain(:http_health_requests_total, :increment).with(method: 'get', status: '200')
expect(described_class).not_to receive(:http_requests_total)
2021-01-03 14:25:43 +05:30
2021-01-29 00:20:46 +05:30
subject.call(env)
end
2021-01-03 14:25:43 +05:30
end
2021-01-29 00:20:46 +05:30
context 'when the feature category header is an empty string' do
before do
allow(app).to receive(:call).and_return([200, { described_class::FEATURE_CATEGORY_HEADER => '' }, nil])
end
2021-01-03 14:25:43 +05:30
2021-01-29 00:20:46 +05:30
it 'sets the feature category to unknown' do
expect(described_class).to receive_message_chain(:http_requests_total, :increment).with(method: 'get', status: '200', feature_category: 'unknown')
expect(described_class).not_to receive(:http_health_requests_total)
2021-01-03 14:25:43 +05:30
2021-01-29 00:20:46 +05:30
subject.call(env)
end
2021-01-03 14:25:43 +05:30
end
end
2021-01-29 00:20:46 +05:30
describe '.initialize_metrics', :prometheus do
it "sets labels for http_requests_total" do
2019-12-21 20:55:43 +05:30
expected_labels = []
2021-01-29 00:20:46 +05:30
described_class::HTTP_METHODS.each do |method, statuses|
statuses.each do |status|
described_class::FEATURE_CATEGORIES_TO_INITIALIZE.each do |feature_category|
expected_labels << { method: method.to_s, status: status.to_s, feature_category: feature_category.to_s }
end
end
2019-12-21 20:55:43 +05:30
end
2021-01-29 00:20:46 +05:30
described_class.initialize_metrics
expect(described_class.http_requests_total.values.keys).to contain_exactly(*expected_labels)
end
it 'sets labels for http_request_duration_seconds' do
expected_labels = described_class::HTTP_METHODS.keys.map { |method| { method: method } }
described_class.initialize_metrics
2019-12-21 20:55:43 +05:30
expect(described_class.http_request_duration_seconds.values.keys).to include(*expected_labels)
end
2021-01-29 00:20:46 +05:30
it 'has every label in config/feature_categories.yml' do
defaults = [described_class::FEATURE_CATEGORY_DEFAULT, 'not_owned']
feature_categories = YAML.load_file(Rails.root.join('config', 'feature_categories.yml')).map(&:strip) + defaults
expect(described_class::FEATURE_CATEGORIES_TO_INITIALIZE).to all(be_in(feature_categories))
end
2019-12-21 20:55:43 +05:30
end
2017-09-10 17:25:29 +05:30
end
end