gitlab-exporter 10.0.0 → 10.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f7115d7a7e8604d15ad7734afd3280c22edf9f6911af159f9386f2a9d495701
-  data.tar.gz: 7b050b23851b8073da229a5347b0c22afd641a1420859f37f0a0b8a7a4113244
+  metadata.gz: 4c392268186f090b025d290c818f821120f5160a9a59f2e3ba228f26da0b8505
+  data.tar.gz: 3771d5912cb2a310183a1f78a8e24d191eb502d20c2beab3c327994243ae7077
 SHA512:
-  metadata.gz: 848007d860313f8d62239b3f97a9024944aec9ddbfe6ea97472eaae64ddfc6e03cc056fe9466ce719209a6fad2b5a88947ff085f25ed6cf4ecf6421c1db576d7
-  data.tar.gz: f751e8af1eea6d30eb00dae65ec41681b50e9481a392b6521fde15c07934d8550dd2c3e3b65ea13ae6cbc0adadfe30986bad418c88172699b3172d20f9f62a75
+  metadata.gz: c9ee25b554e51484e4cba96070677c90e3cbad17da49eef2e2f649ad4d4ff125e8e2982cfb6e952444436d7ead6f603f6173ba1270b7112b3de75126cb57b318
+  data.tar.gz: e6038eff74531eb7c0561437cb676336853d9a597b588d07a9561a4561ef165a3ad2f528711b3a2f5d61ebfc8df341ef93ec4d15274fb7efcc88859abc1bc6c3

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,30 +1,30 @@
 PATH
   remote: .
   specs:
-    gitlab-exporter (10.0.0)
-      connection_pool (~> 2.2.1)
-      pg (~> 1.1)
-      puma (~> 5.1.1)
-      quantile (~> 0.2.0)
-      redis (~> 4.1.2)
-      redis-namespace (~> 1.6.0)
-      sidekiq (~> 5.2.1)
-      sinatra (~> 2.0.4)
+    gitlab-exporter (10.5.0)
+      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/
   specs:
     ast (2.4.1)
-    connection_pool (2.2.3)
+    connection_pool (2.2.5)
     diff-lcs (1.3)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
-    nio4r (2.5.4)
+    nio4r (2.5.7)
     parallel (1.20.1)
     parser (3.0.0.0)
       ast (~> 2.4.1)
     pg (1.2.3)
-    puma (5.1.1)
+    puma (5.3.2)
       nio4r (~> 2.0)
     quantile (0.2.1)
     rack (2.2.3)

data/README.md

@@ -33,23 +33,6 @@ metrics.
     * [git pull/push timings](lib/gitlab_exporter/git.rb) --
       `git_pull_time_milliseconds`, `git_push_time_milliseconds`
     * git processes stats (see Process below)
-1. [Process](lib/gitlab_exporter/process.rb)
-    * CPU time -- `process_cpu_seconds_total`
-    * Start time -- `process_start_time_seconds`
-    * Count -- `process_count`
-    * Memory usage
-      * Data from /proc/<pid>/cmdline:
-        * `process_resident_memory_bytes`
-        * `process_virtual_memory_bytes`
-      * Data from /proc/<pid>/smaps -- `probe_smaps` (off by default):
-        * `process_smaps_size_bytes`
-        * `process_smaps_rss_bytes`
-        * `process_smaps_shared_clean_bytes`
-        * `process_smaps_shared_dirty_bytes`
-        * `process_smaps_private_clean_bytes`
-        * `process_smaps_private_dirty_bytes`
-        * `process_smaps_swap_bytes`
-        * `process_smaps_pss_bytes`
 1. [Sidekiq](lib/gitlab_exporter/sidekiq.rb)
 	* Stats
 	  * `sidekiq_jobs_processed_total`

data/bin/gitlab-exporter

@@ -3,6 +3,7 @@
 $LOAD_PATH.unshift File.expand_path("../lib", __dir__)
 
 require "rubygems"
+require "bundler"
 require "bundler/setup"
 require "optparse"
 require "gitlab_exporter"

