expand Namespaces:: and refactoring yaml parsing out of MetricGroup class

Author: pawelchcki

app/models/environment.rb

@@ -159,7 +159,7 @@ def metrics
 
   def additional_metrics
     if has_additional_metrics?
-      project.monitoring_service.reactive_query(Gitlab::Prometheus::Queries::AdditionalMetricsQuery.name, self.id, &:itself)
+      project.monitoring_service.reactive_query(Gitlab::Prometheus::Queries::AdditionalMetricsEnvironmentQuery.name, self.id, &:itself)
     end
   end
 

lib/gitlab/prometheus/additional_metrics_parser.rb

@@ -0,0 +1,36 @@
+module Gitlab
+  module Prometheus
+    module AdditionalMetricsParser
+      extend self
+
+      def load_groups_from_yaml
+        additional_metrics_raw.map(&method(:new))
+      end
+
+      private
+
+      def metrics_from_list(list)
+        list.map { |entry| metric_from_entry(entry) }
+      end
+
+      def metric_from_entry(entry)
+        missing_fields = [:title, :required_metrics, :weight, :queries].select { |key| !entry.has_key?(key) }
+        raise ParsingError.new("entry missing required fields #{missing_fields}") unless missing_fields.empty?
+
+        Metric.new(entry[:title], entry[:required_metrics], entry[:weight], entry[:y_label], entry[:queries])
+      end
+
+      def group_from_entry(entry)
+        missing_fields = [:group, :priority, :metrics].select { |key| !entry.has_key?(key) }
+        raise ParsingError.new("entry missing required fields #{missing_fields}") unless missing_fields.empty?
+
+        group = MetricGroup.new(entry[:group], entry[:priority])
+        group.tap { |g| g.metrics = Metric.metrics_from_list(entry[:metrics]) }
+      end
+
+      def additional_metrics_raw
+        @additional_metrics_raw ||= YAML.load_file(Rails.root.join('config/additional_metrics.yml'))&.map(&:deep_symbolize_keys).freeze
+      end
+    end
+  end
+end

lib/gitlab/prometheus/metric.rb

@@ -1,24 +1,15 @@
-module Gitlab::Prometheus
-  class Metric
-    attr_reader :group, :title, :required_metrics, :weight, :y_label, :queries
-
-    def initialize(title, required_metrics, weight, y_label, queries = [])
-      @title = title
-      @required_metrics = required_metrics
-      @weight = weight
-      @y_label = y_label || 'Values'
-      @queries = queries
-    end
-
-    def self.metric_from_entry(entry)
-      missing_fields = [:title, :required_metrics, :weight, :queries].select { |key| !entry.has_key?(key) }
-      raise ParsingError.new("entry missing required fields #{missing_fields}") unless missing_fields.empty?
-
-      Metric.new(entry[:title], entry[:required_metrics], entry[:weight], entry[:y_label], entry[:queries])
-    end
-
-    def self.metrics_from_list(list)
-      list.map { |entry| metric_from_entry(entry) }
+module Gitlab
+  module Prometheus
+    class Metric
+      attr_reader :group, :title, :required_metrics, :weight, :y_label, :queries
+
+      def initialize(title, required_metrics, weight, y_label, queries = [])
+        @title = title
+        @required_metrics = required_metrics
+        @weight = weight
+        @y_label = y_label || 'Values'
+        @queries = queries
+      end
     end
   end
 end

lib/gitlab/prometheus/metric_group.rb

@@ -1,33 +1,18 @@
-module Gitlab::Prometheus
-  class MetricGroup
-    attr_reader :priority, :name
-    attr_accessor :metrics
+module Gitlab
+  module Prometheus
+    class MetricGroup
+      attr_reader :priority, :name
+      attr_accessor :metrics
 
