Configure Alert Notification Settings
You can configure general alert notification rules from the Health page in the Notification tab. You can configure email and webhook as the notification output for the alert notification.
Create Alert Notification Rule for Email Notifications
You can add different alert notification rules that send emails based on the alert categories, severities, and names.
To create an alert notification rule for email notifications:
- In DataProtect as a Service, navigate to the Health > Notification tab.
-
Click Create > New Alert Notification Rule.
- In the Create Alert Notification Rule dialog, perform the following:
- Enter a unique Notification Name for the alert notification rule.
In the Notification Filters section, select the filter based on your requirements:
The alert notification is sent when an alert matches the combination of the filter settings you have configured.
Details Description Alert Severity Select one or more severities from the drop-down. Otherwise, all alerts with any severity will trigger the rule. Alert Category Select one or more categories from the drop-down. Otherwise, all alerts in any category will trigger the rule. Alert Name Select one or more names from the drop-down. Otherwise, any Alert name will trigger the rule. If you selected any categories, the list includes only alerts in those categories. Source Type Select one or more sources from the drop-down. Otherwise, any source will trigger the rule. In the Notification Method section, select Email. Choose one of the options from the drop-down based on your requirement:
Details Description To Type an email address or distribution list of the recipients to whom you plan to send the email notification. Cc Type an email address or distribution list of the recipients to whom you plan to send a copy of the email notification. Click + to add multiple email addresses based on your requirement.
Click Create.
Create Alert Notification Rule for Webhooks Notification
Webhooks are HTTP callbacks that are usually triggered by some event. Webhooks are configured on one website, and when an event occurs on this website, an HTTP request is made to the configured URL, which invokes an action on the other website.
You can enable webhooks for
To create an alert notification rule for Webhook notifications:
- In DataProtect as a Service, navigate to the Health > Notification tab.
-
Click Create > New Alert Notification Rule.
- In the Create Alert Notification Rule dialog, perform the following:
- Enter a unique Notification Name for the alert notification rule.
In the Notification Filters section, select the filter based on your requirements:
The alert notification is sent when an alert matches the combination of the filter settings you have configured.
Details Description Alert Severity Select one or more severities from the drop-down. Otherwise, all alerts with any severity will trigger the rule. Alert Category Select one or more categories from the drop-down. Otherwise, all alerts in any category will trigger the rule. Alert Name Select one or more names from the drop-down. Otherwise, any Alert name will trigger the rule. If you selected any categories, the list includes only alerts in those categories. Source Type Select one or more sources from the drop-down. Otherwise, any source will trigger the rule. In the Notification Method section, select Webhook, and provide the URL and cURL options.
Click Create.
Alert Request
When an alert is triggered, a sample payload, as shown below, will be available at the configured URL:
Request:
'https://test-service-now.com/api/x_hesin_cohesity_c/cohesitywebhook'
The Payload sent to the above URL:
{
"receiver": "00101000005nBps_test1",
"status": "firing",
"alerts": [
{
"status": "firing",
"labels": {
"account_id": "00101000005nBps",
"alert_category": "BackupRestore",
"alert_code": "CE00610005",
"alert_id": "10534",
"alert_state": "Open",
"alert_type_bucket": "DataService",
"alert_type_id": "10005",
"alertname": "ProtectedObjectFailed",
"cluster_id": "1609127048663690",
"cluster_id_str": "4327092961767844",
"cluster_name": "DPCluster",
"failure_reason": "Testing DP alerts raise.",
"first_occurrence_usecs": "1682699539084721",
"hidden_from_user": "false",
"job_id": "18211",
"job_name": "Test12",
"job_type": "kOracle",
"matchedTags": "WorkloadSource_kOracle",
"object_id": "181",
"object_name" : "obj181",
"run_id": "182",
"run_start_time": "2023.02.07 11:21:00 Pacific Time",
"run_url": "https://test.com",
"severity": "Critical",
"tenant_id": "d520840916/",
"type": "kOracle"
},
"annotations": {
"cause": "Testing DP alerts raise..",
"description": "Backup of obj181 that is part of protection group Test12 of type kOracle failed with error Testing DP alerts raise",
"help": "Please refer to KB for details/resolution.",
"occurrence": "Start at 2023-04-28 16:32:19.084721 +0000 UTC, total 1 time."
},
"startsAt": "2023-04-28T16:32:19.084721Z",
"endsAt": "0001-01-01T00:00:00Z",
"generatorURL": "",
"fingerprint": "bfef9abae71570f0"
}
],
"groupLabels": {
"account_id": "00101000005nBps",
"alertname": "ProtectedObjectFailed",
"severity": "Critical"
},
"commonLabels": {
"account_id": "00101000005nBps",
"alert_category": "BackupRestore",
"alert_code": "CE00610005",
"alert_state": "Open",
"alert_type_bucket": "DataService",
"alert_type_id": "10005",
"alertname": "ProtectedObjectFailed",
"cluster_id": "1609127048663690",
"cluster_id_str": "4327092961767844",
"cluster_name": "DPCluster",
"failed_objects": "obj181",
"failure_reason": "Testing DP alerts raise.",
"hidden_from_user": "false",
"job_id": "18211",
"job_type": "kOracle",
"matchedTags": "WorkloadSource_kOracle",
"run_start_time": "2023.02.07 11:21:00 Pacific Time",
"run_url": "https://test.com",
"severity": "Critical",
"tenant_id": "d520840916/",
"type": "kOracle"
},
"commonAnnotations": {
"help": "Please refer to KB for details/resolution."
},
"externalURL": "https://helios-dev3-internal.cohesitycloud.co/alertmanager-d1",
"version": "4",
"groupKey": "{}/{account_id=\"00101000005nBps\",alertname=~\"^(?:ProtectedObjectFailed)$\",hidden_from_user=\"false\",matchedTags=~\"^(?:.*WorkloadSource_kOracle.*)$\",tenant_id=\"d520840916/\"}:{account_id=\"00101000005nBps\", alertname=\"ProtectedObjectFailed\", severity=\"Critical\"}",
"truncatedAlerts": 0
}
Silence Alert Notifications
Sometimes, it makes sense to silence alert notifications, such as during maintenance or testing windows.
You can silence alerts that match the rules you define in the Silence tab. Optionally, you can silence alerts for specific periods that you define. Once silenced, alerts are triggered and displayed on the Alerts page, but email or Webhook notifications are not sent.
To create an alert silence rule:
- In DataProtect as a Service, navigate to the Health > Silence tab.
-
Click Create > New Silence Rule.
- In the Create Alert Silence Rule dialog, perform the following:
- Enter a Silence Name for this alert silence rule and provide the Reason why you are creating the alert silence rule.
In the Silence Filters section, select the filters based on your requirements:
Details Description Alert Severity Select one or more severities from the drop-down you want to silence. Alert Category Select one or more categories from the drop-down you want to silence. Alert Name Select one or more names from the drop-down you want to silence. Source Type Select one or more sources from the drop-down for which you want the alerts silenced. - In the Time Range section, select a date in the Start Date and End Date fields to set the period within which the alert notifications must be silenced.
Enable Suppress if you do not want the alert to persist and appear on the Alerts page.
- Click Create.
