gitlab-exporter 16.4.1 → 16.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddf051049df2fc97f6075da3453f40c99dbd5924613e52f7613f68f4061369d1
-  data.tar.gz: 2e5d19430d6de12d9ef679a74719e0047671955edf2a7a5cfbfa16128920493e
+  metadata.gz: 741207042e803e24cf2a73e9c622606dc6814a7f335a1e512940977afac6d049
+  data.tar.gz: 27e0ec1192f33b5835e61ddd2a86df4c131673f2c46b11217648c6edc274e64b
 SHA512:
-  metadata.gz: 62fe67971ee82117f04fa6189867450469f67ba2818719ec4f0bec39a601cce5a47bfcecbaab02ce22c4f07fd16094a8e12d6fee258611555fd6f2605ae3f209
-  data.tar.gz: 706d36baae273e77e2211ade5dec5848316f1d5a473c33aa89e7e11ce20814bc5ffbd83735f3f20c1090c072b4fed5f4f056ab2472c2bd1ef2096b08f018151c
+  metadata.gz: 9c5f33d6126b18c3da6ae392c5959ee6ca8b361b9af93e24fd5d9f07aa296d4dfd53717bb87fa05496570b3480b4d19ee3512e22ea6a13931a7234e4d1f5f6c6
+  data.tar.gz: 3df0acd00f63f87a674907a70e65b4be172be997c323bfd5c36d3d56fc89cbe7ee72e108c395e674b1075a4618a10befab07ae4b158008c91a102475107d89ce

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab-exporter (16.4.1)
+    gitlab-exporter (16.6.0)
       connection_pool (= 2.5.5)
       deep_merge (~> 1.2.2)
       faraday (= 2.14.0)

data/lib/gitlab_exporter/database/zoekt.rb

@@ -62,13 +62,51 @@ module GitLab
           LIMIT 1
         SQL
 
+        ZOEKT_NODE_STORAGE_QUERY = <<~SQL.freeze
+          SELECT
+            id,
+            metadata ->> 'name' AS node_name,
+            unclaimed_storage_bytes,
+            storage_percent_used
+          FROM zoekt_nodes
+        SQL
+
+        ZOEKT_REPOSITORIES_STATE_QUERY = <<~SQL.freeze
+          SELECT state, COUNT(*) FROM zoekt_repositories GROUP BY state
+        SQL
+
+        ZOEKT_INDICES_STATE_QUERY = <<~SQL.freeze
+          SELECT state, COUNT(*) FROM zoekt_indices GROUP BY state
+        SQL
+
+        ZOEKT_INDICES_WATERMARK_QUERY = <<~SQL.freeze
+          SELECT watermark_level, COUNT(*) FROM zoekt_indices GROUP BY watermark_level
+        SQL
+
+        ZOEKT_INDICES_STORAGE_QUERY = <<~SQL.freeze
+          SELECT
+            zoekt_indices.id,
+            zoekt_indices.reserved_storage_bytes,
+            zoekt_indices.used_storage_bytes,
+            zoekt_nodes.metadata ->> 'name' AS node_name
+          FROM
+            zoekt_indices
+          INNER JOIN
+            zoekt_nodes ON zoekt_indices.zoekt_node_id = zoekt_nodes.id
+        SQL
+
         def run
           return {} unless zoekt_indexing_enabled?
 
           {
             task_processing_query_result: execute(ZOEKT_TASKS_PROCESSING_QUERY, [Time.now.utc]),
             repositories_schema_version_query_result: repositories_schema_version_query_result,
-            zoekt_nodes_status_query_result: execute(ZOEKT_NODES_STATUS_QUERY)
+            zoekt_nodes_status_query_result: execute(ZOEKT_NODES_STATUS_QUERY),
+            node_storage_query_result: execute(ZOEKT_NODE_STORAGE_QUERY),
+            repositories_state_query_result: execute(ZOEKT_REPOSITORIES_STATE_QUERY),
+            indices_state_query_result: execute(ZOEKT_INDICES_STATE_QUERY),
+            indices_watermark_query_result: execute(ZOEKT_INDICES_WATERMARK_QUERY),
+            indices_storage_query_result: execute(ZOEKT_INDICES_STORAGE_QUERY)
           }.compact
         end
 
@@ -131,6 +169,7 @@ module GitLab
       end
 
       # The prober which is called when gathering metrics