data/config/gitlab-exporter.yml.example

@@ -46,7 +46,6 @@ probes:
       <<: *db_common
       opts:
         <<: *db_common_opts
-        allowed_repeated_commands_count: 2
         created_builds_counting_disabled: true
         unarchived_traces_offset_minutes: 1440
     tuple_stats:
@@ -79,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.1.1"
-  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|

data/lib/gitlab_exporter/database/ci_builds.rb

@@ -147,100 +147,6 @@ module GitLab
             SELECT COUNT(*) FROM licenses
           SQL
 
-        REPEATED_COMMANDS_QUERY_EE =
-          <<~SQL.freeze
-            SELECT
-              subquery.namespace_id,
-              subquery.shared_runners_enabled,
-              subquery.project_id,
-              subquery.status,
-              subquery.has_minutes,
-              MAX(subquery.count) as count
-            FROM (
-              SELECT
-                projects.namespace_id,
-                projects.shared_runners_enabled,
-                ci_builds.project_id,
-                ci_builds.commit_id,
-                ci_builds.status,
-                (COALESCE(namespaces.shared_runners_minutes_limit, application_settings.shared_runners_minutes, 0) = 0 OR
-                   COALESCE(namespace_statistics.shared_runners_seconds, 0) < COALESCE(namespaces.shared_runners_minutes_limit, application_settings.shared_runners_minutes, 0) * 60) as has_minutes,
-                COUNT(*) AS count
-              FROM ci_builds
-              JOIN projects
-                ON projects.id = ci_builds.project_id
-              JOIN namespaces
-                ON namespaces.id = projects.namespace_id
-              LEFT JOIN namespace_statistics
-                ON namespace_statistics.namespace_id = namespaces.id
-              JOIN application_settings ON (TRUE)
-              WHERE ci_builds.type = 'Ci::Build'
-                AND ci_builds.status IN ('running', 'pending')
-                -- The created_at filter has been introduced for performance reasons only
-                AND ci_builds.created_at > NOW() - INTERVAL '7 days'
-              GROUP BY
-                projects.namespace_id,
-                projects.shared_runners_enabled,
-                ci_builds.project_id,
-                ci_builds.commit_id,
-                ci_builds.status,
-                ci_builds.commands,
-                namespaces.shared_runners_minutes_limit,
-                namespace_statistics.shared_runners_seconds,
-                application_settings.shared_runners_minutes
-              HAVING COUNT(*) > %d
-            ) AS subquery
-            GROUP BY
-              subquery.namespace_id,
-              subquery.shared_runners_enabled,
-              subquery.project_id,
-              subquery.commit_id,
-              subquery.status,
-              subquery.has_minutes
-          SQL
-
-        REPEATED_COMMANDS_QUERY_CE =
-          <<~SQL.freeze
-            SELECT
-              subquery.namespace_id,
-              subquery.shared_runners_enabled,
-              subquery.project_id,
-              subquery.status,
-              MAX(subquery.count) as count
-            FROM (
-              SELECT
-                projects.namespace_id,
-                projects.shared_runners_enabled,
-                ci_builds.project_id,
-                ci_builds.commit_id,
-                ci_builds.status,
-                COUNT(*) AS count
-              FROM ci_builds
-              JOIN projects
-                ON projects.id = ci_builds.project_id
-              JOIN namespaces
-                ON namespaces.id = projects.namespace_id
-              WHERE ci_builds.type = 'Ci::Build'
-                AND ci_builds.status IN ('running', 'pending')
-              -- The created_at filter has been introduced for performance reasons only
-              AND ci_builds.created_at > NOW() - INTERVAL '7 days'
-              GROUP BY
-                projects.namespace_id,
-                projects.shared_runners_enabled,
-                ci_builds.project_id,
-                ci_builds.commit_id,
-                ci_builds.status,
-                ci_builds.commands
-              HAVING COUNT(*) > %d
-            ) AS subquery
-            GROUP BY
-              subquery.namespace_id,
-              subquery.shared_runners_enabled,
-              subquery.project_id,
-              subquery.commit_id,
-              subquery.status
-          SQL
-
         UNARCHIVED_TRACES_QUERY =
           <<~SQL.freeze
             SELECT
