gitlab-exporter 10.3.0 → 11.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e5ca8b32e5bce057dbfd998d16e3bc940440115a7540d44e4ab6a4c616c23b3
-  data.tar.gz: 616a825e49b9a0aee99f0684ec7df670c3ad1d09a2b182e317037ac30bca031a
+  metadata.gz: 4a277e09b79fa17edf12f018a94a78c66cce4cc13cb4507ec6e8c82266ff4e0f
+  data.tar.gz: de009b471d90a44f3721e3acad8c6f25cfc3e82d3f0ad72a76e8e7b0bf9e6e45
 SHA512:
-  metadata.gz: a346775749dce1e4e08311d42e7988dc470a46f1b52379b982bc11376b70ebf81fa4a8090447743a5624e16ec3377b638204b2d31bd4e41f2c175d8fdbe51336
-  data.tar.gz: d1fb453077499d6de7ea8fd434e839f390ce3052f4f50fc17c0ee041ed90dcafd83e0e0a9a16ad7a50ce862752701be5a2eecc39b5306458f8feb08b293c3868
+  metadata.gz: 88bfdd110c7360730d076f24b96681d5b705ab926fa3925b79850bb499cc3247e3566fc132cdb5ae6877d7e533569515dcd00bd7e7b5d7e8c98c0fc77de8104d
+  data.tar.gz: 2658a7a6f6f735782868b43a9c1b68d3f63fd1d5ace3f8d1553bc471c50bf340f03000daded30012fb86f901f1b94cb029788e45ccbaf22f0e831d1be91fb8de

data/.gitlab-ci.yml

@@ -6,6 +6,10 @@ 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
 
+stages:
+  - test
+  - dast
+
 default:
   image: ruby:2.7
   cache:

data/Gemfile.lock

@@ -1,15 +1,15 @@
 PATH
   remote: .
   specs:
-    gitlab-exporter (10.3.0)
-      connection_pool (~> 2.2.1)
-      pg (~> 1.1)
-      puma (~> 5.3.2)
-      quantile (~> 0.2.0)
-      redis (~> 4.1.2)
-      redis-namespace (~> 1.6.0)
-      sidekiq (~> 5.2.1)
-      sinatra (~> 2.0.4)
+    gitlab-exporter (11.0.1)
+      connection_pool (= 2.2.5)
+      pg (= 1.2.3)
+      puma (= 5.3.2)
+      quantile (= 0.2.1)
+      redis (= 4.1.4)
+      redis-namespace (= 1.6.0)
+      sidekiq (= 5.2.9)
+      sinatra (= 2.0.8.1)
 
 GEM
   remote: https://rubygems.org/

data/config/gitlab-exporter.yml.example

@@ -78,8 +78,6 @@ probes:
     opts:
       - pid_or_pattern: "sidekiq .* \\[.*?\\]"
         name: sidekiq
-      - pid_or_pattern: "unicorn.* worker\\[.*?\\]"
-        name: unicorn
       - pid_or_pattern: "git-upload-pack --stateless-rpc"
         name: git_upload_pack
         quantiles: true

data/gitlab-exporter.gemspec

@@ -20,14 +20,14 @@ Gem::Specification.new do |s|
   s.homepage      = "http://gitlab.com"
   s.license       = "MIT"
 
-  s.add_runtime_dependency "connection_pool", "~> 2.2.1"
-  s.add_runtime_dependency "pg", "~> 1.1"
-  s.add_runtime_dependency "puma", "~> 5.3.2"
-  s.add_runtime_dependency "quantile", "~> 0.2.0"
-  s.add_runtime_dependency "redis", "~> 4.1.2"
-  s.add_runtime_dependency "redis-namespace", "~> 1.6.0"
-  s.add_runtime_dependency "sidekiq", "~> 5.2.1"
-  s.add_runtime_dependency "sinatra", "~> 2.0.4"
+  s.add_runtime_dependency "connection_pool", "2.2.5"
+  s.add_runtime_dependency "pg", "1.2.3"
+  s.add_runtime_dependency "puma", "5.3.2"
+  s.add_runtime_dependency "quantile", "0.2.1"
+  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_development_dependency "rspec", "~> 3.7.0"
   s.add_development_dependency "rspec-expectations", "~> 3.7.0"

