gitlab-exporter 6.0.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1378d48a7af04eee678edaa21da6d5795baa5828d0b06853b816e8c6b8e8d489
-  data.tar.gz: e221a2070050abee80662777a94afee1d4369ae8f108583f28f640cc2fc2517b
+  metadata.gz: 61203f2c5d53c61f05151255076c5004c65a254c2445d632ae8c7262ae0e1f82
+  data.tar.gz: 66b13da650dd0e66b3a4d639bf1738de51474e047e0df878893a5b675d158827
 SHA512:
-  metadata.gz: d7c222835cd8bc99f412f95fb17457310857634b4c9c9b9b2ffb3a1f5b7002b05445f6331f4e0cdd74a4319d4bf0730e68070acd043168b65d8bfacf52da1e88
-  data.tar.gz: e4d5aababedf60ee0865f5b9c455011f0941acb2d8ad0bb21bb6c4a2021aeba23ac3d2123238d8cc7932e70bc508dca43f3e396031b57b199c6aff752d86d457
+  metadata.gz: 7ab02d67cc6e2bf4e443e73f49138eb7549961d535a1c7425e7f9a7872ec7095f6ad77522105eee8111c674cbdebbfec304296953c884dd006832d452079414c
+  data.tar.gz: 81bf3b39c8cb1462dabbf51be56057efb9fddfbe0db6da4d6f1f7827f71f4a8cebf04e5890caf07ccaa588b873897dfef32e91d7276361a6fe629349eb2691b0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab-exporter (6.0.0)
+    gitlab-exporter (6.1.0)
       connection_pool (~> 2.2.1)
       pg (~> 1.1)
       quantile (~> 0.2.0)
@@ -23,7 +23,7 @@ GEM
     pg (1.2.2)
     powerpack (0.1.1)
     quantile (0.2.1)
-    rack (2.1.2)
+    rack (2.2.2)
     rack-protection (2.0.8.1)
       rack
     rainbow (2.1.0)

data/config/gitlab-exporter.yml.example

@@ -60,6 +60,9 @@ probes:
         - soft_deleted_projects
         - orphaned_projects
         - uploads
+        - users
+        - projects
+        - groups
     remote_mirrors:
       class_name: Database::RemoteMirrorsProber
       <<: *db_common

data/lib/gitlab_exporter/database/row_count.rb

@@ -79,7 +79,40 @@ module GitLab
             joins: "LEFT JOIN namespaces ON projects.namespace_id = namespaces.id",
             where: "namespaces.id IS NULL"
           },
-          uploads: { select: :uploads }
+          uploads: { select: :uploads },
+          users: {
+            select: :users,
+            joins: "LEFT JOIN
+              (
+                SELECT
+                  members.user_id,
+                  MAX(access_level) as access_level
+                FROM members
+                GROUP BY members.user_id
+              ) AS u
+              ON users.id = u.user_id",
+            where: "ghost IS NULL AND bot_type IS NULL",
+            fields: {
+              admin:        {},
+              external:     {},
+              state:        {},
+              access_level: { definition: "COALESCE(u.access_level, 0)" }
+            }
+          },
+          projects: {
+            select: :projects,
+            fields: {
+              visibility_level: {},
+              archived:         {}
+            }
+          },
+          groups: {
+            select: :namespaces,
+            fields: {
+              visibility_level: {},
+              root:             { definition: "(parent_id IS NULL)" }
+            }
+          }
         }.freeze
 
         def initialize(args)
@@ -105,21 +138,37 @@ module GitLab
 
         def count_from_query_hash(query_hash)
           result = execute(construct_query(query_hash))
-          return 0 unless result
+          return [{ "count": 0, "labels": {} }] unless result
 
-          result[0]["count"]
+          result.map do |row|
+            labels = {}
+            (query_hash[:fields] || []).each do |key, _| labels[key] = row[key.to_s] end
+            { "count": row["count"], "labels": labels }
+          end
         end
 
         def successful_check?(query)
           result = execute("SELECT EXISTS (#{query})")
           return unless result
 
-          result[0]["exists"] == "t"
+          result[0]["exists"]
         end
 
         def execute(query)
           with_connection_pool do |conn|
-            conn.exec(query)
+            tm = PG::BasicTypeMapForResults.new(conn)
+
+            # Remove warning message:
+            # Warning: no type cast defined for type "name" with oid 19.
+            # Please cast this type explicitly to TEXT to be safe for future changes.
+            # Warning: no type cast defined for type "regproc" with oid 24.
+            # Please cast this type explicitly to TEXT to be safe for future changes.
+            [{ "type": "text", "oid": 19 }, { "type": "int4", "oid": 24 }].each do |value|
+              old_coder = tm.coders.find { |c| c.name == value[:type] }
+              tm.add_coder(old_coder.dup.tap { |c| c.oid = value[:oid] })
+            end
+
+            conn.exec(query).map_types!(tm)
           end
         rescue PG::UndefinedTable, PG::UndefinedColumn
           nil
