Merge branch '63044-cluster-health-group-refactor' into 'master'

Refactor common_metrics importer into a more extensible pattern

Closes #63044

See merge request gitlab-org/gitlab-ce!30012

4 files changed, 138 insertions, 0 deletions

diff --git a/lib/gitlab/database_importers/common_metrics.rb b/lib/gitlab/database_importers/common_metrics.rb
new file mode 100644
index 00000000000..f964ae8a275
--- /dev/null
+++ b/lib/gitlab/database_importers/common_metrics.rb
@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module DatabaseImporters
+    module CommonMetrics
+    end
+  end
+end
diff --git a/lib/gitlab/database_importers/common_metrics/importer.rb b/lib/gitlab/database_importers/common_metrics/importer.rb
new file mode 100644
index 00000000000..6c61e05674e
--- /dev/null
+++ b/lib/gitlab/database_importers/common_metrics/importer.rb
@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module DatabaseImporters
+    module CommonMetrics
+      class Importer
+        MissingQueryId = Class.new(StandardError)
+
+        attr_reader :content
+
+        def initialize(filename = 'common_metrics.yml')
+          @content = YAML.load_file(Rails.root.join('config', 'prometheus', filename))
+        end
+
+        def execute
+          CommonMetrics::PrometheusMetric.reset_column_information
+
+          process_content do |id, attributes|
+            find_or_build_metric!(id)
+              .update!(**attributes)
+          end
+        end
+
+        private
+
+        def process_content(&blk)
+          content['panel_groups'].map do |group|
+            process_group(group, &blk)
+          end
+        end
+
+        def process_group(group, &blk)
+          attributes = {
+            group: find_group_title_key(group['group'])
+          }
+
+          group['panels'].map do |panel|
+            process_panel(panel, attributes, &blk)
+          end
+        end
+
+        def process_panel(panel, attributes, &blk)
+          attributes = attributes.merge(
+            title: panel['title'],
+            y_label: panel['y_label'])
+
+          panel['metrics'].map do |metric_details|
+            process_metric_details(metric_details, attributes, &blk)
+          end
+        end
+
+        def process_metric_details(metric_details, attributes, &blk)
+          attributes = attributes.merge(
+            legend: metric_details['label'],
+            query: metric_details['query_range'],
+            unit: metric_details['unit'])
+
+          yield(metric_details['id'], attributes)
+        end
+
+        def find_or_build_metric!(id)
+          raise MissingQueryId unless id
+
+          CommonMetrics::PrometheusMetric.common.find_by(identifier: id) ||
+            CommonMetrics::PrometheusMetric.new(common: true, identifier: id)
+        end
+
+        def find_group_title_key(title)
+          CommonMetrics::PrometheusMetricEnums.groups[find_group_title(title)]
+        end
+
+        def find_group_title(title)
+          CommonMetrics::PrometheusMetricEnums.group_titles.invert[title]
+        end
+      end
+    end
+  end
+end
diff --git a/lib/gitlab/database_importers/common_metrics/prometheus_metric.rb b/lib/gitlab/database_importers/common_metrics/prometheus_metric.rb
new file mode 100644
index 00000000000..b4a392cbea9
--- /dev/null
+++ b/lib/gitlab/database_importers/common_metrics/prometheus_metric.rb
@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module DatabaseImporters
+    module CommonMetrics
+      class PrometheusMetric < ApplicationRecord
+        enum group: PrometheusMetricEnums.groups
+        scope :common, -> { where(common: true) }
+      end
+    end
+  end
+end
diff --git a/lib/gitlab/database_importers/common_metrics/prometheus_metric_enums.rb b/lib/gitlab/database_importers/common_metrics/prometheus_metric_enums.rb
new file mode 100644
index 00000000000..c9e957ec7c0
--- /dev/null
+++ b/lib/gitlab/database_importers/common_metrics/prometheus_metric_enums.rb
@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module DatabaseImporters
+    module CommonMetrics
+      module PrometheusMetricEnums
+        def self.groups
+          {
+            # built-in groups
+            nginx_ingress_vts: -1,
+            ha_proxy: -2,
+            aws_elb: -3,
+            nginx: -4,
+            kubernetes: -5,
+            nginx_ingress: -6,
+
+            # custom groups
+            business: 0,
+            response: 1,
+            system: 2
+          }
+        end
+
+        def self.group_titles
+          {
+            business: _('Business metrics (Custom)'),
+            response: _('Response metrics (Custom)'),
+            system: _('System metrics (Custom)'),
+            nginx_ingress_vts: _('Response metrics (NGINX Ingress VTS)'),
+            nginx_ingress: _('Response metrics (NGINX Ingress)'),
+            ha_proxy: _('Response metrics (HA Proxy)'),
+            aws_elb: _('Response metrics (AWS ELB)'),
+            nginx: _('Response metrics (NGINX)'),
+            kubernetes: _('System metrics (Kubernetes)')
+          }
+        end
+      end
+    end
+  end
+end