gitlab-org--gitlab-foss/spec/lib/gitlab/sidekiq_middleware/server_metrics_spec.rb

# frozen_string_literal: true

require 'spec_helper'

RSpec.describe Gitlab::SidekiqMiddleware::ServerMetrics do
  context "with worker attribution" do
    subject { described_class.new }

    let(:queue) { :test }
    let(:worker_class) { worker.class }
    let(:job) { {} }
    let(:job_status) { :done }
    let(:labels_with_job_status) { labels.merge(job_status: job_status.to_s) }
    let(:default_labels) do
      { queue: queue.to_s,
        worker: worker_class.to_s,
        boundary: "",
        external_dependencies: "no",
        feature_category: "",
        urgency: "low" }
    end

    shared_examples "a metrics middleware" do
      context "with mocked prometheus" do
        let(:concurrency_metric) { double('concurrency metric') }

        let(:queue_duration_seconds) { double('queue duration seconds metric') }
        let(:completion_seconds_metric) { double('completion seconds metric') }
        let(:user_execution_seconds_metric) { double('user execution seconds metric') }
        let(:db_seconds_metric) { double('db seconds metric') }
        let(:gitaly_seconds_metric) { double('gitaly seconds metric') }
        let(:failed_total_metric) { double('failed total metric') }
        let(:retried_total_metric) { double('retried total metric') }
        let(:redis_requests_total) { double('redis calls total metric') }
        let(:running_jobs_metric) { double('running jobs metric') }
        let(:redis_seconds_metric) { double('redis seconds metric') }
        let(:elasticsearch_seconds_metric) { double('elasticsearch seconds metric') }
        let(:elasticsearch_requests_total) { double('elasticsearch calls total metric') }

        before do
          allow(Gitlab::Metrics).to receive(:histogram).with(:sidekiq_jobs_queue_duration_seconds, anything, anything, anything).and_return(queue_duration_seconds)
          allow(Gitlab::Metrics).to receive(:histogram).with(:sidekiq_jobs_completion_seconds, anything, anything, anything).and_return(completion_seconds_metric)
          allow(Gitlab::Metrics).to receive(:histogram).with(:sidekiq_jobs_cpu_seconds, anything, anything, anything).and_return(user_execution_seconds_metric)
          allow(Gitlab::Metrics).to receive(:histogram).with(:sidekiq_jobs_db_seconds, anything, anything, anything).and_return(db_seconds_metric)
          allow(Gitlab::Metrics).to receive(:histogram).with(:sidekiq_jobs_gitaly_seconds, anything, anything, anything).and_return(gitaly_seconds_metric)
          allow(Gitlab::Metrics).to receive(:histogram).with(:sidekiq_redis_requests_duration_seconds, anything, anything, anything).and_return(redis_seconds_metric)
          allow(Gitlab::Metrics).to receive(:histogram).with(:sidekiq_elasticsearch_requests_duration_seconds, anything, anything, anything).and_return(elasticsearch_seconds_metric)
          allow(Gitlab::Metrics).to receive(:counter).with(:sidekiq_jobs_failed_total, anything).and_return(failed_total_metric)
          allow(Gitlab::Metrics).to receive(:counter).with(:sidekiq_jobs_retried_total, anything).and_return(retried_total_metric)
          allow(Gitlab::Metrics).to receive(:counter).with(:sidekiq_redis_requests_total, anything).and_return(redis_requests_total)
          allow(Gitlab::Metrics).to receive(:counter).with(:sidekiq_elasticsearch_requests_total, anything).and_return(elasticsearch_requests_total)
          allow(Gitlab::Metrics).to receive(:gauge).with(:sidekiq_running_jobs, anything, {}, :all).and_return(running_jobs_metric)
          allow(Gitlab::Metrics).to receive(:gauge).with(:sidekiq_concurrency, anything, {}, :all).and_return(concurrency_metric)

          allow(concurrency_metric).to receive(:set)
        end

        describe '#initialize' do
          it 'sets concurrency metrics' do
            expect(concurrency_metric).to receive(:set).with({}, Sidekiq.options[:concurrency].to_i)

            subject
          end
        end

        describe '#call' do
          let(:thread_cputime_before) { 1 }
          let(:thread_cputime_after) { 2 }
          let(:thread_cputime_duration) { thread_cputime_after - thread_cputime_before }

          let(:monotonic_time_before) { 11 }
          let(:monotonic_time_after) { 20 }
          let(:monotonic_time_duration) { monotonic_time_after - monotonic_time_before }

          let(:queue_duration_for_job) { 0.01 }

          let(:db_duration) { 3 }
          let(:gitaly_duration) { 4 }

          let(:redis_calls) { 2 }
          let(:redis_duration) { 0.01 }

          let(:elasticsearch_calls) { 8 }
          let(:elasticsearch_duration) { 0.54 }

          before do
            allow(subject).to receive(:get_thread_cputime).and_return(thread_cputime_before, thread_cputime_after)
            allow(Gitlab::Metrics::System).to receive(:monotonic_time).and_return(monotonic_time_before, monotonic_time_after)
            allow(Gitlab::InstrumentationHelper).to receive(:queue_duration_for_job).with(job).and_return(queue_duration_for_job)
            allow(ActiveRecord::LogSubscriber).to receive(:runtime).and_return(db_duration * 1000)

            job[:gitaly_duration_s] = gitaly_duration
            job[:redis_calls] = redis_calls
            job[:redis_duration_s] = redis_duration

            job[:elasticsearch_calls] = elasticsearch_calls
            job[:elasticsearch_duration_s] = elasticsearch_duration

            allow(running_jobs_metric).to receive(:increment)
            allow(redis_requests_total).to receive(:increment)
            allow(elasticsearch_requests_total).to receive(:increment)
            allow(queue_duration_seconds).to receive(:observe)
            allow(user_execution_seconds_metric).to receive(:observe)
            allow(db_seconds_metric).to receive(:observe)
            allow(gitaly_seconds_metric).to receive(:observe)
            allow(completion_seconds_metric).to receive(:observe)
            allow(redis_seconds_metric).to receive(:observe)
            allow(elasticsearch_seconds_metric).to receive(:observe)
          end

          it 'yields block' do
            expect { |b| subject.call(worker, job, :test, &b) }.to yield_control.once
          end

          it 'sets queue specific metrics' do
            expect(running_jobs_metric).to receive(:increment).with(labels, -1)
            expect(running_jobs_metric).to receive(:increment).with(labels, 1)
            expect(queue_duration_seconds).to receive(:observe).with(labels, queue_duration_for_job) if queue_duration_for_job
            expect(user_execution_seconds_metric).to receive(:observe).with(labels_with_job_status, thread_cputime_duration)
            expect(db_seconds_metric).to receive(:observe).with(labels_with_job_status, db_duration)
            expect(gitaly_seconds_metric).to receive(:observe).with(labels_with_job_status, gitaly_duration)
            expect(completion_seconds_metric).to receive(:observe).with(labels_with_job_status, monotonic_time_duration)
            expect(redis_seconds_metric).to receive(:observe).with(labels_with_job_status, redis_duration)
            expect(elasticsearch_seconds_metric).to receive(:observe).with(labels_with_job_status, elasticsearch_duration)
            expect(redis_requests_total).to receive(:increment).with(labels_with_job_status, redis_calls)
            expect(elasticsearch_requests_total).to receive(:increment).with(labels_with_job_status, elasticsearch_calls)

            subject.call(worker, job, :test) { nil }
          end

          it 'sets the thread name if it was nil' do
            allow(Thread.current).to receive(:name).and_return(nil)
            expect(Thread.current).to receive(:name=).with(Gitlab::Metrics::Samplers::ThreadsSampler::SIDEKIQ_WORKER_THREAD_NAME)

            subject.call(worker, job, :test) { nil }
          end

          context 'when job_duration is not available' do
            let(:queue_duration_for_job) { nil }

            it 'does not set the queue_duration_seconds histogram' do
              expect(queue_duration_seconds).not_to receive(:observe)

              subject.call(worker, job, :test) { nil }
            end
          end

          context 'when error is raised' do
            let(:job_status) { :fail }

            it 'sets sidekiq_jobs_failed_total and reraises' do
              expect(failed_total_metric).to receive(:increment).with(labels, 1)

              expect { subject.call(worker, job, :test) { raise StandardError, "Failed" } }.to raise_error(StandardError, "Failed")
            end
          end

          context 'when job is retried' do
            let(:job) { { 'retry_count' => 1 } }

            it 'sets sidekiq_jobs_retried_total metric' do
              expect(retried_total_metric).to receive(:increment)

              subject.call(worker, job, :test) { nil }
            end
          end
        end
      end

      context "with prometheus integrated" do
        describe '#call' do
          it 'yields block' do
            expect { |b| subject.call(worker, job, :test, &b) }.to yield_control.once
          end

          context 'when error is raised' do
            let(:job_status) { :fail }

            it 'sets sidekiq_jobs_failed_total and reraises' do
              expect { subject.call(worker, job, :test) { raise StandardError, "Failed" } }.to raise_error(StandardError, "Failed")
            end
          end
        end
      end
    end

    context "when workers are not attributed" do
      before do
        stub_const('TestNonAttributedWorker', Class.new)
        TestNonAttributedWorker.class_eval do
          include Sidekiq::Worker
        end
      end

      let(:worker) { TestNonAttributedWorker.new }
      let(:labels) { default_labels.merge(urgency: "") }

      it_behaves_like "a metrics middleware"
    end

    context "when workers are attributed" do
      def create_attributed_worker_class(urgency, external_dependencies, resource_boundary, category)
        Class.new do
          include Sidekiq::Worker
          include WorkerAttributes

          urgency urgency if urgency
          worker_has_external_dependencies! if external_dependencies
          worker_resource_boundary resource_boundary unless resource_boundary == :unknown
          feature_category category unless category.nil?
        end
      end

      let(:urgency) { nil }
      let(:external_dependencies) { false }
      let(:resource_boundary) { :unknown }
      let(:feature_category) { nil }
      let(:worker_class) { create_attributed_worker_class(urgency, external_dependencies, resource_boundary, feature_category) }
      let(:worker) { worker_class.new }

      context "high urgency" do
        let(:urgency) { :high }
        let(:labels) { default_labels.merge(urgency: "high") }

        it_behaves_like "a metrics middleware"
      end

      context "external dependencies" do
        let(:external_dependencies) { true }
        let(:labels) { default_labels.merge(external_dependencies: "yes") }

        it_behaves_like "a metrics middleware"
      end

      context "cpu boundary" do
        let(:resource_boundary) { :cpu }
        let(:labels) { default_labels.merge(boundary: "cpu") }

        it_behaves_like "a metrics middleware"
      end

      context "memory boundary" do
        let(:resource_boundary) { :memory }
        let(:labels) { default_labels.merge(boundary: "memory") }

        it_behaves_like "a metrics middleware"
      end

      context "feature category" do
        let(:feature_category) { :authentication }
        let(:labels) { default_labels.merge(feature_category: "authentication") }

        it_behaves_like "a metrics middleware"
      end

      context "combined" do
        let(:urgency) { :throttled }
        let(:external_dependencies) { true }
        let(:resource_boundary) { :cpu }
        let(:feature_category) { :authentication }
        let(:labels) { default_labels.merge(urgency: "throttled", external_dependencies: "yes", boundary: "cpu", feature_category: "authentication") }

        it_behaves_like "a metrics middleware"
      end
    end
  end
end