gitlab-exporter 11.0.0 → 11.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f22f9c58b0d64fdec6134fa8b59cfd474f1333ebe59a8a94c620749fc4be33c
-  data.tar.gz: 0dc26d62d7aab597a13aab640844a42774a85c2ce6459f9eeeef7441b81f3d19
+  metadata.gz: 402b7efd2fde05a6ab82ff5728f1bbfd1dfae2d4485f54c557cb6a61aaa073c1
+  data.tar.gz: 5e002911773de121aaa43722e56f7720e1ea75c7e22d360441b265d02fcc85c5
 SHA512:
-  metadata.gz: 56a1c9f3a267b32ead646a1c6a95a8d81744498d67613e0c6dbb849a15e624d96215800a1688504e08c8b25a2b1222a4b86f2e3b1cb7b898ff892f6a445dcdbd
-  data.tar.gz: e08257d194617fd5467526403a8629aeab1d46719bb34c57b6aaaa77cb94b138b139544771b071bfccc6ec47e8440d1241ae3adb8fceb226694366d4e89a058f
+  metadata.gz: 8d5e1c40950e6d1581b73c14366f95777e6a06880a1a988a30945cd27d906211ac93d4312f2e890eeab9ddb1f9fccabdbf51a0c13218e4a494de3fea4663c968
+  data.tar.gz: c58bf8aa65703c53a08fba57d54625f9bb2924ac5852398aba7b5e0d0f1916640ab9f4fe92ef2b651e334520bfe488ec7884def9585e4e7b49b42e32d62bcf8d

data/.gitlab-ci.yml

@@ -6,12 +6,15 @@ include:
   - template: Security/SAST.gitlab-ci.yml  # https://gitlab.com/gitlab-org/gitlab-foss/blob/master/lib/gitlab/ci/templates/Security/SAST.gitlab-ci.yml
   - template: Security/Secret-Detection.gitlab-ci.yml # https://gitlab.com/gitlab-org/gitlab-foss/-/blob/master/lib/gitlab/ci/templates/Security/Secret-Detection.gitlab-ci.yml
 
+variables:
+  RUBY_VERSION: "2.7"
+
 stages:
   - test
   - dast
 
 default:
-  image: ruby:2.7
+  image: ruby:${RUBY_VERSION}
   cache:
     paths:
       - vendor
@@ -36,6 +39,10 @@ rspec:
   script:
     - bundle exec rspec spec -f d -c
   before_script: *before_scripts
+  parallel:
+    matrix:
+      - RUBY_VERSION: "2.7"
+      - RUBY_VERSION: "3.0"
 
 rubocop:
   script:

data/.ruby-version

@@ -1 +1 @@
-2.7.2
+2.7.4

data/Gemfile

@@ -2,6 +2,8 @@ source "https://rubygems.org"
 
 gemspec
 
+gem "webrick", "~> 1.7"
+
 group :test do
   gem "rspec", "~>3.5"
   gem "rubocop", "~>0.42"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab-exporter (11.0.0)
+    gitlab-exporter (11.3.0)
       connection_pool (= 2.2.5)
       pg (= 1.2.3)
       puma (= 5.3.2)
@@ -9,7 +9,7 @@ PATH
       redis (= 4.1.4)
       redis-namespace (= 1.6.0)
       sidekiq (= 5.2.9)
-      sinatra (= 2.0.8.1)
+      sinatra (~> 2.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -19,7 +19,7 @@ GEM
     diff-lcs (1.3)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
-    nio4r (2.5.7)
+    nio4r (2.5.8)
     parallel (1.20.1)
     parser (3.0.0.0)
       ast (~> 2.4.1)
@@ -28,7 +28,7 @@ GEM
       nio4r (~> 2.0)
     quantile (0.2.1)
     rack (2.2.3)
-    rack-protection (2.0.8.1)
+    rack-protection (2.1.0)
       rack
     rainbow (3.0.0)
     redis (4.1.4)
@@ -61,19 +61,20 @@ GEM
     rubocop-ast (1.4.0)
       parser (>= 2.7.1.5)
     ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.4)
