gitlabhq/lib/api/sidekiq_metrics.rb

require 'sidekiq/api'

module API
  class SidekiqMetrics < Grape::API
    before { authenticated_as_admin! }

    helpers do
      def queue_metrics
        Sidekiq::Queue.all.each_with_object({}) do |queue, hash|
          hash[queue.name] = {
            backlog: queue.size,
            latency: queue.latency.to_i
          }
        end
      end

      def process_metrics
        Sidekiq::ProcessSet.new.map do |process|
          {
            hostname:    process['hostname'],
            pid:         process['pid'],
            tag:         process['tag'],
            started_at:  Time.at(process['started_at']),
            queues:      process['queues'],
            labels:      process['labels'],
            concurrency: process['concurrency'],
            busy:        process['busy']
          }
        end
      end

      def job_stats
        stats = Sidekiq::Stats.new
        {
          processed: stats.processed,
          failed: stats.failed,
          enqueued: stats.enqueued
        }
      end
    end

    # Get Sidekiq Queue metrics
    #
    # Parameters:
    #   None
    #
    # Example:
    #   GET /sidekiq/queue_metrics
    #
    get 'sidekiq/queue_metrics' do
      { queues: queue_metrics }
    end

    # Get Sidekiq Process metrics
    #
    # Parameters:
    #   None
    #
    # Example:
    #   GET /sidekiq/process_metrics
    #
    get 'sidekiq/process_metrics' do
      { processes: process_metrics }
    end

    # Get Sidekiq Job statistics
    #
    # Parameters:
    #   None
    #
    # Example:
    #   GET /sidekiq/job_stats
    #
    get 'sidekiq/job_stats' do
      { jobs: job_stats }
    end

    # Get Sidekiq Compound metrics. Includes all previous metrics
    #
    # Parameters:
    #   None
    #
    # Example:
    #   GET /sidekiq/compound_metrics
    #
    get 'sidekiq/compound_metrics' do
      { queues: queue_metrics, processes: process_metrics, jobs: job_stats }
    end
  end
end