app/services/metrics_dashboard_service.rb


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

# frozen_string_literal: true

# Fetches the metrics dashboard layout and supplemented the output with DB info.
class MetricsDashboardService
  SYSTEM_DASHBOARD_NAME = 'common_metrics'
  SYSTEM_DASHBOARD_PATH = Rails.root.join('config', 'prometheus', "#{SYSTEM_DASHBOARD_NAME}.yml")

  def initialize(project)
    @project = project
  end

  # Returns a DB-supplemented json representation of a dashboard config file.
  def get_dashboard
    dashboard = Rails.cache.fetch(cache_key) { system_dashboard }

    process_dashboard(dashboard)
  end

  private

  # Returns the base metrics shipped with every GitLab service.
  def system_dashboard
    YAML.load_file(SYSTEM_DASHBOARD_PATH)
  end

  def cache_key
    "metrics_dashboard_#{SYSTEM_DASHBOARD_NAME}"
  end

  def process_dashboard(dashboard)
    MetricsDashboardProcessingService.new(dashboard, @project).process
  end
end