-    def initialize(name, priority, metrics = [])
-      @name = name
-      @priority = priority
-      @metrics = metrics
-    end
-
-    def self.all
-      load_groups_from_yaml
-    end
-
-    def self.load_groups_from_yaml
-      additional_metrics_raw.map(&method(:group_from_entry))
-    end
-
-    def self.group_from_entry(entry)
-      missing_fields = [:group, :priority, :metrics].select { |key| !entry.has_key?(key) }
-      raise ParsingError.new("entry missing required fields #{missing_fields}") unless missing_fields.empty?
-
-      group = MetricGroup.new(entry[:group], entry[:priority])
-      group.metrics = Metric.metrics_from_list(entry[:metrics])
-      group
-    end
+      def initialize(name:, priority:, metrics: [])
+        @name = name
+        @priority = priority
+        @metrics = metrics
+      end
 
-    def self.additional_metrics_raw
-      @additional_metrics_raw ||= YAML.load_file(Rails.root.join('config/additional_metrics.yml'))&.map(&:deep_symbolize_keys).freeze
+      def self.all
+        AdditionalMetricsParser.load_groups_from_yaml
+      end
     end
   end
 end

lib/gitlab/prometheus/parsing_error.rb

@@ -1,3 +1,5 @@
-module Gitlab::Prometheus
-  ParsingError = Class.new(StandardError)
+module Gitlab
+  module Prometheus
+    ParsingError = Class.new(StandardError)
+  end
 end

lib/gitlab/prometheus/queries/additional_metrics_deployment_query.rb

@@ -1,15 +1,21 @@
-module Gitlab::Prometheus::Queries
-  class AdditionalMetricsDeploymentQuery < AdditionalMetricsQuery
-    def query(deployment_id)
-      deployment = Deployment.find_by(id: deployment_id)
-      query_context = {
-        environment_slug: deployment.environment.slug,
-        environment_filter: %{container_name!="POD",environment="#{deployment.environment.slug}"},
-        timeframe_start: (deployment.created_at - 30.minutes).to_f,
-        timeframe_end: (deployment.created_at + 30.minutes).to_f
-      }
+module Gitlab
+  module Prometheus
+    module Queries
+      class AdditionalMetricsDeploymentQuery < BaseQuery
+        include QueryAdditionalMetrics
 
-      query_metrics(query_context)
+        def query(deployment_id)
+          deployment = Deployment.find_by(id: deployment_id)
+          query_context = {
+            environment_slug: deployment.environment.slug,
+            environment_filter: %{container_name!="POD",environment="#{deployment.environment.slug}"},
+            timeframe_start: (deployment.created_at - 30.minutes).to_f,
+            timeframe_end: (deployment.created_at + 30.minutes).to_f
+          }
+
+          query_metrics(query_context)
+        end
+      end
     end
   end
 end

lib/gitlab/prometheus/queries/additional_metrics_environment_query.rb

@@ -0,0 +1,21 @@
+module Gitlab
+  module Prometheus
+    module Queries
+      class AdditionalMetricsEnvironmentQuery < BaseQuery
+        include QueryAdditionalMetrics
+
+        def query(environment_id)
+          environment = Environment.find_by(id: environment_id)
+          query_context = {
+            environment_slug: environment.slug,
+            environment_filter: %{container_name!="POD",environment="#{environment.slug}"},
+            timeframe_start: 8.hours.ago.to_f,
+            timeframe_end: Time.now.to_f
+          }
+
+          query_metrics(query_context)
+        end
+      end
+    end
+  end
+end

lib/gitlab/prometheus/queries/additional_metrics_query.rb

@@ -1,26 +1,30 @@
-module Gitlab::Prometheus::Queries
-  class DeploymentQuery < BaseQuery
-    def query(deployment_id)
-      deployment = Deployment.find_by(id: deployment_id)
-      environment_slug = deployment.environment.slug
+module Gitlab
+  module Prometheus
+    module Queries
+      class DeploymentQuery < BaseQuery
+        def query(deployment_id)
+          deployment = Deployment.find_by(id: deployment_id)
+          environment_slug = deployment.environment.slug
 