data/lib/gitlab_exporter/cli.rb

@@ -217,7 +217,7 @@ module GitLab
             opts.on("--pid=123", "Process ID") do |val|
               @pid = val
             end
-            opts.on("--pattern=unicorn", "Process command pattern") do |val|
+            opts.on("--pattern=worker", "Process command pattern") do |val|
               @pattern = val
             end
             opts.on("--name=NAME", "Process name to be used in metrics") do |val|
@@ -275,7 +275,7 @@ module GitLab
           ::GitLab::Exporter::SidekiqProber.new(redis_url: @redis_url)
                                            .probe_stats
                                            .probe_queues
-                                           .probe_jobs
+                                           .probe_jobs_limit
                                            .probe_workers
                                            .probe_retries
                                            .write_to(@target)

data/lib/gitlab_exporter/prometheus.rb

@@ -15,6 +15,21 @@ module GitLab
         @include_timestamp = include_timestamp
       end
 
+      class << self
+        def describe(name, description)
+          @metric_descriptions ||= {}
+          @metric_descriptions[name] = description
+        end
+
+        def description(name)
+          @metric_descriptions && @metric_descriptions[name]
+        end
+
+        def clear_descriptions
+          @metric_descriptions = {}
+        end
+      end
+
       def add(name, value, quantile = false, **labels)
         fail "value '#{value}' must be a number" unless value.is_a?(Numeric)
 
@@ -32,6 +47,8 @@ module GitLab
 
         buffer = ""
         @metrics.each do |name, measurements|
+          buffer << "# HELP #{name} #{self.class.description(name)}\n" if self.class.description(name)
+
           measurements.each do |measurement|
             buffer << name.to_s
             labels = (measurement[:labels] || {}).map { |label, value| "#{label}=\"#{value}\"" }.join(",")

data/lib/gitlab_exporter/sidekiq.rb

@@ -7,8 +7,12 @@ module GitLab
     #
     # It takes the Redis URL Sidekiq is connected to
     class SidekiqProber
-      QUEUE_JOB_STATS_SCRIPT = File.read(File.expand_path("#{__FILE__}/../sidekiq_queue_job_stats.lua")).freeze
-      QUEUE_JOB_STATS_SHA    = Digest::SHA1.hexdigest(QUEUE_JOB_STATS_SCRIPT).freeze
+      # The maximum depth (from the head) of each queue to probe. Probing the
+      # entirety of a very large queue will take longer and run the risk of
+      # timing out. But when we have a very large queue, we are most in need of
+      # reliable metrics. This trades off completeness for predictability by
+      # only taking a limited amount of items from the head of the queue.
+      PROBE_JOBS_LIMIT = 1_000
 
       POOL_SIZE = 3
 
@@ -17,6 +21,9 @@ module GitLab
       # needed to be re-initialized
       POOL_TIMEOUT = 90
 
+      PrometheusMetrics.describe("sidekiq_enqueued_jobs",
+                                 "Total number of jobs enqueued by class name. Only inspects the first #{PROBE_JOBS_LIMIT} jobs per queue.") # rubocop:disable Layout/LineLength
+
       def self.connection_pool
         @@connection_pool ||= Hash.new do |h, connection_hash| # rubocop:disable Style/ClassVars
           config = connection_hash.merge(pool_timeout: POOL_TIMEOUT, size: POOL_SIZE)
@@ -63,17 +70,30 @@ module GitLab
       end
 
       def probe_jobs
+        puts "[REMOVED] probe_jobs is now considered obsolete and does not emit any metrics,"\
+             " please use probe_jobs_limit instead"
+
+        self
+      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
+      # commands. For queues over PROBE_JOBS_LIMIT in size, this means that we
+      # will not have completely accurate statistics, but the probe performance
+      # will also not degrade as the queue gets larger.
+      def probe_jobs_limit
         with_sidekiq do
-          job_stats = {}
+          job_stats = Hash.new(0)
 
           Sidekiq::Queue.all.each do |queue|
             Sidekiq.redis do |conn|
