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

159 lines
5.1 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_-]+)?'
2020-11-24 15:15:51 +05:30
DASH_PATTERN = '(?:/-)'
2020-03-13 15:44:24 +05:30
2020-11-24 15:15:51 +05:30
# Matches urls for a metrics dashboard.
# This regex needs to match the old metrics URL, the new metrics URL,
# and the dashboard URL (inline_metrics_redactor_filter.rb
# uses this regex to match against the dashboard URL.)
2019-09-30 21:07:59 +05:30
#
2020-11-24 15:15:51 +05:30
# EX - Old URL: https://<host>/<namespace>/<project>/environments/<env_id>/metrics
# OR
# New URL: https://<host>/<namespace>/<project>/-/metrics?environment=<env_id>
# OR
# dashboard URL: https://<host>/<namespace>/<project>/environments/<env_id>/metrics_dashboard
2020-03-13 15:44:24 +05:30
def metrics_regex
strong_memoize(:metrics_regex) do
regex_for_project_metrics(
%r{
2020-11-24 15:15:51 +05:30
( #{environment_metrics_regex} ) | ( #{non_environment_metrics_regex} )
2020-03-13 15:44:24 +05:30
}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{
2020-11-24 15:15:51 +05:30
#{DASH_PATTERN}?
2020-03-13 15:44:24 +05:30
/grafana
/metrics_dashboard
2022-08-27 11:52:29 +05:30
}xo
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
2020-10-24 23:57:45 +05:30
# Matches dashboard urls for a metric chart embed
2020-11-24 15:15:51 +05:30
# for cluster metrics.
# This regex needs to match the dashboard URL as well, not just the trigger URL.
# The inline_metrics_redactor_filter.rb uses this regex to match against
# the dashboard URL.
2020-10-24 23:57:45 +05:30
#
# EX - https://<host>/<namespace>/<project>/-/clusters/<cluster_id>/?group=Cluster%20Health&title=Memory%20Usage&y_label=Memory%20(GiB)
2020-11-24 15:15:51 +05:30
# dashboard URL - https://<host>/<namespace>/<project>/-/clusters/<cluster_id>/metrics_dashboard?group=Cluster%20Health&title=Memory%20Usage&y_label=Memory%20(GiB)
2020-10-24 23:57:45 +05:30
def clusters_regex
strong_memoize(:clusters_regex) do
regex_for_project_metrics(
%r{
2020-11-24 15:15:51 +05:30
#{DASH_PATTERN}?
2020-10-24 23:57:45 +05:30
/clusters
/(?<cluster_id>\d+)
/?
2020-11-24 15:15:51 +05:30
( (/metrics) | ( /metrics_dashboard\.json ) )?
2022-08-27 11:52:29 +05:30
}xo
2020-10-24 23:57:45 +05:30
)
end
end
# Matches dashboard urls for a metric chart embed
# for a specifc firing GitLab alert
#
# EX - https://<host>/<namespace>/<project>/prometheus/alerts/<alert_id>/metrics_dashboard
def alert_regex
strong_memoize(:alert_regex) do
regex_for_project_metrics(
%r{
2020-11-24 15:15:51 +05:30
#{DASH_PATTERN}?
2020-10-24 23:57:45 +05:30
/prometheus
/alerts
/(?<alert>\d+)
2020-11-24 15:15:51 +05:30
/metrics_dashboard(\.json)?
2022-08-27 11:52:29 +05:30
}xo
2020-10-24 23:57:45 +05:30
)
end
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-11-24 15:15:51 +05:30
def environment_metrics_regex
%r{
#{DASH_PATTERN}?
/environments
/(?<environment>\d+)
/(metrics_dashboard|metrics)
2022-08-27 11:52:29 +05:30
}xo
2020-11-24 15:15:51 +05:30
end
def non_environment_metrics_regex
%r{
#{DASH_PATTERN}
/metrics
(?= # Lookahead to ensure there is an environment query param
\?
.*
environment=(?<environment>\d+)
.*
)
2022-08-27 11:52:29 +05:30
}xo
2020-11-24 15:15:51 +05:30
end
2020-03-13 15:44:24 +05:30
def regex_for_project_metrics(path_suffix_pattern)
%r{
2020-11-24 15:15:51 +05:30
^(?<url>
2020-03-13 15:44:24 +05:30
#{gitlab_host_pattern}
#{project_path_pattern}
#{path_suffix_pattern}
#{QUERY_PATTERN}
#{ANCHOR_PATTERN}
2020-11-24 15:15:51 +05:30
)$
2020-03-13 15:44:24 +05:30
}x
2019-12-26 22:10:19 +05:30
end
2020-03-13 15:44:24 +05:30
def gitlab_host_pattern
2020-10-24 23:57:45 +05:30
Regexp.escape(gitlab_domain)
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
2020-10-24 23:57:45 +05:30
def gitlab_domain
Gitlab.config.gitlab.url
end
2019-09-30 21:07:59 +05:30
end
end
end
end
end