+    ruby2_keywords (0.0.5)
     sidekiq (5.2.9)
       connection_pool (~> 2.2, >= 2.2.2)
       rack (~> 2.0)
       rack-protection (>= 1.5.0)
       redis (>= 3.3.5, < 4.2)
-    sinatra (2.0.8.1)
+    sinatra (2.1.0)
       mustermann (~> 1.0)
-      rack (~> 2.0)
-      rack-protection (= 2.0.8.1)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
       tilt (~> 2.0)
     tilt (2.0.10)
     unicode-display_width (1.7.0)
+    webrick (1.7.0)
 
 PLATFORMS
   ruby
@@ -83,6 +84,7 @@ DEPENDENCIES
   rspec (~> 3.5)
   rspec-expectations (~> 3.7.0)
   rubocop (~> 0.42)
+  webrick (~> 1.7)
 
 BUNDLED WITH
-   2.1.4
+   2.2.22

data/README.md

@@ -34,7 +34,7 @@ metrics.
       `git_pull_time_milliseconds`, `git_push_time_milliseconds`
     * git processes stats (see Process below)
 1. [Sidekiq](lib/gitlab_exporter/sidekiq.rb)
-	* Stats
+	* Stats (probe_stats)
 	  * `sidekiq_jobs_processed_total`
 	  * `sidekiq_jobs_failed_total`
 	  * `sidekiq_jobs_enqueued_size`
@@ -44,14 +44,21 @@ metrics.
 	  * `sidekiq_default_queue_latency_seconds`
 	  * `sidekiq_processes_size`
 	  * `sidekiq_workers_size`
-	* Queues
+	* Queues (probe_queues)
 	  * `sidekiq_queue_size`
 	  * `sidekiq_queue_paused`
 	  * `sidekiq_queue_latency_seconds`
-	* Jobs
+	* Jobs (probe_jobs_limit)
 	  * `sidekiq_enqueued_jobs`
+  * Workers (probe_workers)
 	  * `sidekiq_running_jobs`
+  * Retries (probe_retries)
 	  * `sidekiq_to_be_retried_jobs`
+  * Future Sets (probe_future_sets)
+    * `sidekiq_schedule_set_processing_delay_seconds`
+    * `sidekiq_schedule_set_backlog_count`
+    * `sidekiq_retry_set_processing_delay_seconds`
+    * `sidekiq_retry_set_backlog_count`
 
 ### Setup with GitLab Development Kit
 

data/gitlab-exporter.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "redis", "4.1.4"
   s.add_runtime_dependency "redis-namespace", "1.6.0"
   s.add_runtime_dependency "sidekiq", "5.2.9"
-  s.add_runtime_dependency "sinatra", "2.0.8.1"
+  s.add_runtime_dependency "sinatra", "~> 2.1.0"
 
   s.add_development_dependency "rspec", "~> 3.7.0"
   s.add_development_dependency "rspec-expectations", "~> 3.7.0"

data/lib/gitlab_exporter/database/base.rb

@@ -41,8 +41,8 @@ module GitLab
           conn.type_map_for_results = tm
         end
 
-        def initialize(args, logger: nil)
-          @connection_string = args[:connection_string]
+        def initialize(connection_string:, logger: nil, **opts) # rubocop:disable Lint/UnusedMethodArgument
+          @connection_string = connection_string
           @logger = logger
         end
 

data/lib/gitlab_exporter/database/bloat.rb

@@ -39,12 +39,11 @@ module GitLab
 
         attr_reader :metrics, :collector, :bloat_types
 
-        def initialize(opts,
-                       metrics: PrometheusMetrics.new,
-                       collector: BloatCollector.new(connection_string: opts[:connection_string]),
-                       logger: nil)
+        def initialize(metrics: PrometheusMetrics.new,
+                       logger: nil,
+                       **opts)
           @metrics = metrics