@@ -265,7 +171,6 @@ module GitLab
         def initialize(opts, logger: nil)
           super(opts, logger: logger)
 
-          @allowed_repeated_commands_count = opts[:allowed_repeated_commands_count]
           @created_builds_counting_disabled = opts[:created_builds_counting_disabled]
           @unarchived_traces_offset_minutes = opts[:unarchived_traces_offset_minutes]
         end
@@ -276,7 +181,6 @@ module GitLab
           results[:pending_builds] = builds(STATUS_PENDING)
           results[:stale_builds] = stale_builds
           results[:per_runner] = per_runner_builds
-          results[:repeated_commands] = repeated_commands
           results[:unarchived_traces] = unarchived_traces
           results
         end
@@ -335,34 +239,6 @@ module GitLab
           include_ee_fields(values, row)
         end
 
-        def repeated_commands
-          results = []
-
-          query = ee? ? REPEATED_COMMANDS_QUERY_EE : REPEATED_COMMANDS_QUERY_CE
-          query = query % [allowed_repeated_commands_count] # rubocop:disable Style/FormatString
-          exec_query_with_custom_random_page_cost(query).each do |row|
-            results << transform_repeated_commands_row_to_values(row)
-          end
-
-          results
-        rescue PG::UndefinedTable, PG::UndefinedColumn
-          []
-        end
-
-        def allowed_repeated_commands_count
-          @allowed_repeated_commands_count ||= 2
-        end
-
-        def transform_repeated_commands_row_to_values(row)
-          values = { namespace: row["namespace_id"].to_s,
-                     project: row["project_id"].to_s,
-                     shared_runners: row["shared_runners_enabled"] == "t" ? "yes" : "no",
-                     status: row["status"].to_s,
-                     value: row["count"].to_i }
-
-          include_has_minutes_field(values, row)
-        end
-
         def unarchived_traces
           time = Time.now - (unarchived_traces_offset_minutes * 60)
           query = UNARCHIVED_TRACES_QUERY % [time.strftime("%F %T")] # rubocop:disable Style/FormatString
@@ -422,7 +298,6 @@ module GitLab
           @metrics = metrics
 
           collector_opts = { connection_string: opts[:connection_string],
-                             allowed_repeated_commands_count: opts[:allowed_repeated_commands_count],
                              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)
@@ -435,7 +310,6 @@ module GitLab
           ci_builds_metrics(@results[:pending_builds], "ci_pending_builds")
           ci_stale_builds_metrics
           metrics_per_runner
-          repeated_commands_metrics
           unarchived_traces_metrics
 
           self
@@ -520,14 +394,6 @@ module GitLab
           @metrics.add(metric_name, value.to_f, selected_labels)
         end
 
-        def repeated_commands_metrics
-          @results[:repeated_commands].each do |metric|
-            value = metric.delete(:value)
-
-            @metrics.add("ci_repeated_commands_builds", value.to_f, metric)
-          end
-        end
-
         def unarchived_traces_metrics
           @metrics.add("ci_unarchived_traces", @results[:unarchived_traces].to_f)
         end

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

@@ -10,6 +10,13 @@ module GitLab
       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
 
       # This timeout is configured to higher interval than scrapping
@@ -17,6 +24,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)
@@ -62,6 +72,13 @@ module GitLab
         self
       end
 
+      # Count worker classes present in Sidekiq queues. This uses a Lua
+      # script to find all jobs in all queues. That script will block
+      # all other Redis commands:
+      # https://redis.io/commands/eval#atomicity-of-scripts
+      #
+      # The script is generally fast, but may be slower with very large
+      # queues, which is why this is not enabled by default.
       def probe_jobs
         with_sidekiq do
           job_stats = {}
@@ -84,6 +101,38 @@ module GitLab
         self
       end
 
