debian-mirror-gitlab/lib/gitlab/metrics/dashboard/url.rb

92 lines
2.7 KiB
Ruby
Raw Normal View History

2019-09-30 21:07:59 +05:30
# frozen_string_literal: true
# Manages url matching for metrics dashboards.
module Gitlab
module Metrics
module Dashboard
class Url
class << self
2020-03-13 15:44:24 +05:30
include Gitlab::Utils::StrongMemoize
QUERY_PATTERN = '(?<query>\?[a-zA-Z0-9%.()+_=-]+(&[a-zA-Z0-9%.()+_=-]+)*)?'
ANCHOR_PATTERN = '(?<anchor>\#[a-z0-9_-]+)?'
OPTIONAL_DASH_PATTERN = '(?:/-)?'
2019-09-30 21:07:59 +05:30
# Matches urls for a metrics dashboard. This could be
# either the /metrics endpoint or the /metrics_dashboard
# endpoint.
#
# EX - https://<host>/<namespace>/<project>/environments/<env_id>/metrics
2020-03-13 15:44:24 +05:30
def metrics_regex
strong_memoize(:metrics_regex) do
regex_for_project_metrics(
%r{
/environments
/(?<environment>\d+)
/metrics
}x
2019-12-26 22:10:19 +05:30
)
2020-03-13 15:44:24 +05:30
end
2019-12-26 22:10:19 +05:30
end
# Matches dashboard urls for a Grafana embed.
#
# EX - https://<host>/<namespace>/<project>/grafana/metrics_dashboard
def grafana_regex
2020-03-13 15:44:24 +05:30
strong_memoize(:grafana_regex) do
regex_for_project_metrics(
%r{
/grafana
/metrics_dashboard
}x
2019-09-30 21:07:59 +05:30
)
2020-03-13 15:44:24 +05:30
end
2019-09-30 21:07:59 +05:30
end
2019-10-12 21:52:04 +05:30
# Parses query params out from full url string into hash.
#
# Ex) 'https://<root>/<project>/<environment>/metrics?title=Title&group=Group'
# --> { title: 'Title', group: 'Group' }
def parse_query(url)
query_string = URI.parse(url).query.to_s
CGI.parse(query_string)
.transform_values { |value| value.first }
.symbolize_keys
end
2019-09-30 21:07:59 +05:30
# Builds a metrics dashboard url based on the passed in arguments
def build_dashboard_url(*args)
Gitlab::Routing.url_helpers.metrics_dashboard_namespace_project_environment_url(*args)
end
2019-12-26 22:10:19 +05:30
private
2020-03-13 15:44:24 +05:30
def regex_for_project_metrics(path_suffix_pattern)
%r{
(?<url>
#{gitlab_host_pattern}
#{project_path_pattern}
#{OPTIONAL_DASH_PATTERN}
#{path_suffix_pattern}
#{QUERY_PATTERN}
#{ANCHOR_PATTERN}
)
}x
2019-12-26 22:10:19 +05:30
end
2020-03-13 15:44:24 +05:30
def gitlab_host_pattern
Regexp.escape(Gitlab.config.gitlab.url)
2019-12-26 22:10:19 +05:30
end
2020-03-13 15:44:24 +05:30
def project_path_pattern
"\/#{Project.reference_pattern}"
2019-12-26 22:10:19 +05:30
end
2019-09-30 21:07:59 +05:30
end
end
end
end
end
2020-03-13 15:44:24 +05:30
Gitlab::Metrics::Dashboard::Url.extend_if_ee('::EE::Gitlab::Metrics::Dashboard::Url')