メインコンテンツまでスキップ

通知チャネルの管理

Zilliz Cloud のアラート通知により、クラスター内で発生するイベントを把握できます。デフォルトでは、通知は指定されたユーザーのメールアドレスに送信されますが、webhook を使用してカスタム通知チャネルを設定し、より連携されたイベント駆動型の通知を行うことも可能です。このガイドでは、アラート通知チャネルの設定手順について説明します。

前提条件​

通知チャネルを管理するには、organization owner または project admin の権限が必要です。

通知チャネルの設定​

通知チャネルの管理ページには、Zilliz Cloud コンソールの Edit Alert または Create Alert ダイアログからアクセスできます。

manage-alert-channel

Email​

メール通知を設定する手順は以下のとおりです。

1

Zilliz Cloud console で、組織またはプロジェクトのアラートページにある Alert Settings タブを開きます。

2

既存のアラートを変更するには、対象のアラートターゲットの横にある Actions 列から Edit を選択します。新規にアラートを作成する場合は、右上の + Alert をクリックします。

📘📘 Notes

組織アラートでは既存のアラートターゲットのみ編集可能で、新規作成はサポートされていません。詳細については、Manage Organization Alerts を参照してください。

3

ダイアログの Send to フィールドで、アラート通知の受信者としてユーザーロールまたは個別のユーザーのメールアドレスを選択します。

4

Alert Resolution Notification および Enable Alert で、アラートの解決時または発報時に実行するアクションを設定します。

詳細については、Manage Organization Alerts または Manage Project Alerts を参照してください。

PagerDuty​

PagerDuty サービスと連携する手順は以下のとおりです。

1

PagerDuty UI で Create a service を実行します。

2

Create an Events API v2 integration を実行してインテグレーションキーを取得します。キーの形式は c55ec4de243e440bd0e921750bdfxxxx です。

3

Zilliz Cloud console で PagerDuty 通知チャネルを設定します。

  1. 組織またはプロジェクトのアラートページにある Alert Settings タブを開きます。

  2. 既存のアラートを変更するには、対象のアラートターゲットの横にある Actions 列から Edit を選択します。新規にアラートを作成する場合は、右上の + Alert をクリックします。

    📘📘 Notes

    組織アラートでは既存のアラートターゲットのみ編集可能で、新規作成はサポートされていません。詳細については、Manage Organization Alerts を参照してください。

  3. 表示されるダイアログの Send to フィールドで + Channel をクリックし、ドロップダウンリストから PagerDuty を選択します。

  4. 取得した PagerDuty インテグレーションキーを入力し、PagerDuty アカウントがホストされているサービスリージョンを選択します。PagerDuty のサービスリージョンの詳細については、Service Regions を参照してください。

  5. Alert Resolution Notification および Enable Alert で、アラートの解決時または発報時に実行するアクションを設定します。

Slack​

Slack 連携を設定する手順は以下のとおりです。

1

Slack UI で Create a webhook を実行します。

2

Webhook URL セクションで webhook URL を取得します。URL の形式は https://hooks.slack.com/services/xxxxxxxxxxxx/xxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxx です。

3

Zilliz Cloud console で Slack 通知チャネルを設定します。

  1. 組織またはプロジェクトのアラートページにある Alert Settings タブを開きます。

  2. 既存のアラートを変更するには、対象のアラートターゲットの横にある Actions 列から Edit を選択します。新規にアラートを作成する場合は、右上の + Alert をクリックします。

    📘📘 Notes

    組織アラートでは既存のアラートターゲットのみ編集可能で、新規作成はサポートされていません。詳細については、Manage Organization Alerts を参照してください。

  3. 表示されるダイアログの Send to フィールドで + Channel をクリックし、ドロップダウンリストから Slack を選択します。

  4. 取得した webhook URL を入力します。

  5. Alert Resolution Notification および Enable Alert で、アラートの解決時または発報時に実行するアクションを設定します。

Opsgenie​

Opsgenie 連携を設定する手順は以下のとおりです。

1

Opsgenie で API キーを取得します。詳細については、Create an API integration を参照してください。

  1. Settings > Integrations の順に選択して Opsgenie の Integrations ページに移動し、Add integration をクリックします。

  2. API を検索して選択し、この API インテグレーションの名前を入力して Continue をクリックします。

  3. API 設定ページで Edit をクリックします。デフォルトですべての権限が選択されていますが、Allow Read Access、Allow Create and Update Access、Allow Configuration Access が確実に選択されていることを確認してください。

  4. 生成された API キーをコピーして Save をクリックします。Incoming Rules を確認し、Turn on integration をクリックして API の設定を完了します。

2

Zilliz Cloud console で Opsgenie 通知チャネルを設定します。

  1. 組織またはプロジェクトのアラートページにある Alert Settings タブを開きます。

  2. 既存のアラートを変更するには、対象のアラートターゲットの横にある Actions 列から Edit を選択します。新規にアラートを作成する場合は、右上の + Alert をクリックします。

    📘📘 Notes

    組織アラートでは既存のアラートターゲットのみ編集可能で、新規作成はサポートされていません。詳細については、Manage Organization Alerts を参照してください。

  3. 表示されるダイアログの Send to フィールドで + Channel をクリックし、ドロップダウンリストから Opsgenie を選択します。

  4. Opsgenie で取得した API キーを入力します。

  5. Alert Resolution Notification および Enable Alert で、アラートの解決時または発報時に実行するアクションを設定します。