-          @collector = collector
+          @collector = opts[:collector] || BloatCollector.new(**opts)
           @collector.logger = logger
           @bloat_types = opts[:bloat_types] || %i[btree table]
         end

data/lib/gitlab_exporter/database/ci_builds.rb

@@ -168,8 +168,8 @@ module GitLab
 
         DEFAULT_UNARCHIVED_TRACES_OFFSET_MINUTES = 1440
 
-        def initialize(opts, logger: nil)
-          super(opts, logger: logger)
+        def initialize(**opts)
+          super
 
           @created_builds_counting_disabled = opts[:created_builds_counting_disabled]
           @unarchived_traces_offset_minutes = opts[:unarchived_traces_offset_minutes]
@@ -294,13 +294,9 @@ module GitLab
 
       # The prober which is called when gathering metrics
       class CiBuildsProber
-        def initialize(opts, metrics: PrometheusMetrics.new, logger: nil)
+        def initialize(metrics: PrometheusMetrics.new, **opts)
           @metrics = metrics
-
-          collector_opts = { connection_string: opts[:connection_string],
-                             created_builds_counting_disabled: opts[:created_builds_counting_disabled],
-                             unarchived_traces_offset_minutes: opts[:unarchived_traces_offset_minutes] }
-          @collector = CiBuildsCollector.new(collector_opts, logger: logger)
+          @collector = CiBuildsCollector.new(**opts)
         end
 
         def probe_db
@@ -391,7 +387,7 @@ module GitLab
           labels[:namespace] = "" unless labels[:namespace]
 
           selected_labels = labels.select { |k, _| allowed_labels.include?(k) }.sort.to_h
-          @metrics.add(metric_name, value.to_f, selected_labels)
+          @metrics.add(metric_name, value.to_f, **selected_labels)
         end
 
         def unarchived_traces_metrics

data/lib/gitlab_exporter/database/remote_mirrors.rb

@@ -10,8 +10,8 @@ module GitLab
           FROM remote_mirrors WHERE project_id IN (%s) AND enabled = 't'
         SQL
 
-        def initialize(args)
-          super(args)
+        def initialize(**args)
+          super(**args)
 
           @project_ids = args[:project_ids]
         end
@@ -35,7 +35,7 @@ module GitLab
 
       # The prober which is called when gathering metrics
       class RemoteMirrorsProber
-        def initialize(opts, metrics: PrometheusMetrics.new, logger: nil) # rubocop:disable Lint/UnusedMethodArgument
+        def initialize(metrics: PrometheusMetrics.new, **opts)
           @metrics = metrics
           @collector = RemoteMirrorsCollector.new(
             connection_string: opts[:connection_string],

data/lib/gitlab_exporter/database/row_count.rb

@@ -131,13 +131,18 @@ module GitLab
               visibility_level: {},
               root: { definition: "(parent_id IS NULL)" }
             }
-          }
+          },
+          registry_gc_manifest_review_queue: { select: :gc_manifest_review_queue },
+          registry_gc_blob_review_queue: { select: :gc_blob_review_queue },
+          registry_repositories: { select: :repositories },
+          registry_manifests: { select: :manifests },
+          registry_blobs: { select: :blobs }
         }.freeze
 
-        def initialize(args)
-          super(args)
+        def initialize(selected_queries: nil, **args)
+          super(**args)
 
-          @selected_queries = Set.new(args[:selected_queries].map(&:to_sym)) unless args[:selected_queries].nil?
+          @selected_queries = Set.new(selected_queries.map(&:to_sym)) unless selected_queries.nil?
         end
 
         def run
@@ -200,12 +205,9 @@ module GitLab
 
       # The prober which is called when gathering metrics
       class RowCountProber
-        def initialize(opts, metrics: PrometheusMetrics.new, logger: nil) # rubocop:disable Lint/UnusedMethodArgument
+        def initialize(metrics: PrometheusMetrics.new, **opts)
           @metrics = metrics