+      # This does the same as #probe_jobs, but 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.
+      #
+      # DO NOT USE this and probe_jobs together, as they export the same
+      # metric (sidekiq_enqueued_jobs).
+      def probe_jobs_limit
+        with_sidekiq do
+          job_stats = Hash.new(0)
+
+          Sidekiq::Queue.all.each do |queue|
+            Sidekiq.redis do |conn|
+              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
+          end
+
+          job_stats.each do |class_name, count|
+            @metrics.add("sidekiq_enqueued_jobs", count, name: class_name)
+          end
+        end
+
+        self
+      end
+
       def probe_workers
         with_sidekiq do
           worker_stats = Hash.new(0)

data/lib/gitlab_exporter/version.rb

@@ -1,5 +1,5 @@
 module GitLab
   module Exporter
-    VERSION = "10.0.0".freeze
+    VERSION = "10.5.0".freeze
   end
 end

data/spec/database/ci_builds_spec.rb

@@ -10,12 +10,9 @@ describe GitLab::Exporter::Database do
   let(:per_runner_query_ee) { "SELECT ALL RUNNING PER RUNNER EE" }
   let(:per_runner_query_ce) { "SELECT ALL RUNNING PER RUNNER CE" }
   let(:ee_check_query) { "SELECT COUNT(*) FROM licenses" }
-  let(:repeated_commands_query_ee) { "SELECT EE REPEATED COMNANDS %d" }
-  let(:repeated_commands_query_ce) { "SELECT CE REPEATED COMNANDS %d" }
   let(:unarchived_traces_query) { "SELECT UNARCHIVED TRACES %s LIST" }
   let(:connection_pool) { double("connection pool") }
   let(:connection) { double("connection") }
-  let(:allowed_repeated_commands_count) { 5 }
   let(:created_builds_counting_disabled) { true }
   let(:time_now) { Time.new(2019, 4, 9, 6, 30, 0) }
   let(:unarchived_traces_query_time) { "2019-04-09 05:30:00" }
@@ -63,22 +60,6 @@ describe GitLab::Exporter::Database do
   end
   # rubocop:enable Metrics/ParameterLists
 
-  # rubocop:disable Metrics/ParameterLists
-  def repeated_commands_query_row_ee(namespace_id, shared_runners_enabled, project_id, status, has_minutes, count)
-    row = repeated_commands_query_row_ce(namespace_id, shared_runners_enabled, project_id, status, count)
-    row["has_minutes"] = has_minutes
-    row
-  end
-  # rubocop:enable Metrics/ParameterLists
-
-  def repeated_commands_query_row_ce(namespace_id, shared_runners_enabled, project_id, status, count)
-    { "namespace_id" => namespace_id,
-      "shared_runners_enabled" => shared_runners_enabled,
-      "project_id" => project_id,
-      "status" => status,
-      "count" => count }
-  end
-
   before do
     stub_const("GitLab::Exporter::Database::CiBuildsCollector::SET_RANDOM_PAGE_COST", set_random_page_cost_query)
     stub_const("GitLab::Exporter::Database::CiBuildsCollector::BUILDS_QUERY_EE", builds_query_ee)
@@ -87,8 +68,6 @@ describe GitLab::Exporter::Database do
     stub_const("GitLab::Exporter::Database::CiBuildsCollector::PER_RUNNER_QUERY_EE", per_runner_query_ee)
     stub_const("GitLab::Exporter::Database::CiBuildsCollector::PER_RUNNER_QUERY_CE", per_runner_query_ce)
     stub_const("GitLab::Exporter::Database::CiBuildsCollector::EE_CHECK_QUERY", ee_check_query)
-    stub_const("GitLab::Exporter::Database::CiBuildsCollector::REPEATED_COMMANDS_QUERY_EE", repeated_commands_query_ee)
-    stub_const("GitLab::Exporter::Database::CiBuildsCollector::REPEATED_COMMANDS_QUERY_CE", repeated_commands_query_ce)
     stub_const("GitLab::Exporter::Database::CiBuildsCollector::UNARCHIVED_TRACES_QUERY", unarchived_traces_query)
 
     allow_any_instance_of(GitLab::Exporter::Database::CiBuildsCollector).to receive(:connection_pool).and_return(connection_pool)
