80 lines
2.1 KiB
Ruby
80 lines
2.1 KiB
Ruby
# 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`
|
|
module Metrics
|
|
module Dashboard
|
|
class BaseService < ::BaseService
|
|
include Gitlab::Metrics::Dashboard::Errors
|
|
|
|
STAGES = ::Gitlab::Metrics::Dashboard::Stages
|
|
SEQUENCE = [
|
|
STAGES::CommonMetricsInserter,
|
|
STAGES::EndpointInserter,
|
|
STAGES::Sorter
|
|
].freeze
|
|
|
|
def get_dashboard
|
|
return error('Insufficient permissions.', :unauthorized) unless allowed?
|
|
|
|
success(dashboard: process_dashboard)
|
|
rescue StandardError => e
|
|
handle_errors(e)
|
|
end
|
|
|
|
# Summary of all known dashboards for the service.
|
|
# @return [Array<Hash>] ex) [{ path: String, default: Boolean }]
|
|
def self.all_dashboard_paths(_project)
|
|
raise NotImplementedError
|
|
end
|
|
|
|
# Returns an un-processed dashboard from the cache.
|
|
def raw_dashboard
|
|
Gitlab::Metrics::Dashboard::Cache.fetch(cache_key) { get_raw_dashboard }
|
|
end
|
|
|
|
private
|
|
|
|
# Determines whether users should be able to view
|
|
# dashboards at all.
|
|
def allowed?
|
|
if params[:environment]
|
|
Ability.allowed?(current_user, :read_environment, project)
|
|
elsif params[:cluster]
|
|
true # Authorization handled at controller level
|
|
else
|
|
false
|
|
end
|
|
end
|
|
|
|
# Returns a new dashboard Hash, supplemented with DB info
|
|
def process_dashboard
|
|
::Gitlab::Metrics::Dashboard::Processor
|
|
.new(project, raw_dashboard, sequence, params)
|
|
.process
|
|
end
|
|
|
|
# @return [String] Relative filepath of the dashboard yml
|
|
def dashboard_path
|
|
params[:dashboard_path]
|
|
end
|
|
|
|
# @return [Hash] an unmodified dashboard
|
|
def get_raw_dashboard
|
|
raise NotImplementedError
|
|
end
|
|
|
|
# @return [String]
|
|
def cache_key
|
|
raise NotImplementedError
|
|
end
|
|
|
|
def sequence
|
|
SEQUENCE
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
Metrics::Dashboard::BaseService.prepend_if_ee('EE::Metrics::Dashboard::BaseService')
|