155 lines
4.5 KiB
Ruby
155 lines
4.5 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module Projects
|
|
module Prometheus
|
|
module Alerts
|
|
class NotifyService < BaseService
|
|
include Gitlab::Utils::StrongMemoize
|
|
include ::IncidentManagement::Settings
|
|
|
|
# This set of keys identifies a payload as a valid Prometheus
|
|
# payload and thus processable by this service. See also
|
|
# https://prometheus.io/docs/alerting/configuration/#webhook_config
|
|
REQUIRED_PAYLOAD_KEYS = %w[
|
|
version groupKey status receiver groupLabels commonLabels
|
|
commonAnnotations externalURL alerts
|
|
].to_set.freeze
|
|
|
|
SUPPORTED_VERSION = '4'
|
|
|
|
def execute(token)
|
|
return bad_request unless valid_payload_size?
|
|
return unprocessable_entity unless self.class.processable?(params)
|
|
return unauthorized unless valid_alert_manager_token?(token)
|
|
|
|
process_prometheus_alerts
|
|
send_alert_email if send_email?
|
|
|
|
ServiceResponse.success
|
|
end
|
|
|
|
def self.processable?(params)
|
|
# Workaround for https://gitlab.com/gitlab-org/gitlab/-/issues/220496
|
|
return false unless params
|
|
|
|
REQUIRED_PAYLOAD_KEYS.subset?(params.keys.to_set) &&
|
|
params['version'] == SUPPORTED_VERSION
|
|
end
|
|
|
|
private
|
|
|
|
def valid_payload_size?
|
|
Gitlab::Utils::DeepSize.new(params).valid?
|
|
end
|
|
|
|
def send_email?
|
|
incident_management_setting.send_email && firings.any?
|
|
end
|
|
|
|
def firings
|
|
@firings ||= alerts_by_status('firing')
|
|
end
|
|
|
|
def alerts_by_status(status)
|
|
alerts.select { |alert| alert['status'] == status }
|
|
end
|
|
|
|
def alerts
|
|
params['alerts']
|
|
end
|
|
|
|
def valid_alert_manager_token?(token)
|
|
valid_for_manual?(token) ||
|
|
valid_for_alerts_endpoint?(token) ||
|
|
valid_for_managed?(token)
|
|
end
|
|
|
|
def valid_for_manual?(token)
|
|
prometheus = project.find_or_initialize_service('prometheus')
|
|
return false unless prometheus.manual_configuration?
|
|
|
|
if setting = project.alerting_setting
|
|
compare_token(token, setting.token)
|
|
else
|
|
token.nil?
|
|
end
|
|
end
|
|
|
|
def valid_for_alerts_endpoint?(token)
|
|
return false unless project.alerts_service_activated?
|
|
|
|
# Here we are enforcing the existence of the token
|
|
compare_token(token, project.alerts_service.token)
|
|
end
|
|
|
|
def valid_for_managed?(token)
|
|
prometheus_application = available_prometheus_application(project)
|
|
return false unless prometheus_application
|
|
|
|
if token
|
|
compare_token(token, prometheus_application.alert_manager_token)
|
|
else
|
|
prometheus_application.alert_manager_token.nil?
|
|
end
|
|
end
|
|
|
|
def available_prometheus_application(project)
|
|
alert_id = gitlab_alert_id
|
|
return unless alert_id
|
|
|
|
alert = find_alert(project, alert_id)
|
|
return unless alert
|
|
|
|
cluster = alert.environment.deployment_platform&.cluster
|
|
return unless cluster&.enabled?
|
|
return unless cluster.application_prometheus_available?
|
|
|
|
cluster.application_prometheus
|
|
end
|
|
|
|
def find_alert(project, metric)
|
|
Projects::Prometheus::AlertsFinder
|
|
.new(project: project, metric: metric)
|
|
.execute
|
|
.first
|
|
end
|
|
|
|
def gitlab_alert_id
|
|
alerts&.first&.dig('labels', 'gitlab_alert_id')
|
|
end
|
|
|
|
def compare_token(expected, actual)
|
|
return unless expected && actual
|
|
|
|
ActiveSupport::SecurityUtils.secure_compare(expected, actual)
|
|
end
|
|
|
|
def send_alert_email
|
|
notification_service
|
|
.async
|
|
.prometheus_alerts_fired(project, firings)
|
|
end
|
|
|
|
def process_prometheus_alerts
|
|
alerts.each do |alert|
|
|
AlertManagement::ProcessPrometheusAlertService
|
|
.new(project, nil, alert.to_h)
|
|
.execute
|
|
end
|
|
end
|
|
|
|
def bad_request
|
|
ServiceResponse.error(message: 'Bad Request', http_status: :bad_request)
|
|
end
|
|
|
|
def unauthorized
|
|
ServiceResponse.error(message: 'Unauthorized', http_status: :unauthorized)
|
|
end
|
|
|
|
def unprocessable_entity
|
|
ServiceResponse.error(message: 'Unprocessable Entity', http_status: :unprocessable_entity)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|