-      memory_query = raw_memory_usage_query(environment_slug)
-      memory_avg_query = %{avg(avg_over_time(container_memory_usage_bytes{container_name!="POD",environment="#{environment_slug}"}[30m]))}
-      cpu_query = raw_cpu_usage_query(environment_slug)
-      cpu_avg_query = %{avg(rate(container_cpu_usage_seconds_total{container_name!="POD",environment="#{environment_slug}"}[30m])) * 100}
+          memory_query = raw_memory_usage_query(environment_slug)
+          memory_avg_query = %{avg(avg_over_time(container_memory_usage_bytes{container_name!="POD",environment="#{environment_slug}"}[30m]))}
+          cpu_query = raw_cpu_usage_query(environment_slug)
+          cpu_avg_query = %{avg(rate(container_cpu_usage_seconds_total{container_name!="POD",environment="#{environment_slug}"}[30m])) * 100}
 
-      timeframe_start = (deployment.created_at - 30.minutes).to_f
-      timeframe_end = (deployment.created_at + 30.minutes).to_f
+          timeframe_start = (deployment.created_at - 30.minutes).to_f
+          timeframe_end = (deployment.created_at + 30.minutes).to_f
 
-      {
-        memory_values: client_query_range(memory_query, start: timeframe_start, stop: timeframe_end),
-        memory_before: client_query(memory_avg_query, time: deployment.created_at.to_f),
-        memory_after: client_query(memory_avg_query, time: timeframe_end),
+          {
+            memory_values: client_query_range(memory_query, start: timeframe_start, stop: timeframe_end),
+            memory_before: client_query(memory_avg_query, time: deployment.created_at.to_f),
+            memory_after: client_query(memory_avg_query, time: timeframe_end),
 
-        cpu_values: client_query_range(cpu_query, start: timeframe_start, stop: timeframe_end),
-        cpu_before: client_query(cpu_avg_query, time: deployment.created_at.to_f),
-        cpu_after: client_query(cpu_avg_query, time: timeframe_end)
-      }
+            cpu_values: client_query_range(cpu_query, start: timeframe_start, stop: timeframe_end),
+            cpu_before: client_query(cpu_avg_query, time: deployment.created_at.to_f),
+            cpu_after: client_query(cpu_avg_query, time: timeframe_end)
+          }
+        end
+      end
     end
   end
 end

lib/gitlab/prometheus/queries/deployment_query.rb

@@ -1,20 +1,24 @@
-module Gitlab::Prometheus::Queries
-  class EnvironmentQuery < BaseQuery
-    def query(environment_id)
-      environment = Environment.find_by(id: environment_id)
-      environment_slug = environment.slug
-      timeframe_start = 8.hours.ago.to_f
-      timeframe_end = Time.now.to_f
+module Gitlab
+  module Prometheus
+    module Queries
+      class EnvironmentQuery < BaseQuery
+        def query(environment_id)
+          environment = Environment.find_by(id: environment_id)
+          environment_slug = environment.slug
+          timeframe_start = 8.hours.ago.to_f
+          timeframe_end = Time.now.to_f
 
-      memory_query = raw_memory_usage_query(environment_slug)
-      cpu_query = raw_cpu_usage_query(environment_slug)
+          memory_query = raw_memory_usage_query(environment_slug)
+          cpu_query = raw_cpu_usage_query(environment_slug)
 
-      {
-        memory_values: client_query_range(memory_query, start: timeframe_start, stop: timeframe_end),
-        memory_current: client_query(memory_query, time: timeframe_end),
-        cpu_values: client_query_range(cpu_query, start: timeframe_start, stop: timeframe_end),
-        cpu_current: client_query(cpu_query, time: timeframe_end)
-      }
+          {
+            memory_values: client_query_range(memory_query, start: timeframe_start, stop: timeframe_end),
+            memory_current: client_query(memory_query, time: timeframe_end),
+            cpu_values: client_query_range(cpu_query, start: timeframe_start, stop: timeframe_end),
+            cpu_current: client_query(cpu_query, time: timeframe_end)
+          }
+        end
+      end
     end
   end
 end