+      # rubocop:disable Metrics/ClassLength
       class ZoektProber
         PrometheusMetrics.describe(
           "search_zoekt_task_processing_queue_size",
@@ -150,6 +189,48 @@ module GitLab
           "gauge"
         )
 
+        PrometheusMetrics.describe(
+          "search_zoekt_node_unclaimed_storage_bytes",
+          "Unclaimed storage bytes for Zoekt node",
+          "gauge"
+        )
+
+        PrometheusMetrics.describe(
+          "search_zoekt_node_storage_percent_used",
+          "Fraction of storage used on Zoekt node (0..1)",
+          "gauge"
+        )
+
+        PrometheusMetrics.describe(
+          "search_zoekt_repositories_states_total",
+          "Number of Zoekt repositories in each state",
+          "gauge"
+        )
+
+        PrometheusMetrics.describe(
+          "search_zoekt_indices_states",
+          "Number of Zoekt indices in each state",
+          "gauge"
+        )
+
+        PrometheusMetrics.describe(
+          "search_zoekt_indices_watermark_levels",
+          "Number of Zoekt indices in each watermark level",
+          "gauge"
+        )
+
+        PrometheusMetrics.describe(
+          "search_zoekt_indices_reserved_storage_bytes",
+          "Reserved storage bytes for each Zoekt index",
+          "gauge"
+        )
+
+        PrometheusMetrics.describe(
+          "search_zoekt_indices_used_storage_bytes",
+          "Used storage bytes for each Zoekt index",
+          "gauge"
+        )
+
         def initialize(metrics: PrometheusMetrics.new, **opts)
           @metrics = metrics
           @collector = opts[:collector] || ZoektCollector.new(**opts)
@@ -157,21 +238,60 @@ module GitLab
 
         def probe_db
           results = @collector.run
-          results[:task_processing_query_result].to_a.each do |row|
-            add_processing_zoekt_tasks_to_metric(row)
-          end
-          results[:repositories_schema_version_query_result]&.each do |row|
-            add_zoekt_repositories_by_schema_version_to_metric(row)
-          end
-          results[:zoekt_nodes_status_query_result]&.each do |row|
-            add_zoekt_nodes_status_to_metric(row)
-          end
-
+          process_results(results)
           self
         rescue PG::ConnectionBad
           self
         end
 
+        private
+
+        def process_results(results)
+          process_task_results(results[:task_processing_query_result])
+          process_repository_results(results[:repositories_schema_version_query_result])
+          process_node_status_results(results[:zoekt_nodes_status_query_result])
+          process_node_storage_results(results[:node_storage_query_result])
+          process_repositories_state_results(results[:repositories_state_query_result])
+          process_indices_state_results(results[:indices_state_query_result])
+          process_indices_watermark_results(results[:indices_watermark_query_result])
+          process_indices_storage_results(results[:indices_storage_query_result])
+        end
+
+        def process_task_results(results)
+          results.to_a.each { |row| add_processing_zoekt_tasks_to_metric(row) }
+        end
+
+        def process_repository_results(results)
+          results&.each { |row| add_zoekt_repositories_by_schema_version_to_metric(row) }
+        end
+
+        def process_node_status_results(results)
+          results&.each { |row| add_zoekt_nodes_status_to_metric(row) }
+        end
+
+        def process_node_storage_results(results)
+          results&.each do |row|
+            add_zoekt_node_unclaimed_storage_to_metric(row)
+            add_zoekt_node_storage_percent_used_to_metric(row)
+          end
+        end
+
+        def process_repositories_state_results(results)
+          results&.each { |row| add_zoekt_repositories_state_to_metric(row) }
+        end
+
+        def process_indices_state_results(results)
+          results&.each { |row| add_zoekt_indices_state_to_metric(row) }
+        end
+
+        def process_indices_watermark_results(results)
+          results&.each { |row| add_zoekt_indices_watermark_to_metric(row) }
+        end
+
+        def process_indices_storage_results(results)
+          results&.each { |row| add_zoekt_indices_storage_to_metric(row) }
+        end
+
         def add_processing_zoekt_tasks_to_metric(row)
           @metrics.add(
             "search_zoekt_task_processing_queue_size",
@@ -206,10 +326,84 @@ module GitLab
           )
         end
 
