debian-mirror-gitlab/app/services/metrics/dashboard/custom_dashboard_service.rb

55 lines
1.5 KiB
Ruby
Raw Normal View History

2019-10-12 21:52:04 +05:30
# frozen_string_literal: true
# Searches a projects repository for a metrics dashboard and formats the output.
# Expects any custom dashboards will be located in `.gitlab/dashboards`
# Use Gitlab::Metrics::Dashboard::Finder to retrive dashboards.
module Metrics
module Dashboard
2020-04-22 19:07:51 +05:30
class CustomDashboardService < ::Metrics::Dashboard::BaseService
2019-10-12 21:52:04 +05:30
DASHBOARD_ROOT = ".gitlab/dashboards"
class << self
2020-03-13 15:44:24 +05:30
def valid_params?(params)
params[:dashboard_path].present?
end
2019-10-12 21:52:04 +05:30
def all_dashboard_paths(project)
file_finder(project)
.list_files_for(DASHBOARD_ROOT)
.map do |filepath|
{
path: filepath,
display_name: name_for_path(filepath),
2019-12-26 22:10:19 +05:30
default: false,
2020-07-28 23:09:34 +05:30
system_dashboard: false,
out_of_the_box_dashboard: out_of_the_box_dashboard?
2019-10-12 21:52:04 +05:30
}
end
end
def file_finder(project)
Gitlab::Template::Finders::RepoTemplateFinder.new(project, DASHBOARD_ROOT, '.yml')
end
# Grabs the filepath after the base directory.
def name_for_path(filepath)
filepath.delete_prefix("#{DASHBOARD_ROOT}/")
end
end
private
# Searches the project repo for a custom-defined dashboard.
def get_raw_dashboard
yml = self.class.file_finder(project).read(dashboard_path)
2020-07-28 23:09:34 +05:30
load_yaml(yml)
2019-10-12 21:52:04 +05:30
end
def cache_key
"project_#{project.id}_metrics_dashboard_#{dashboard_path}"
end
end
end
end