Manage Notification Channels

Alert notifications in Zilliz Cloud keep you informed about events occurring within your clusters. By default, these notifications are sent to specified user email addresses. However, you can also set up custom notification channels using webhooks for more integrated, event-driven notifications. This guide will walk you through the process of configuring alert notification channels.

Before you start

To manage notification channels, make sure you are an organization or project owner.

Set up notification channels

Currently, Zilliz Cloud offers four main types of notification channels:

• Email: Receive notifications at specified email addresses.

• PagerDuty: Integrate with a PagerDuty service using an integration key.

• Slack: Integrate with a Slack app using a webhook URL.

• Webhook: Integrate with custom services or applications using a valid webhook URL.

You can access the management page of notification channels in the Edit Alert or Create Alert dialog box in the Zilliz Cloud console.

Email

To set up email notifications,

1. In the Zilliz Cloud console, navigate to the Alert Settings tab on the organization or project alert page.

2. To modify an existing alert, select Edit from the Actions column next to the desired alert target. To create a new alert, click + Alert in the upper-right corner.

   📘Notes

   For organization alerts, you can only edit existing alert targets; creating new ones is not supported. For more information, refer to Manage Organization Alerts.

3. In the Send To field of the dialog box, select user roles or email addresses of individual users to receive alert notifications.

For more information, refer to Manage Organization Alerts or Manage Project Alerts.

PagerDuty

To integrate with a PagerDuty service,

1. Create a service in the PagerDuty UI.

2. Create an Events API v2 integration to obtain the integration key. The integration key will be in the format: c55ec4de243e440bd0e921750bdfxxxx.

3. In the Zilliz Cloud console, configure the PagerDuty notification channel.

   1. Navigate to the Alert Settings tab on the organization or project alert page.

   2. To modify an existing alert, select Edit from the Actions column next to the desired alert target. To create a new alert, click + Alert in the upper-right corner.

      📘Notes

      For organization alerts, you can only edit existing alert targets; creating new ones is not supported. For more information, refer to Manage Organization Alerts.

   3. In the dialog box that appears, click + Channel in the Send To field and choose PagerDuty from the dropdown list.

   4. Enter the PagerDuty integration key obtained and select the service region hosting your PagerDuty account. For more information on PagerDuty service regions, refer to Service Regions.

Slack

To set up Slack integration,

1. Create a webhook in the Slack UI.

2. In the Webhook URL section, obtain the webhook URL. The URL will be in the format: https://hooks.slack.com/services/xxxxxxxxxxxx/xxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxx.

3. In the Zilliz Cloud console, configure the Slack notification channel.

   1. Navigate to the Alert Settings tab on the organization or project alert page.

   2. To modify an existing alert, select Edit from the Actions column next to the desired alert target. To create a new alert, click + Alert in the upper-right corner.

      📘Notes

      For organization alerts, you can only edit existing alert targets; creating new ones is not supported. For more information, refer to Manage Organization Alerts.

   3. In the dialog box that appears, click + Channel in the Send To field and choose Slack from the dropdown list.

   4. Enter the webhook URL obtained.

Webhook

The Webhook option offered by Zilliz Cloud allows you to set up a custom notification channel.

1. Obtain the webhook URL of your service.

2. In the Zilliz Cloud console, configure the Webhook notification channel.

   1. Navigate to the Alert Settings tab on the organization or project alert page.

   2. To modify an existing alert, select Edit from the Actions column next to the desired alert target. To create a new alert, click + Alert in the upper-right corner.

      📘Notes

      For organization alerts, you can only edit existing alert targets; creating new ones is not supported. For more information, refer to Manage Organization Alerts.

   3. In the dialog box that appears, click + Channel in the Send To field and choose Webhook from the dropdown list.

   4. Enter the webhook URL of your service.

Example webhook notification:

{
  "orgId": "org-elqqyqjnsdfvcxmpjugfmj",
  "projectId": "proj-a641f9272ca1c5005760e4",
  "summary": "New Zilliz Cloud Alert for your cluster Cluster-01 (in01-ffbab4a57bdd0bb). CU Computation >= 0 % for 10 minutes.",
  "level": "WARNING",
  "timestamp": "2024-03-22T07:11:00Z"
}

Test connectivity

After setting up a notification channel, click the Send Test Message icon to verify that it is properly configured.