@@ -127,9 +176,16 @@ module GitLab
 
         # Not private so I can test it without meta programming tricks
         def construct_query(query)
-          query_string = "SELECT COUNT(*) FROM #{query[:select]} "
-          query_string << "#{query[:joins]} "       if query[:joins]
-          query_string << "WHERE #{query[:where]}"  if query[:where]
+          query_string = "SELECT COUNT(*)"
+          (query[:fields] || []).each do |key, value|
+            query_string << ", "
+            query_string << "(#{value[:definition]}) AS " if value[:definition]
+            query_string << key.to_s
+          end
+          query_string << " FROM #{query[:select]}"
+          query_string << " #{query[:joins]}"       if query[:joins]
+          query_string << " WHERE #{query[:where]}" if query[:where]
+          query_string << " GROUP BY " + query[:fields].keys.join(", ") if query[:fields]
           query_string << ";"
         end
       end
@@ -146,8 +202,11 @@ module GitLab
 
         def probe_db
           results = @collector.run
-          results.each do |key, value|
-            @metrics.add("gitlab_database_rows", value.to_f, query_name: key.to_s)
+          results.each do |query_name, result|
+            labels = { query_name: query_name.to_s }
+            result.each do |row|
+              @metrics.add("gitlab_database_rows", row[:count].to_f, **labels, **row[:labels])
+            end
           end
 
           self

data/lib/gitlab_exporter/version.rb

@@ -1,5 +1,5 @@
 module GitLab
   module Exporter
-    VERSION = "6.0.0".freeze
+    VERSION = "6.1.0".freeze
   end
 end

data/spec/database/row_count_spec.rb

@@ -4,7 +4,8 @@ require "gitlab_exporter/database/row_count"
 describe GitLab::Exporter::Database::RowCountCollector do
   let(:query) {
     { project_1: { select: :projects, where: "id=1" },
-      project_2: { select: :projects, where: "id=2" } }
+      project_2: { select: :projects, where: "id=2" },
+      project_3: { select: :projects, fields: { is_public: { definition: "visibility_level == 20" } } } }
   }
   let(:collector) { described_class.new(connection_string: "host=localhost") }
 
@@ -12,19 +13,31 @@ describe GitLab::Exporter::Database::RowCountCollector do
     before do
       stub_const("GitLab::Exporter::Database::RowCountCollector::QUERIES", query)
 
-      allow(collector).to receive(:count_from_query_hash).with(query[:project_1]).and_return(3)
-      allow(collector).to receive(:count_from_query_hash).with(query[:project_2]).and_return(6)
+      allow(collector).to receive(:execute).with("SELECT COUNT(*) FROM projects WHERE id=1;").and_return(false)
+      allow(collector).to receive(:execute).with("SELECT COUNT(*) FROM projects WHERE id=2;").and_return(
+        [{ "count" => 6 }]
+      )
+      allow(collector).to receive(:execute).with(
+        "SELECT COUNT(*), (visibility_level == 20) AS is_public FROM projects GROUP BY is_public;"
+      ).and_return(
+        [{ "count" => 3, "is_public" => true }, { "count" => 6, "is_public" => false }]
+      )
     end
 
     it "executes all the queries" do
-      expect(collector.run).to eq(project_1: 3, project_2: 6)
+      expect(collector.run).to eq(
+        project_1: [{ count: 0, labels: {} }],
+        project_2: [{ count: 6, labels: {} }],
+        project_3: [{ count: 3, labels: { is_public: true  } },
+                    { count: 6, labels: { is_public: false } }]
+      )
     end
 
     context "when selected_queries is passed" do
       let(:collector) { described_class.new(connection_string: "host=localhost", selected_queries: ["project_2"]) }
 
       it "executes the selected queries" do
-        expect(collector.run).to eq(project_2: 6)
+        expect(collector.run).to eq(project_2: [{ count: 6, labels: {} }])
       end
     end
   end
@@ -33,5 +46,10 @@ describe GitLab::Exporter::Database::RowCountCollector do
     it "accepts a table and where clause" do
       expect(collector.send(:construct_query, query[:project_1])).to eq "SELECT COUNT(*) FROM projects WHERE id=1;"
     end
+
+    it "accepts a table and group (field) clause" do
+      expect(collector.send(:construct_query, query[:project_3])).to eq \
+        "SELECT COUNT(*), (visibility_level == 20) AS is_public FROM projects GROUP BY is_public;"
+    end
   end
 end

metadata

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