Lark​

Lark 連携を設定する手順は以下のとおりです。

1

対象の Lark グループにカスタムボットを招待し、そのボットに対応する webhook URL を取得します。詳細な手順については、Custom bot usage guide を参照してください。

2

Zilliz Cloud console で Lark 通知チャネルを設定します。

  1. 組織またはプロジェクトのアラートページにある Alert Settings タブを開きます。

  2. 既存のアラートを変更するには、対象のアラートターゲットの横にある Actions 列から Edit を選択します。新規にアラートを作成する場合は、右上の + Alert をクリックします。

    📘📘 Notes

    組織アラートでは既存のアラートターゲットのみ編集可能で、新規作成はサポートされていません。詳細については、Manage Organization Alerts を参照してください。

  3. 表示されるダイアログの Send to フィールドで + Channel をクリックし、ドロップダウンリストから Lark を選択します。

  4. 取得した webhook URL を入力します。

  5. Alert Resolution Notification および Enable Alert で、アラートの解決時または発報時に実行するアクションを設定します。

Webhook​

Zilliz Cloud が提供する Webhook オプションを使用すると、カスタム通知チャネルを設定できます。

1

ご利用のサービスの Webhook URL を取得します。

2

Zilliz Cloud コンソール で Webhook 通知チャネルを設定します。

  1. 組織またはプロジェクトのアラートページにある Alert Settings タブに移動します。

  2. 既存のアラートを編集するには、対象のアラートターゲットの横にある Actions 列から Edit を選択します。新規アラートを作成する場合は、右上の + Alert をクリックします。

    📘📘 Notes

    組織アラートでは既存のアラートターゲットのみ編集可能で、新規作成はサポートされていません。詳細については、組織アラートの管理 を参照してください。

  3. 表示されるダイアログボックスの Send to フィールドで + Channel をクリックし、ドロップダウンリストから Webhook を選択します。

  4. サービスの Webhook URL を入力します。

  5. Alert Resolution Notification および Enable Alert で、アラートの解決時またはトリガー時に実行するアクションをそれぞれ設定します。

Webhook 通知の例:

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

WeCom​

WeCom のアラート通知を設定するには、以下の手順に従います。

1

WeCom グループでグループボットを作成します。詳しい手順については、グループボットの作成 を参照してください。

📘📘 Notes

WeCom の設定によっては、一部のグループでグループボットを追加できない場合があります。

2

作成したボットの情報を確認し、該当ボットの Webhook URL を取得します。詳しい手順については、グループボットの Webhook アドレスの取得 を参照してください。

3

Zilliz Cloud コンソール にログインし、WeCom アラートチャネルを設定します。

  1. 組織またはプロジェクトのアラートページにある Alert Settings タブに移動します。

  2. 既存のアラートを編集するには、対象のアラートターゲットの横にある Actions 列から Edit を選択します。新規アラートを作成する場合は、右上の + Alert をクリックします。

    📘📘 Notes

    組織アラートでは既存のアラートターゲットのみ編集可能で、新規作成はサポートされていません。詳細については、組織アラートの管理 を参照してください。

  3. 表示されるダイアログボックスの Send to フィールドで + Channel をクリックし、ドロップダウンリストから WeCom を選択します。

  4. 取得した Webhook URL を入力します。

  5. Alert Resolution Notification および Enable Alert で、アラートの解決時またはトリガー時に実行するアクションをそれぞれ設定します。

DingTalk​

DingTalk のアラート通知を設定するには、以下の手順に従います。

1

DingTalk グループでカスタムボットを作成します。詳しい手順については、カスタムボットの統合 を参照してください。

📘Notes

カスタムボットの設定時に、Security Setting で Custom Keywords を指定します。

  • Test: 接続テスト用のアラート通知を受信します。

  • Alert: 実際のイベントに関するアラート通知を受信します。

2

作成したボットの情報を確認し、該当ボットの Webhook URL を取得します。詳しい手順については、カスタムボットの Webhook アドレスの取得 を参照してください。

3

Zilliz Cloud コンソール にログインし、DingTalk アラートチャネルを設定します。

  1. 組織またはプロジェクトのアラートページにある Alert Settings タブに移動します。

  2. 既存のアラートを編集するには、対象のアラートターゲットの横にある Actions 列から Edit を選択します。新規アラートを作成する場合は、右上の + Alert をクリックします。

    📘📘 Notes

    組織アラートでは既存のアラートターゲットのみ編集可能で、新規作成はサポートされていません。詳細については、組織アラートの管理 を参照してください。

  3. 表示されるダイアログボックスの Send to フィールドで + Channel をクリックし、ドロップダウンリストから DingTalk を選択します。

  4. 取得した Webhook URL を入力します。

  5. Alert Resolution Notification および Enable Alert で、アラートの解決時またはトリガー時に実行するアクションをそれぞれ設定します。

接続テスト​

通知チャネルの設定後、Send Test Message アイコンをクリックして設定が正しいことを確認します。

test-connectivity

Ctrl I