+        def add_zoekt_node_unclaimed_storage_to_metric(row)
+          @metrics.add(
+            "search_zoekt_node_unclaimed_storage_bytes",
+            row["unclaimed_storage_bytes"].to_i,
+            **{
+              zoekt_node_id: row["id"],
+              zoekt_node_name: row["node_name"]
+            }.compact
+          )
+        end
+
+        def add_zoekt_node_storage_percent_used_to_metric(row)
+          @metrics.add(
+            "search_zoekt_node_storage_percent_used",
+            row["storage_percent_used"].to_f,
+            **{
+              zoekt_node_id: row["id"],
+              zoekt_node_name: row["node_name"]
+            }.compact
+          )
+        end
+
+        def add_zoekt_repositories_state_to_metric(row)
+          @metrics.add(
+            "search_zoekt_repositories_states_total",
+            row["count"].to_i,
+            **{
+              state: row["state"]
+            }.compact
+          )
+        end
+
+        def add_zoekt_indices_state_to_metric(row)
+          @metrics.add(
+            "search_zoekt_indices_states",
+            row["count"].to_i,
+            **{
+              state: row["state"]
+            }.compact
+          )
+        end
+
+        def add_zoekt_indices_watermark_to_metric(row)
+          @metrics.add(
+            "search_zoekt_indices_watermark_levels",
+            row["count"].to_i,
+            **{
+              watermark_level: row["watermark_level"]
+            }.compact
+          )
+        end
+
+        # rubocop:disable Metrics/MethodLength
+        def add_zoekt_indices_storage_to_metric(row)
+          @metrics.add(
+            "search_zoekt_indices_reserved_storage_bytes",
+            row["reserved_storage_bytes"].to_i,
+            **{
+              zoekt_index_id: row["id"],
+              zoekt_node_name: row["node_name"]
+            }.compact
+          )
+          @metrics.add(
+            "search_zoekt_indices_used_storage_bytes",
+            row["used_storage_bytes"].to_i,
+            **{
+              zoekt_index_id: row["id"],
+              zoekt_node_name: row["node_name"]
+            }.compact
+          )
+        end
+        # rubocop:enable Metrics/MethodLength
+
         def write_to(target)
           target.write(@metrics.to_s)
         end
       end
+      # rubocop:enable Metrics/ClassLength
     end
   end
 end

data/lib/gitlab_exporter/version.rb

@@ -1,5 +1,5 @@
 module GitLab
   module Exporter
-    VERSION = "16.4.1".freeze
+    VERSION = "16.6.0".freeze
   end
 end

data/spec/database/zoekt_spec.rb

@@ -11,6 +11,31 @@ describe GitLab::Exporter::Database::ZoektCollector do
   let(:zoekt_repository_schema_version_query) { described_class::ZOEKT_REPOSITORY_SCHEMA_VERSION_QUERY }
   let(:zoekt_nodes_status_query) { described_class::ZOEKT_NODES_STATUS_QUERY }
   let(:zoekt_nodes_status_query_results) { [{ "id" => "1", "name" => "foo", "status" => "1" }] }
+  let(:zoekt_node_storage_query) { described_class::ZOEKT_NODE_STORAGE_QUERY }
+  let(:zoekt_node_storage_query_results) do
+    [{ "id" => "1", "node_name" => "foo", "unclaimed_storage_bytes" => "1000000", "storage_percent_used" => "0.75" }]
+  end
+  let(:zoekt_repositories_state_query) { described_class::ZOEKT_REPOSITORIES_STATE_QUERY }
+  let(:zoekt_repositories_state_query_results) do
+    [{ "state" => "0", "count" => "5" }, { "state" => "10", "count" => "15" }]
+  end
+  let(:zoekt_indices_state_query) { described_class::ZOEKT_INDICES_STATE_QUERY }
+  let(:zoekt_indices_state_query_results) do
+    [{ "state" => "0", "count" => "3" }, { "state" => "1", "count" => "7" }]
+  end
+  let(:zoekt_indices_watermark_query) { described_class::ZOEKT_INDICES_WATERMARK_QUERY }
+  let(:zoekt_indices_watermark_query_results) do
+    [{ "watermark_level" => "healthy", "count" => "8" }, { "watermark_level" => "warning", "count" => "2" }]
+  end
+  let(:zoekt_indices_storage_query) { described_class::ZOEKT_INDICES_STORAGE_QUERY }
+  let(:zoekt_indices_storage_query_results) do
+    [
+      { "id" => "1", "reserved_storage_bytes" => "1000000", "used_storage_bytes" => "500000",
+        "node_name" => "zoekt-1" },
+      { "id" => "2", "reserved_storage_bytes" => "2000000", "used_storage_bytes" => "1500000",
+        "node_name" => "zoekt-2" }
+    ]
+  end
 
   let(:zoekt_repository_schema_version_query_results) { [{ "count" => "1" }] }
 
