2020-03-13 15:44:24 +05:30
|
|
|
# frozen_string_literal: true
|
|
|
|
|
|
|
|
module Projects
|
|
|
|
module Prometheus
|
|
|
|
class AlertPresenter < Gitlab::View::Presenter::Delegated
|
2020-04-22 19:07:51 +05:30
|
|
|
RESERVED_ANNOTATIONS = %w(gitlab_incident_markdown gitlab_y_label title).freeze
|
2020-03-13 15:44:24 +05:30
|
|
|
GENERIC_ALERT_SUMMARY_ANNOTATIONS = %w(monitoring_tool service hosts).freeze
|
|
|
|
MARKDOWN_LINE_BREAK = " \n".freeze
|
2020-07-28 23:09:34 +05:30
|
|
|
INCIDENT_LABEL_NAME = ::IncidentManagement::CreateIncidentLabelService::LABEL_PROPERTIES[:title].freeze
|
2020-05-24 23:13:21 +05:30
|
|
|
METRIC_TIME_WINDOW = 30.minutes
|
2020-03-13 15:44:24 +05:30
|
|
|
|
|
|
|
def full_title
|
|
|
|
[environment_name, alert_title].compact.join(': ')
|
|
|
|
end
|
|
|
|
|
|
|
|
def project_full_path
|
|
|
|
project.full_path
|
|
|
|
end
|
|
|
|
|
|
|
|
def metric_query
|
|
|
|
gitlab_alert&.full_query
|
|
|
|
end
|
|
|
|
|
|
|
|
def environment_name
|
|
|
|
environment&.name
|
|
|
|
end
|
|
|
|
|
|
|
|
def performance_dashboard_link
|
|
|
|
if environment
|
|
|
|
metrics_project_environment_url(project, environment)
|
|
|
|
else
|
|
|
|
metrics_project_environments_url(project)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2020-04-08 14:13:33 +05:30
|
|
|
def show_performance_dashboard_link?
|
|
|
|
gitlab_alert.present?
|
|
|
|
end
|
|
|
|
|
|
|
|
def show_incident_issues_link?
|
|
|
|
project.incident_management_setting&.create_issue?
|
|
|
|
end
|
|
|
|
|
|
|
|
def incident_issues_link
|
|
|
|
project_issues_url(project, label_name: INCIDENT_LABEL_NAME)
|
|
|
|
end
|
|
|
|
|
2020-06-23 00:09:42 +05:30
|
|
|
def start_time
|
|
|
|
starts_at&.strftime('%d %B %Y, %-l:%M%p (%Z)')
|
2020-03-13 15:44:24 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
def issue_summary_markdown
|
|
|
|
<<~MARKDOWN.chomp
|
|
|
|
#### Summary
|
|
|
|
|
|
|
|
#{metadata_list}
|
2020-04-08 14:13:33 +05:30
|
|
|
#{alert_details}#{metric_embed_for_alert}
|
2020-03-13 15:44:24 +05:30
|
|
|
MARKDOWN
|
|
|
|
end
|
|
|
|
|
2020-07-28 23:09:34 +05:30
|
|
|
def annotation_list
|
|
|
|
strong_memoize(:annotation_list) do
|
|
|
|
annotations
|
|
|
|
.reject { |annotation| annotation.label.in?(RESERVED_ANNOTATIONS | GENERIC_ALERT_SUMMARY_ANNOTATIONS) }
|
|
|
|
.map { |annotation| list_item(annotation.label, annotation.value) }
|
|
|
|
.join(MARKDOWN_LINE_BREAK)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def metric_embed_for_alert
|
|
|
|
"\n[](#{metrics_dashboard_url})" if metrics_dashboard_url
|
|
|
|
end
|
|
|
|
|
|
|
|
def metrics_dashboard_url
|
|
|
|
strong_memoize(:metrics_dashboard_url) do
|
|
|
|
embed_url_for_gitlab_alert || embed_url_for_self_managed_alert
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2020-03-13 15:44:24 +05:30
|
|
|
private
|
|
|
|
|
|
|
|
def alert_title
|
|
|
|
query_title || title
|
|
|
|
end
|
|
|
|
|
|
|
|
def query_title
|
|
|
|
return unless gitlab_alert
|
|
|
|
|
|
|
|
"#{gitlab_alert.title} #{gitlab_alert.computed_operator} #{gitlab_alert.threshold} for 5 minutes"
|
|
|
|
end
|
|
|
|
|
|
|
|
def metadata_list
|
|
|
|
metadata = []
|
|
|
|
|
2020-06-23 00:09:42 +05:30
|
|
|
metadata << list_item('Start time', start_time) if start_time
|
2020-03-13 15:44:24 +05:30
|
|
|
metadata << list_item('full_query', backtick(full_query)) if full_query
|
|
|
|
metadata << list_item(service.label.humanize, service.value) if service
|
|
|
|
metadata << list_item(monitoring_tool.label.humanize, monitoring_tool.value) if monitoring_tool
|
|
|
|
metadata << list_item(hosts.label.humanize, host_links) if hosts
|
|
|
|
|
|
|
|
metadata.join(MARKDOWN_LINE_BREAK)
|
|
|
|
end
|
|
|
|
|
|
|
|
def alert_details
|
|
|
|
if annotation_list.present?
|
|
|
|
<<~MARKDOWN.chomp
|
|
|
|
|
|
|
|
#### Alert Details
|
|
|
|
|
|
|
|
#{annotation_list}
|
|
|
|
MARKDOWN
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def list_item(key, value)
|
|
|
|
"**#{key}:** #{value}".strip
|
|
|
|
end
|
|
|
|
|
|
|
|
def backtick(value)
|
|
|
|
"`#{value}`"
|
|
|
|
end
|
|
|
|
|
|
|
|
GENERIC_ALERT_SUMMARY_ANNOTATIONS.each do |annotation_name|
|
|
|
|
define_method(annotation_name) do
|
|
|
|
annotations.find { |a| a.label == annotation_name }
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def host_links
|
|
|
|
Array(hosts.value).join(' ')
|
|
|
|
end
|
2020-04-08 14:13:33 +05:30
|
|
|
|
2020-05-24 23:13:21 +05:30
|
|
|
def embed_url_for_gitlab_alert
|
|
|
|
return unless gitlab_alert
|
|
|
|
|
|
|
|
metrics_dashboard_project_prometheus_alert_url(
|
|
|
|
project,
|
|
|
|
gitlab_alert.prometheus_metric_id,
|
|
|
|
environment_id: environment.id,
|
2020-07-28 23:09:34 +05:30
|
|
|
embedded: true,
|
2020-05-24 23:13:21 +05:30
|
|
|
**alert_embed_window_params(embed_time)
|
|
|
|
)
|
|
|
|
end
|
|
|
|
|
|
|
|
def embed_url_for_self_managed_alert
|
|
|
|
return unless environment && full_query && title
|
|
|
|
|
|
|
|
metrics_dashboard_project_environment_url(
|
|
|
|
project,
|
|
|
|
environment,
|
|
|
|
embed_json: dashboard_for_self_managed_alert.to_json,
|
2020-07-28 23:09:34 +05:30
|
|
|
embedded: true,
|
2020-05-24 23:13:21 +05:30
|
|
|
**alert_embed_window_params(embed_time)
|
|
|
|
)
|
|
|
|
end
|
|
|
|
|
|
|
|
def embed_time
|
2020-06-23 00:09:42 +05:30
|
|
|
starts_at || Time.current
|
2020-05-24 23:13:21 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
def alert_embed_window_params(time)
|
|
|
|
{
|
|
|
|
start: format_embed_timestamp(time - METRIC_TIME_WINDOW),
|
|
|
|
end: format_embed_timestamp(time + METRIC_TIME_WINDOW)
|
|
|
|
}
|
|
|
|
end
|
|
|
|
|
|
|
|
def format_embed_timestamp(time)
|
|
|
|
time.utc.strftime('%FT%TZ')
|
|
|
|
end
|
|
|
|
|
|
|
|
def dashboard_for_self_managed_alert
|
|
|
|
{
|
|
|
|
panel_groups: [{
|
|
|
|
panels: [{
|
|
|
|
type: 'line-graph',
|
|
|
|
title: title,
|
|
|
|
y_label: y_label,
|
|
|
|
metrics: [{
|
|
|
|
query_range: full_query
|
|
|
|
}]
|
|
|
|
}]
|
|
|
|
}]
|
|
|
|
}
|
|
|
|
end
|
2020-03-13 15:44:24 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|