@@ -130,24 +109,6 @@ describe GitLab::Exporter::Database do
                                                     per_runner_query_row_ce(2, "project_type", 3, nil, 3, 5),
                                                     per_runner_query_row_ce(3, "project_type", 4, nil, 3, 5)])
 
-    # rubocop:disable Style/FormatString
-    repeated_commands_query_ee_with_limit = repeated_commands_query_ee % [allowed_repeated_commands_count]
-    repeated_commands_query_ce_with_limit = repeated_commands_query_ce % [allowed_repeated_commands_count]
-    # rubocop:enable Style/FormatString
-
-    allow(connection).to receive(:exec)
-      .with(repeated_commands_query_ee_with_limit)
-      .and_return([repeated_commands_query_row_ee(1, "t", 1, "pending", "t", 10),
-                   repeated_commands_query_row_ee(2, "f", 2, "running", "f", 20),
-                   repeated_commands_query_row_ee(1, "f", 3, "pending", "t", 30),
-                   repeated_commands_query_row_ee(2, "t", 4, "running", "f", 40)])
-    allow(connection).to receive(:exec)
-      .with(repeated_commands_query_ce_with_limit)
-      .and_return([repeated_commands_query_row_ce(1, "t", 1, "pending", 10),
-                   repeated_commands_query_row_ce(2, "f", 2, "running", 20),
-                   repeated_commands_query_row_ce(1, "f", 3, "pending", 30),
-                   repeated_commands_query_row_ce(2, "t", 4, "running", 40)])
-
     unarchived_traces_query_with_time = unarchived_traces_query % [unarchived_traces_query_time] # rubocop:disable Style/FormatString
 
     allow(connection).to receive(:exec).with(unarchived_traces_query_with_time).and_return([{ "count" => 10 }])
@@ -156,7 +117,6 @@ describe GitLab::Exporter::Database do
   describe GitLab::Exporter::Database::CiBuildsCollector do
     let(:collector) do
       described_class.new(connection_string: "host=localhost",
-                          allowed_repeated_commands_count: allowed_repeated_commands_count,
                           created_builds_counting_disabled: created_builds_counting_disabled,
                           unarchived_traces_offset_minutes: unarchived_traces_offset_minutes)
     end
@@ -195,10 +155,6 @@ describe GitLab::Exporter::Database do
         expect(subject[:stale_builds]).to eq(expected_stale_builds)
       end
 
-      it "returns raw repeated_commands data" do
-        expect(subject[:repeated_commands]).to include(*expected_repeated_commands)
-      end
-
       it "returns raw unarchived_traces data" do
         expect(subject[:unarchived_traces]).to eq(expected_unarchived_traces)
       end
@@ -222,12 +178,6 @@ describe GitLab::Exporter::Database do
          { runner: "2", runner_type: "project_type", namespace: "3", mirror: "yes", mirror_trigger_builds: "yes", scheduled: "no", triggered: "yes", has_minutes: "yes", value: 5.0 },
          { runner: "3", runner_type: "project_type", namespace: "4", mirror: "yes", mirror_trigger_builds: "yes", scheduled: "no", triggered: "yes", has_minutes: "no", value: 5.0 }]
       end
-      let(:expected_repeated_commands) do
-        [{ namespace: "1", project: "1", shared_runners: "yes", status: "pending", has_minutes: "yes", value: 10.0 },
-         { namespace: "2", project: "2", shared_runners: "no", status: "running", has_minutes: "no", value: 20.0 },
-         { namespace: "1", project: "3", shared_runners: "no", status: "pending", has_minutes: "yes", value: 30.0 },
-         { namespace: "2", project: "4", shared_runners: "yes", status: "running", has_minutes: "no", value: 40.0 }]
-      end
 
       before do
         stub_ee
@@ -254,12 +204,6 @@ describe GitLab::Exporter::Database do
          { runner: "2", runner_type: "project_type", namespace: "3", scheduled: "no", triggered: "yes", value: 5 },
          { runner: "3", runner_type: "project_type", namespace: "4", scheduled: "no", triggered: "yes", value: 5 }]
       end
-      let(:expected_repeated_commands) do
-        [{ namespace: "1", project: "1", shared_runners: "yes", status: "pending", value: 10 },
-         { namespace: "2", project: "2", shared_runners: "no", status: "running", value: 20 },
-         { namespace: "1", project: "3", shared_runners: "no", status: "pending", value: 30 },
-         { namespace: "2", project: "4", shared_runners: "yes", status: "running", value: 40 }]
-      end
 
       before do
         stub_ce
@@ -273,7 +217,6 @@ describe GitLab::Exporter::Database do
     let(:writer) { StringIO.new }
     let(:prober) do
       opts = { connection_string: "host=localhost",
-               allowed_repeated_commands_count: allowed_repeated_commands_count,
                created_builds_counting_disabled: created_builds_counting_disabled,
                unarchived_traces_offset_minutes: unarchived_traces_offset_minutes }
       described_class.new(opts,
@@ -324,12 +267,6 @@ describe GitLab::Exporter::Database do
           end
         end
 
-        it "responds with repeated commands Prometheus metrics" do
-          ci_repeated_commands_builds_lines.each do |expected_line|
-            expect(subject).to match(Regexp.new("^#{expected_line}$", Regexp::MULTILINE))
-          end
-        end
-
         it "responds with stale builds Prometheus metrics" do
           expect(subject).to match(/^ci_stale_builds 2.0$/m)
         end
@@ -372,12 +309,6 @@ describe GitLab::Exporter::Database do
          'ci_running_builds\{has_minutes="yes",mirror="yes",mirror_trigger_builds="yes",namespace="",runner="2",runner_type="project_type",scheduled="no",triggered="yes"\} 5.0',
          'ci_running_builds\{has_minutes="no",mirror="yes",mirror_trigger_builds="yes",namespace="",runner="3",runner_type="project_type",scheduled="no",triggered="yes"\} 5.0']
       end
-      let(:ci_repeated_commands_builds_lines) do
-        ['ci_repeated_commands_builds\{namespace="1",project="1",shared_runners="yes",status="pending",has_minutes="yes"\} 10.0',
-         'ci_repeated_commands_builds\{namespace="2",project="2",shared_runners="no",status="running",has_minutes="no"\} 20.0',
-         'ci_repeated_commands_builds\{namespace="1",project="3",shared_runners="no",status="pending",has_minutes="yes"\} 30.0',
-         'ci_repeated_commands_builds\{namespace="2",project="4",shared_runners="yes",status="running",has_minutes="no"\} 40.0']
-      end
       let(:namespace_out_of_limit) { 2 }
 
       before do
@@ -403,12 +334,6 @@ describe GitLab::Exporter::Database do
          'ci_running_builds\{namespace="",runner="2",runner_type="project_type",scheduled="no",triggered="yes"\} 10.0',
          'ci_running_builds\{namespace="",runner="3",runner_type="project_type",scheduled="no",triggered="yes"\} 5.0']
       end
-      let(:ci_repeated_commands_builds_lines) do
-        ['ci_repeated_commands_builds\{namespace="1",project="1",shared_runners="yes",status="pending"\} 10.0',
-         'ci_repeated_commands_builds\{namespace="2",project="2",shared_runners="no",status="running"\} 20.0',
-         'ci_repeated_commands_builds\{namespace="1",project="3",shared_runners="no",status="pending"\} 30.0',
-         'ci_repeated_commands_builds\{namespace="2",project="4",shared_runners="yes",status="running"\} 40.0']
-      end
       let(:namespace_out_of_limit) { 0 }
 
       before do

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.0.0
+  version: 10.5.0
 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.1.1
+        version: 5.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 5.1.1
+        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