@@ -50,7 +75,12 @@ describe GitLab::Exporter::Database::ZoektCollector do
       {
         repositories_schema_version_query_result: zoekt_repositories_schema_version_query_results,
         task_processing_query_result: zoekt_tasks_processing_query_results,
-        zoekt_nodes_status_query_result: zoekt_nodes_status_query_results
+        zoekt_nodes_status_query_result: zoekt_nodes_status_query_results,
+        node_storage_query_result: zoekt_node_storage_query_results,
+        repositories_state_query_result: zoekt_repositories_state_query_results,
+        indices_state_query_result: zoekt_indices_state_query_results,
+        indices_watermark_query_result: zoekt_indices_watermark_query_results,
+        indices_storage_query_result: zoekt_indices_storage_query_results
       }
     end
 
@@ -82,6 +112,16 @@ describe GitLab::Exporter::Database::ZoektCollector do
                                                    .and_return(zoekt_repository_schema_version_query_results)
         expect(connection).to receive(:exec_params).with(zoekt_nodes_status_query, [])
                                                    .and_return(zoekt_nodes_status_query_results)
+        expect(connection).to receive(:exec_params).with(zoekt_node_storage_query, [])
+                                                   .and_return(zoekt_node_storage_query_results)
+        expect(connection).to receive(:exec_params).with(zoekt_repositories_state_query, [])
+                                                   .and_return(zoekt_repositories_state_query_results)
+        expect(connection).to receive(:exec_params).with(zoekt_indices_state_query, [])
+                                                   .and_return(zoekt_indices_state_query_results)
+        expect(connection).to receive(:exec_params).with(zoekt_indices_watermark_query, [])
+                                                   .and_return(zoekt_indices_watermark_query_results)
+        expect(connection).to receive(:exec_params).with(zoekt_indices_storage_query, [])
+                                                   .and_return(zoekt_indices_storage_query_results)
 
         expect(collector.run).to eq(result)
       end
@@ -94,6 +134,16 @@ describe GitLab::Exporter::Database::ZoektCollector do
                                                     .and_raise(PG::UndefinedTable)
           allow(connection).to receive(:exec_params).with(zoekt_nodes_status_query, [])
                                                     .and_raise(PG::UndefinedTable)
+          allow(connection).to receive(:exec_params).with(zoekt_node_storage_query, [])
+                                                    .and_raise(PG::UndefinedTable)
+          allow(connection).to receive(:exec_params).with(zoekt_repositories_state_query, [])
+                                                    .and_raise(PG::UndefinedTable)
+          allow(connection).to receive(:exec_params).with(zoekt_indices_state_query, [])
+                                                    .and_raise(PG::UndefinedTable)
+          allow(connection).to receive(:exec_params).with(zoekt_indices_watermark_query, [])
+                                                    .and_raise(PG::UndefinedTable)
+          allow(connection).to receive(:exec_params).with(zoekt_indices_storage_query, [])
+                                                    .and_raise(PG::UndefinedTable)
 
           expect(collector.run).to eq({})
         end
@@ -108,6 +158,15 @@ describe GitLab::Exporter::Database::ZoektCollector do
           expect(connection).to receive(:exec_params).with(zoekt_repository_schema_version_query, %w[1 2302])
                                                      .and_raise(PG::UndefinedTable)
           expect(connection).to receive(:exec_params).with(zoekt_nodes_status_query, []).and_raise(PG::UndefinedTable)
+          expect(connection).to receive(:exec_params).with(zoekt_node_storage_query, []).and_raise(PG::UndefinedColumn)
+          expect(connection).to receive(:exec_params).with(zoekt_repositories_state_query, [])
+                                                     .and_raise(PG::UndefinedColumn)
+          expect(connection).to receive(:exec_params).with(zoekt_indices_state_query, [])
+                                                     .and_raise(PG::UndefinedColumn)
+          expect(connection).to receive(:exec_params).with(zoekt_indices_watermark_query, [])
+                                                     .and_raise(PG::UndefinedColumn)
+          expect(connection).to receive(:exec_params).with(zoekt_indices_storage_query, [])
+                                                     .and_raise(PG::UndefinedColumn)
 
           expect(collector.run).to eq({ task_processing_query_result: zoekt_tasks_processing_query_results })
         end