-          @collector = RowCountCollector.new(
-            connection_string: opts[:connection_string],
-            selected_queries: opts[:selected_queries]
-          )
+          @collector = RowCountCollector.new(**opts)
         end
 
         def probe_db

data/lib/gitlab_exporter/database/tuple_stats.rb

@@ -25,9 +25,9 @@ module GitLab
 
       # Probes the DB specified by opts[:connection_string] for tuple stats, then converts them to metrics
       class TuplesProber
-        def initialize(opts, metrics: PrometheusMetrics.new, logger: nil)
+        def initialize(metrics: PrometheusMetrics.new, **opts)
           @metrics   = metrics
-          @collector = TupleStatsCollector.new(connection_string: opts[:connection_string], logger: logger)
+          @collector = TupleStatsCollector.new(**opts)
         end
 
         def probe_db

data/lib/gitlab_exporter/git.rb

@@ -64,10 +64,10 @@ module GitLab
     # Optionally takes a metrics object which by default is a PrometheusMetrics, useful to change the
     # metrics writer to something else.
     class GitProber
-      def initialize(opts, metrics: PrometheusMetrics.new, logger: nil) # rubocop:disable Lint/UnusedMethodArgument
+      def initialize(source:, metrics: PrometheusMetrics.new, labels: {}, **opts) # rubocop:disable Lint/UnusedMethodArgument
         @metrics = metrics
-        @labels = opts[:labels] || {}
-        @git = Git.new(opts[:source])
+        @labels = labels
+        @git = Git.new(source)
       end
 
       def probe_pull
@@ -87,9 +87,9 @@ module GitLab
 
     # A special prober for git processes
     class GitProcessProber
-      def initialize(opts, metrics: PrometheusMetrics.new, logger: nil) # rubocop:disable Lint/UnusedMethodArgument
-        @opts    = opts
+      def initialize(metrics: PrometheusMetrics.new, quantiles: nil, **opts) # rubocop:disable Lint/UnusedMethodArgument
         @metrics = metrics
+        @quantiles = quantiles
       end
 
       def probe_git # rubocop:disable Metrics/MethodLength
@@ -115,7 +115,7 @@ module GitLab
             {
               name: name,
               pid_or_pattern: pid,
-              quantiles: @opts[:quantiles]
+              quantiles: @quantiles
             },
             metrics: @metrics
           )

data/lib/gitlab_exporter/prober.rb

@@ -2,7 +2,7 @@ module GitLab
   module Exporter
     # A class to combine multiple probers into one
     class Prober
-      def initialize(prober_opts, metrics: PrometheusMetrics.new, logger: nil)
+      def initialize(metrics: PrometheusMetrics.new, logger: nil, **prober_opts)
         @prober_opts = prober_opts
         @metrics     = metrics
         @logger      = logger
@@ -13,7 +13,7 @@ module GitLab
       def probe_all
         @prober_opts.each do |_probe_name, params|
           Utils.wrap_in_array(params[:opts]).each do |opts|
-            prober = params[:class].new(opts, metrics: @metrics, logger: @logger)
+            prober = params[:class].new(metrics: @metrics, logger: @logger, **opts)
             params[:methods].each do |meth|
               prober.send(meth)
             end

data/lib/gitlab_exporter/process.rb

@@ -59,15 +59,15 @@ module GitLab
 
     # Probes a process for info then writes metrics to a target
     class ProcessProber
-      def initialize(options, metrics: PrometheusMetrics.new, logger: nil) # rubocop:disable Lint/UnusedMethodArgument
+      def initialize(name:, metrics: PrometheusMetrics.new, quantiles: false, **options)
         @metrics = metrics
-        @name    = options[:name]
+        @name    = name
         @pids    = if options[:pid_or_pattern] =~ /^\d+$/
                      [options[:pid_or_pattern]]
                    else
                      Utils.pgrep(options[:pid_or_pattern])
                    end
-        @use_quantiles = options.fetch(:quantiles, false)
+        @use_quantiles = quantiles
       end
 
       def probe_stat

