File: sidekiq.rb

package info (click to toggle)
ruby-gitlab 5.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,660 kB
  • sloc: ruby: 12,582; makefile: 7; sh: 4
file content (39 lines) | stat: -rw-r--r-- 903 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# frozen_string_literal: true

class Gitlab::Client
  # Defines methods related to sidekiq metrics.
  # @see https://docs.gitlab.com/ce/api/sidekiq_metrics.html
  module Sidekiq
    # Get the current Queue Metrics
    #
    # @example
    #   Gitlab.sidekiq_queue_metrics
    def sidekiq_queue_metrics
      get('/sidekiq/queue_metrics')
    end

    # Get the current Process Metrics
    #
    # @example
    #   Gitlab.sidekiq_process_metrics
    def sidekiq_process_metrics
      get('/sidekiq/process_metrics')
    end

    # Get the current Job Statistics
    #
    # @example
    #   Gitlab.sidekiq_job_stats
    def sidekiq_job_stats
      get('/sidekiq/job_stats')
    end

    # Get a compound response of all the previously mentioned metrics
    #
    # @example
    #   Gitlab.sidekiq_compound_metrics
    def sidekiq_compound_metrics
      get('/sidekiq/compound_metrics')
    end
  end
end