2020-07-08 23:09:01 -04:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
|
|
|
module SystemNotes
|
|
|
|
class AlertManagementService < ::SystemNotes::BaseService
|
2020-08-27 14:10:29 -04:00
|
|
|
# Called when the a new AlertManagement::Alert has been created
|
|
|
|
#
|
|
|
|
# alert - AlertManagement::Alert object.
|
|
|
|
#
|
|
|
|
# Example Note text:
|
|
|
|
#
|
|
|
|
# "GitLab Alert Bot logged an alert from Prometheus"
|
|
|
|
#
|
|
|
|
# Returns the created Note object
|
|
|
|
def create_new_alert(monitoring_tool)
|
|
|
|
body = "logged an alert from **#{monitoring_tool}**"
|
|
|
|
|
|
|
|
create_note(NoteSummary.new(noteable, project, User.alert_bot, body, action: 'new_alert_added'))
|
|
|
|
end
|
|
|
|
|
2020-07-08 23:09:01 -04:00
|
|
|
# Called when the status of an AlertManagement::Alert has changed
|
|
|
|
#
|
|
|
|
# alert - AlertManagement::Alert object.
|
|
|
|
#
|
|
|
|
# Example Note text:
|
|
|
|
#
|
|
|
|
# "changed the status to Acknowledged"
|
2022-01-21 13:12:45 -05:00
|
|
|
# "changed the status to Acknowledged by changing the incident status of #540"
|
2020-07-08 23:09:01 -04:00
|
|
|
#
|
|
|
|
# Returns the created Note object
|
2022-01-21 13:12:45 -05:00
|
|
|
def change_alert_status(reason)
|
|
|
|
status = noteable.state.to_s.titleize
|
|
|
|
body = "changed the status to **#{status}**#{reason}"
|
2020-07-08 23:09:01 -04:00
|
|
|
|
|
|
|
create_note(NoteSummary.new(noteable, project, author, body, action: 'status'))
|
|
|
|
end
|
2020-07-09 17:09:33 -04:00
|
|
|
|
|
|
|
# Called when an issue is created based on an AlertManagement::Alert
|
|
|
|
#
|
|
|
|
# issue - Issue object.
|
|
|
|
#
|
|
|
|
# Example Note text:
|
|
|
|
#
|
2022-01-24 10:11:33 -05:00
|
|
|
# "created incident #17 for this alert"
|
2020-07-09 17:09:33 -04:00
|
|
|
#
|
|
|
|
# Returns the created Note object
|
2020-07-23 05:09:18 -04:00
|
|
|
def new_alert_issue(issue)
|
2022-01-24 10:11:33 -05:00
|
|
|
body = "created incident #{issue.to_reference(project)} for this alert"
|
2020-07-09 17:09:33 -04:00
|
|
|
|
|
|
|
create_note(NoteSummary.new(noteable, project, author, body, action: 'alert_issue_added'))
|
|
|
|
end
|
2020-07-23 05:09:18 -04:00
|
|
|
|
2021-02-23 13:10:40 -05:00
|
|
|
# Called when an alert is resolved due to received resolving alert payload
|
|
|
|
#
|
|
|
|
# alert - AlertManagement::Alert object.
|
|
|
|
#
|
|
|
|
# Example Note text:
|
|
|
|
#
|
|
|
|
# "changed the status to Resolved by closing issue #17"
|
|
|
|
#
|
|
|
|
# Returns the created Note object
|
|
|
|
def log_resolving_alert(monitoring_tool)
|
2021-04-06 17:09:08 -04:00
|
|
|
body = "logged a recovery alert from **#{monitoring_tool}**"
|
2021-02-23 13:10:40 -05:00
|
|
|
|
|
|
|
create_note(NoteSummary.new(noteable, project, User.alert_bot, body, action: 'new_alert_added'))
|
|
|
|
end
|
2020-07-08 23:09:01 -04:00
|
|
|
end
|
|
|
|
end
|