data/lib/gitlab_exporter/ruby.rb

@@ -4,9 +4,9 @@ module GitLab
   module Exporter
     # Probes a current process GC for info then writes metrics to a target
     class RubyProber
-      def initialize(options, metrics: PrometheusMetrics.new, logger: nil) # rubocop:disable Lint/UnusedMethodArgument
+      def initialize(metrics: PrometheusMetrics.new, quantiles: false, **opts) # rubocop:disable Lint/UnusedMethodArgument
         @metrics = metrics
-        @use_quantiles = options.fetch(:quantiles, false)
+        @use_quantiles = quantiles
       end
 
       def probe_gc

data/lib/gitlab_exporter/sidekiq.rb

@@ -1,4 +1,5 @@
 require "sidekiq/api"
+require "sidekiq/scheduled"
 require "digest"
 
 module GitLab
@@ -32,7 +33,7 @@ module GitLab
         end
       end
 
-      def initialize(opts, metrics: PrometheusMetrics.new, logger: nil)
+      def initialize(metrics: PrometheusMetrics.new, logger: nil, **opts)
         @opts    = opts
         @metrics = metrics
         @logger  = logger
@@ -76,6 +77,27 @@ module GitLab
         self
       end
 
+      def probe_future_sets
+        now = Time.now.to_f
+        with_sidekiq do
+          Sidekiq.redis do |conn|
+            Sidekiq::Scheduled::SETS.each do |set|
+              # Default to 0; if all jobs are due in the future, there is no "negative" delay.
+              delay = 0
+
+              _job, timestamp = conn.zrangebyscore(set, "-inf", now.to_s, limit: [0, 1], withscores: true).first
+              delay = now - timestamp if timestamp
+
+              @metrics.add("sidekiq_#{set}_set_processing_delay_seconds", delay)
+
+              # zcount is O(log(N)) (prob. binary search), so is still quick even with large sets
+              @metrics.add("sidekiq_#{set}_set_backlog_count",
+                           conn.zcount(set, "-inf", now.to_s))
+            end
+          end
+        end
+      end
+
       # Count worker classes present in Sidekiq queues. This only looks at the
       # first PROBE_JOBS_LIMIT jobs in each queue. This means that we run a
       # single LRANGE command for each queue, which does not block other
@@ -189,14 +211,9 @@ module GitLab
       def connected?
         return @connected unless @connected.nil?
 
-        # This is also a good "connected check"
         Sidekiq.redis do |conn|
-          # Using administrative commands on conn directly (which is a Redis::Namespace)
-          # will be removed in redis-namespace 2.0.
-          conn.redis.script(:load, QUEUE_JOB_STATS_SCRIPT) unless conn.redis.script(:exists, QUEUE_JOB_STATS_SHA)
+          @connected = (conn.ping == "PONG")
         end
-
-        @connected = true
       rescue Redis::BaseConnectionError => e
         @logger&.error "Error connecting to the Redis: #{e}"
         @connected = false

data/lib/gitlab_exporter/version.rb

@@ -1,5 +1,5 @@
 module GitLab
   module Exporter
-    VERSION = "11.0.0".freeze
+    VERSION = "11.3.0".freeze
   end
 end

data/lib/gitlab_exporter/web_exporter.rb

@@ -89,7 +89,7 @@ module GitLab
 
             get "/#{probe_name}" do
               content_type "text/plain; version=0.0.4"
-              prober = Prober.new(opts, metrics: PrometheusMetrics.new(include_timestamp: false), logger: logger)
+              prober = Prober.new(metrics: PrometheusMetrics.new(include_timestamp: false), logger: logger, **opts)
 
               prober.probe_all
               prober.write_to(response)

data/spec/database/bloat_spec.rb

@@ -26,7 +26,7 @@ describe GitLab::Exporter::Database::BloatCollector do
 end
 
 describe GitLab::Exporter::Database::BloatProber do