-              stats = conn.evalsha(QUEUE_JOB_STATS_SHA, ["queue:#{queue.name}"])
-              job_stats.merge!(stats.to_h)
+              conn.lrange("queue:#{queue.name}", 0, PROBE_JOBS_LIMIT).each do |job|
+                job_class = Sidekiq.load_json(job)["class"]
+
+                job_stats[job_class] += 1
+              end
             end
-          rescue Redis::CommandError # Could happen if the script exceeded the maximum run time (5 seconds by default)
-            # FIXME: Should we call SCRIPT KILL?
-            return self
           end
 
           job_stats.each do |class_name, count|
@@ -169,14 +189,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 = "10.3.0".freeze
+    VERSION = "11.0.1".freeze
   end
 end

data/spec/prometheus_metrics_spec.rb

@@ -23,4 +23,21 @@ describe GitLab::Exporter::PrometheusMetrics do
       subject.add("mymetric", "invalid", mylabel: "x", myotherlabel: "y").to_s
     }.to raise_error(RuntimeError)
   end
+
+  it "supports described metrics" do
+    time = Time.now
+
+    allow(Time).to receive(:now).and_return(time)
+
+    described_class.describe("mymetric", "description")
+    described_class.describe("missingmetric", "otherdescription")
+    subject.add("mymetric", 1.3, mylabel: "x", myotherlabel: "y")
+
+    expect(subject.to_s).to eq(<<~METRICS)
+      # HELP mymetric description
+      mymetric{mylabel="x",myotherlabel="y"} 1.3 #{(time.to_f * 1000).to_i}
+    METRICS
+
+    described_class.clear_descriptions
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-exporter
 version: !ruby/object:Gem::Version
-  version: 10.3.0
+  version: 11.0.1
 platform: ruby
 authors:
 - Pablo Carranza
@@ -14,114 +14,114 @@ dependencies:
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: 2.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: 2.2.5
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.2.3
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 5.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 5.3.2
 - !ruby/object:Gem::Dependency
   name: quantile
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.2
+        version: 4.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.2
+        version: 4.1.4
 - !ruby/object:Gem::Dependency
   name: redis-namespace
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.1
+        version: 5.2.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.1
+        version: 5.2.9
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.4
+        version: 2.0.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.4
+        version: 2.0.8.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -189,7 +189,6 @@ files:
 - lib/gitlab_exporter/prometheus.rb
 - lib/gitlab_exporter/ruby.rb
 - lib/gitlab_exporter/sidekiq.rb
-- lib/gitlab_exporter/sidekiq_queue_job_stats.lua
 - lib/gitlab_exporter/util.rb
 - lib/gitlab_exporter/version.rb
 - lib/gitlab_exporter/web_exporter.rb

data/lib/gitlab_exporter/sidekiq_queue_job_stats.lua

@@ -1,42 +0,0 @@
---
--- Adapted from https://github.com/mperham/sidekiq/blob/2f9258e4fe77991c526f7a65c92bcf792eef8338/lib/sidekiq/api.rb#L231
---
-local queue_name      = KEYS[1]
-local initial_size    = redis.call('llen', queue_name)
-local deleted_size    = 0
-local page            = 0
-local page_size       = 2000
-local temp_job_stats  = {}
-local final_job_stats = {}
-
-while true do
-  local range_start = page * page_size - deleted_size
-  local range_end   = range_start + page_size - 1
-  local entries     = redis.call('lrange', queue_name, range_start, range_end)
-
-  if #entries == 0 then
-    break
-  end
-
-  page = page + 1
-
-  for index, entry in next, entries do
-    local class = cjson.decode(entry)['class']
-    if class ~= nil then
-      if temp_job_stats[class] ~= nil then
-        temp_job_stats[class] = temp_job_stats[class] + 1
-      else
-        temp_job_stats[class] = 1
-      end
-    end
-  end
-
-  deleted_size = initial_size - redis.call('llen', queue_name)
-end
-
-for class, count in next, temp_job_stats do
-  local stat_entry = {class, count}
-  table.insert(final_job_stats, stat_entry)
-end
-
-return final_job_stats