@@ -143,6 +202,34 @@ describe GitLab::Exporter::Database::ZoektProber do
       task_processing_query_result: [
         { "node_id" => "1", "node_name" => "zoekt-1", "task_count" => "5" },
         { "node_id" => "2", "node_name" => "zoekt-2", "task_count" => "10" }
+      ],
+      node_storage_query_result: [
+        {
+          "id" => "1", "node_name" => "zoekt-1", "unclaimed_storage_bytes" => "1000000",
+          "storage_percent_used" => "0.75"
+        },
+        {
+          "id" => "2", "node_name" => "zoekt-2", "unclaimed_storage_bytes" => "2000000",
+          "storage_percent_used" => "0.50"
+        }
+      ],
+      repositories_state_query_result: [
+        { "state" => "0", "count" => "5" },
+        { "state" => "10", "count" => "15" }
+      ],
+      indices_state_query_result: [
+        { "state" => "0", "count" => "3" },
+        { "state" => "1", "count" => "7" }
+      ],
+      indices_watermark_query_result: [
+        { "watermark_level" => "healthy", "count" => "8" },
+        { "watermark_level" => "warning", "count" => "2" }
+      ],
+      indices_storage_query_result: [
+        { "id" => "1", "reserved_storage_bytes" => "1000000", "used_storage_bytes" => "500000",
+          "node_name" => "zoekt-1" },
+        { "id" => "2", "reserved_storage_bytes" => "2000000", "used_storage_bytes" => "1500000",
+          "node_name" => "zoekt-2" }
       ]
     }
   end
@@ -186,6 +273,67 @@ describe GitLab::Exporter::Database::ZoektProber do
           )
       end
 
+      data[:node_storage_query_result].each do |node_data|
+        expect(metrics).to receive(:add)
+          .with(
+            "search_zoekt_node_unclaimed_storage_bytes",
+            node_data["unclaimed_storage_bytes"].to_i,
+            zoekt_node_id: node_data["id"],
+            zoekt_node_name: node_data["node_name"]
+          )
+        expect(metrics).to receive(:add)
+          .with(
+            "search_zoekt_node_storage_percent_used",
+            node_data["storage_percent_used"].to_f,
+            zoekt_node_id: node_data["id"],
+            zoekt_node_name: node_data["node_name"]
+          )
+      end
+
+      data[:repositories_state_query_result].each do |state_data|
+        expect(metrics).to receive(:add)
+          .with(
+            "search_zoekt_repositories_states_total",
+            state_data["count"].to_i,
+            state: state_data["state"]
+          )
+      end
+
+      data[:indices_state_query_result].each do |state_data|
+        expect(metrics).to receive(:add)
+          .with(
+            "search_zoekt_indices_states",
+            state_data["count"].to_i,
+            state: state_data["state"]
+          )
+      end
+
+      data[:indices_watermark_query_result].each do |watermark_data|
+        expect(metrics).to receive(:add)
+          .with(
+            "search_zoekt_indices_watermark_levels",
+            watermark_data["count"].to_i,
+            watermark_level: watermark_data["watermark_level"]
+          )
+      end
+
+      data[:indices_storage_query_result].each do |storage_data|
+        expect(metrics).to receive(:add)
+          .with(
+            "search_zoekt_indices_reserved_storage_bytes",
+            storage_data["reserved_storage_bytes"].to_i,
+            zoekt_index_id: storage_data["id"],
+            zoekt_node_name: storage_data["node_name"]
+          )
+        expect(metrics).to receive(:add)
+          .with(
+            "search_zoekt_indices_used_storage_bytes",
+            storage_data["used_storage_bytes"].to_i,
+            zoekt_index_id: storage_data["id"],
+            zoekt_node_name: storage_data["node_name"]
+          )
+      end
+
       probe_db
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-exporter
 version: !ruby/object:Gem::Version
-  version: 16.4.1
+  version: 16.6.0
 platform: ruby
 authors:
 - Pablo Carranza