-  let(:opts) { { bloat_types: %i[btree table] } }
+  let(:opts) { { bloat_types: %i[btree table], connection_string: "" } }
   let(:metrics) { double("PrometheusMetrics", add: nil) }
   let(:collector) { double("BloatCollector", run: data) }
 
@@ -43,7 +43,7 @@ describe GitLab::Exporter::Database::BloatProber do
   end
 
   describe "#probe_db" do
-    subject { described_class.new(opts, metrics: metrics, collector: collector, logger: STDOUT).probe_db }
+    subject { described_class.new(metrics: metrics, collector: collector, logger: STDOUT, **opts).probe_db }
 
     before do
       expect(collector).to receive(:logger=).with(STDOUT)
@@ -92,7 +92,7 @@ describe GitLab::Exporter::Database::BloatProber do
   describe "#write_to" do
     let(:target) { double }
     let(:metrics) { double("PrometheusMetrics", to_s: double) }
-    subject { described_class.new(opts, metrics: metrics).write_to(target) }
+    subject { described_class.new(metrics: metrics, **opts).write_to(target) }
 
     it "writes to given target" do
       expect(target).to receive(:write).with(metrics.to_s)

data/spec/database/ci_builds_spec.rb

@@ -216,11 +216,12 @@ describe GitLab::Exporter::Database do
   describe GitLab::Exporter::Database::CiBuildsProber do
     let(:writer) { StringIO.new }
     let(:prober) do
-      opts = { connection_string: "host=localhost",
-               created_builds_counting_disabled: created_builds_counting_disabled,
-               unarchived_traces_offset_minutes: unarchived_traces_offset_minutes }
-      described_class.new(opts,
-                          metrics: GitLab::Exporter::PrometheusMetrics.new(include_timestamp: false))
+      described_class.new(
+        connection_string: "host=localhost",
+        created_builds_counting_disabled: created_builds_counting_disabled,
+        unarchived_traces_offset_minutes: unarchived_traces_offset_minutes,
+        metrics: GitLab::Exporter::PrometheusMetrics.new(include_timestamp: false)
+      )
     end
 
     before do

data/spec/git_spec.rb

@@ -34,17 +34,17 @@ context "With valid pair of repositories" do
   end
 
   describe GitLab::Exporter::GitProber do
-    let(:options) { GitProberOptions.new(repos.cloned_repo, {}) }
+    let(:options) { { source: repos.cloned_repo, labels: {} } }
     let(:output) { StringIO.new }
 
     it "probes and monitors a pull" do
-      prober = GitLab::Exporter::GitProber.new(options)
+      prober = GitLab::Exporter::GitProber.new(**options)
       prober.probe_pull.write_to(output)
       expect(output.string).to match(/git_pull_time_milliseconds \d+ \d+/)
     end
 
     it "probes and monitors a push" do
-      prober = GitLab::Exporter::GitProber.new(options)
+      prober = GitLab::Exporter::GitProber.new(**options)
       prober.probe_push.write_to(output)
       expect(output.string).to match(/git_push_time_milliseconds \d+ \d+/)
     end

data/spec/ruby_spec.rb

@@ -3,7 +3,7 @@ require "gitlab_exporter/ruby"
 require "gitlab_exporter/prober"
 
 describe GitLab::Exporter::RubyProber do
-  let(:prober) { GitLab::Exporter::Prober.new(options) }
+  let(:prober) { GitLab::Exporter::Prober.new(**options) }
 
   let(:options) do
     {

data/spec/spec_helper.rb

@@ -40,8 +40,6 @@ class GitRepoBuilder
   end
 end
 
-GitProberOptions = Struct.new(:source, :labels)
-
 class CLIArgs
   def initialize(args)
     @arguments = args

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-exporter
 version: !ruby/object:Gem::Version
-  version: 11.0.0
+  version: 11.3.0
 platform: ruby
 authors:
 - Pablo Carranza
@@ -112,16 +112,16 @@ dependencies:
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.8.1
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.8.1
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement