gitlab-exporter 15.0.0 → 15.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa3c6ff71709207bbbe1c85dea19eab223c678c721baf437eed2275ad73816b9
-  data.tar.gz: f263b55d0e45ece0a7d3124511c684eacbe78532eae81e2f4c11f3ec4279af9b
+  metadata.gz: 73d7d8a42035a6cb634f0c234e6bcd3e723492f2903663d7ecd0ccacde53279c
+  data.tar.gz: 012ce7e6313ec24c72c605bf016477c75d6de08ec2c37339e0a12c09c64aaa23
 SHA512:
-  metadata.gz: 8db3f5dd5db87f02d7a85fb58c13e8a48df40726c5718fd82d5b7ae792675948bd43664da3f94075527e5242c0dcf8bc5e150f8606611097677a812981d73354
-  data.tar.gz: 9411698d4c809eba8997bd8fc0f9cc4295dac625daa35a8faf37604909a20fde621afb161534bd82fa912087cf50de45e5e192186627cb95f5c8b5643de1742e
+  metadata.gz: dc31a10b7051bb5c76667d817cdd2761cd9ce9b755949567770b390f4362b37722d5658300b63607ff8f2566e577786ddb6e5b8edf3263bbbba3c478d28e08e7
+  data.tar.gz: 96b24d081ca6172197f6bdf44b739b3d053f32f2944378bb09609a02e485a053251c752ad49c921202eeee165437284aea73f875cce06a85edc455fb2d4e573d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab-exporter (15.0.0)
+    gitlab-exporter (15.1.0)
       connection_pool (= 2.2.5)
       deep_merge (~> 1.2.2)
       faraday (>= 1.8.0, <= 2.8.1)

data/README.md

@@ -19,6 +19,9 @@ metrics.
 1. Database
     * [Per-table tuple stats](lib/gitlab_exporter/database/tuple_stats.rb) --
       `gitlab_database_stat_table_*`
+   * [Per-sequence stats](lib/gitlab_exporter/database/pg_sequences.rb) --
+     `gitlab_pg_sequences_min_value`, `gitlab_pg_sequences_max_value`, `gitlab_pg_sequences_current_value`,
+     `gitlab_pg_sequences_saturation_ratio`
     * [Row count queries](lib/gitlab_exporter/database/row_count.rb) --
       `gitlab_database_rows`
     * [CI builds](lib/gitlab_exporter/database/ci_builds.rb) --

data/config/gitlab-exporter.yml.example

@@ -41,6 +41,10 @@ probes:
     class_name: Database::BloatProber
     <<: *db_common
 
+  pg_sequences:
+    class_name: Database::PgSequencesProber
+    <<: *db_common
+
   # We can group multiple probes under a single endpoint by setting the `multiple` key to `true`, followed
   # by probe definitions as usual.
   database:

data/lib/gitlab_exporter/database/pg_sequences.rb

@@ -0,0 +1,60 @@
+module GitLab
+  module Exporter
+    module Database
+      # A helper class to collect sequences metrics. Mainly used to monitor Cells sequences.
+      class PgSequencesCollector < Base
+        QUERY = <<~SQL.freeze
+          SELECT
+            schemaname,
+            sequencename,
+            CONCAT(schemaname, '.', sequencename) AS fully_qualified_sequencename,
+            start_value,
+            min_value,
+            max_value,
+            last_value AS current_value
+          FROM pg_catalog.pg_sequences;
+        SQL
+
+        def run
+          with_connection_pool do |conn|
+            conn.exec(QUERY).each.with_object({}) do |row, stats|
+              stats[row.delete("fully_qualified_sequencename")] = row
+            end
+          end
+        end
+      end
+
+      # The prober which is called when gathering metrics
+      class PgSequencesProber
+        METRIC_NAME = "gitlab_pg_sequences".freeze
+        METRIC_KEYS = %w[min_value max_value current_value].freeze
+
+        def initialize(metrics: PrometheusMetrics.new, **opts)
+          @metrics = metrics
+          @collector = PgSequencesCollector.new(**opts)
+        end
+
+        def probe_db
+          result = @collector.run
+
+          result.each do |fully_qualified_sequencename, sequence_info|
+            METRIC_KEYS.each do |key|
+              value = sequence_info.fetch(key).to_f
+              tags = {
+                schemaname: sequence_info.fetch("schemaname"),
+                sequencename: sequence_info.fetch("sequencename"),
+                fully_qualified_sequencename: fully_qualified_sequencename
+              }
+
+              @metrics.add("#{METRIC_NAME}_#{key}", value, **tags)
+            end
+          end
+
+          self
+        rescue PG::ConnectionBad
+          self
+        end
+      end
+    end
+  end
+end

data/lib/gitlab_exporter/database.rb

@@ -8,6 +8,7 @@ module GitLab
       autoload :RowCountProber,       "gitlab_exporter/database/row_count"
       autoload :BloatProber,          "gitlab_exporter/database/bloat"
       autoload :RemoteMirrorsProber,  "gitlab_exporter/database/remote_mirrors"
+      autoload :PgSequencesProber,    "gitlab_exporter/database/pg_sequences"
     end
   end
 end

data/lib/gitlab_exporter/version.rb

@@ -1,5 +1,5 @@
 module GitLab
   module Exporter
-    VERSION = "15.0.0".freeze
+    VERSION = "15.1.0".freeze
   end
 end

data/spec/database/pg_sequences_spec.rb

@@ -0,0 +1,133 @@
+require "spec_helper"
+require "gitlab_exporter/database/pg_sequences"
+
+describe GitLab::Exporter::Database::PgSequencesCollector do
+  subject { described_class.new(connection_string: "") }
+
+  let(:connection_pool) { double("connection pool") }
+  let(:connection) { double("connection", exec: query_result) }
+  let(:type) { :btree }
+  let(:query_result) do
+    [
+      {
+        "schemaname" => "public",
+        "sequencename" => "seq_one",
+        "fully_qualified_sequencename" => "public.seq_one",
+        "min_value" => 1,
+        "max_value" => 9_223_372_036_854_775_807,
+        "current_value" => 6_223_372_036_854_745_121,
+        "saturation_ratio" => 0.6747e2
+      },
+      {
+        "schemaname" => "public",
+        "sequencename" => "seq_two",
+        "fully_qualified_sequencename" => "public.seq_two",
+        "min_value" => 1,
+        "max_value" => 9_223_372_036_854_775_807,
+        "current_value" => nil,
+        "saturation_ratio" => 0.0
+      }
+    ]
+  end
+
+  before do
+    allow_any_instance_of(described_class).to receive(:connection_pool).and_return(connection_pool)
+    allow(connection_pool).to receive(:with).and_yield(connection)
+  end
+
+  it "converts query results into a hash" do
+    expect(subject.run).to(
+      eq(
+        "public.seq_one" => {
+          "schemaname" => "public",
+          "sequencename" => "seq_one",
+          "min_value" => 1,
+          "max_value" => 9_223_372_036_854_775_807,
+          "current_value" => 6_223_372_036_854_745_121,
+          "saturation_ratio" => 0.6747e2
+        },
+        "public.seq_two" => {
+          "schemaname" => "public",
+          "sequencename" => "seq_two",
+          "min_value" => 1,
+          "max_value" => 9_223_372_036_854_775_807,
+          "current_value" => nil,
+          "saturation_ratio" => 0.0
+        }
+      )
+    )
+  end
+end
+
+describe GitLab::Exporter::Database::PgSequencesProber do
+  subject(:prober) { described_class.new(metrics: metrics, connection_string: "") }
+
+  let(:metrics) { double("PrometheusMetrics", add: nil) }
+  let(:collector) { double("PgSequencesCollector", run: data) }
+  let(:data) do
+    {
+      "public.seq_one" => {
+        "schemaname" => "public",
+        "sequencename" => "seq_one",
+        "min_value" => 1,
+        "max_value" => 10,
+        "current_value" => 2,
+        "saturation_ratio" => 0.2
+      }
+    }
+  end
+
+  describe "#probe_db" do
+    before do
+      allow(GitLab::Exporter::Database::PgSequencesCollector).to receive(:new).and_return(collector)
+    end
+
+    it "properly invokes the collector" do
+      expect(collector).to receive(:run)
+
+      prober.probe_db
+    end
+
+    it "adds min_value metric" do
+      expect(metrics).to(
+        receive(:add).with(
+          "gitlab_pg_sequences_min_value",
+          1.0,
+          schemaname: "public",
+          sequencename: "seq_one",
+          fully_qualified_sequencename: "public.seq_one"
+        )
+      )
+
+      prober.probe_db
+    end
+
+    it "adds max_value metric" do
+      expect(metrics).to(
+        receive(:add).with(
+          "gitlab_pg_sequences_max_value",
+          10.0,
+          schemaname: "public",
+          sequencename: "seq_one",
+          fully_qualified_sequencename: "public.seq_one"
+        )
+      )
+
+      prober.probe_db
+    end
+
+    it "adds current_value metric" do
+      expect(metrics).to(
+        receive(:add).with(
+          "gitlab_pg_sequences_current_value",
+          2.0,
+          schemaname: "public",
+          sequencename: "seq_one",
+          fully_qualified_sequencename: "public.seq_one"
+        )
+      )
+
+      prober.probe_db
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-exporter
 version: !ruby/object:Gem::Version
-  version: 15.0.0
+  version: 15.1.0
 platform: ruby
 authors:
 - Pablo Carranza
@@ -227,6 +227,7 @@ files:
 - lib/gitlab_exporter/database/bloat_btree.sql
 - lib/gitlab_exporter/database/bloat_table.sql
 - lib/gitlab_exporter/database/ci_builds.rb
+- lib/gitlab_exporter/database/pg_sequences.rb
 - lib/gitlab_exporter/database/remote_mirrors.rb
 - lib/gitlab_exporter/database/row_count.rb
 - lib/gitlab_exporter/database/tuple_stats.rb
@@ -247,6 +248,7 @@ files:
 - spec/cli_spec.rb
 - spec/database/bloat_spec.rb
 - spec/database/ci_builds_spec.rb
+- spec/database/pg_sequences_spec.rb
 - spec/database/row_count_spec.rb
 - spec/elasticsearch_spec.rb
 - spec/fixtures/config.yml
@@ -286,6 +288,7 @@ test_files:
 - spec/cli_spec.rb
 - spec/database/bloat_spec.rb
 - spec/database/ci_builds_spec.rb
+- spec/database/pg_sequences_spec.rb
 - spec/database/row_count_spec.rb
 - spec/elasticsearch_spec.rb
 - spec/fixtures/config.yml