API7 Enterprise v3.2.16.4 支持 Webhook/电子邮件警报通知
November 14, 2024
企業データの増加とシステム監視の複雑化に対応するため、API7 Enterpriseはバージョン3.2.16.4でアラート機能を全面的にアップグレードしました。新バージョンでは、外部プラットフォームとの連携を可能にするコンタクトポイントを導入し、重要な通知が効率的に配信されるようになりました。
新機能の紹介
1. コンタクトポイントのサポート(Webhook/Email)
コンタクトポイントは外部のエンドポイントを表し、各コンタクトには1つの通知チャネル(EmailやWebhookなど)を設定できます。組織レベルでSMTPサービスを設定してメール通知を有効にしたり、Webhookを使用してMicrosoft Teams、Discord、Lark、Slackなどの外部システムにアラートメッセージを送信したりできます。さらに、コンタクトポイントを参照する際に、メールの件名や本文、Webhookのリクエストペイロードなど、通知内容をカスタマイズして、さまざまな外部プラットフォームの要件に対応できます。
2. アラート機能の最適化
アラートポリシーを全面的に最適化し、より柔軟で管理しやすくなりました。各アラートポリシーは複数のトリガー条件をサポートし、これらの条件に基づいてアラートメッセージが送信されます。アラートポリシーには新しいラベルと説明が追加され、管理と識別がより直感的になりました。さらに、より細かい権限管理を導入し、特定のアラートポリシーを表示および操作できるユーザーを制限しています。
新しいアラート機能の使用方法
SMTPサービスの設定
- API7 Enterpriseダッシュボードにログインし、「organization」設定ページの「SMTP」タブに移動します。ここに「Enable」ボタンが表示されます。クリックしてSMTPサーバーの設定を開始します。
- SMTPサーバーの必要な設定情報(サーバーアドレス、ポート、ユーザー名、パスワードなど)を入力します。
- 設定が完了したら、保存します。有効化後、API7 Enterpriseに関連するすべてのメールはこのSMTPサーバー経由で送信されます。
コンタクトの作成と管理
-
ダッシュボードで、「Organization」セクションの「Contact Points」メニューに移動し、コンタクトポイントのリストにアクセスします。
-
「+ Add Contact Point」ボタンをクリックして新しいコンタクトポイントを作成します。設定中に、基本情報を入力し、関連する通知チャネル(WebhookまたはEmail)を選択します。
アラートポリシーの設定
-
ダッシュボードの左メニューで、「Alerts」セクションの「Policies」をクリックして新しいアラートポリシーを作成します。まず、ポリシーの基本情報(名前や説明など)を入力します。基本情報に加えて、アラートポリシーには以下の2つの重要な属性が含まれます:
-
重要度: アラートの緊急度を示します。ビジネス要件や監視対象の重要性に基づいて、高、中、低に設定できます。重要度はアラートメッセージに含まれ、重要なアラートを迅速に識別して対応するのに役立ちます。
-
チェック間隔: システムが監視条件をチェックする頻度を決定します。監視対象やビジネスニーズに基づいて、この間隔を柔軟に調整できます。
-
- 次に、アラートポリシーにトリガー条件を追加します。複数のトリガー条件を定義し、ビジネスニーズに基づいて条件タイプを指定できます。特定の条件が満たされると、システムは自動的にアラートをトリガーします。
- アラートポリシーで、以前に作成したコンタクトポイントを選択し、カスタムアラートメッセージ内容を設定します。アラートメッセージ内容はGo Template構文をサポートしており、重要度、イベントタイプ、トリガー時間などの変数をメッセージに挿入できます。
- アラートポリシーの設定を保存すると、ポリシーはデフォルトで有効になります。システムはチェック間隔に基づいてトリガー条件を監視し、条件が満たされると指定されたコンタクトポイントに通知を自動的に送信します。
- API7 Enterpriseダッシュボードで、アラート履歴を表示して、どのアラートがトリガーされ、どの通知が送信されたかを確認できます。アラートの送信に失敗した場合、コンタクトポイントの詳細ページで通知ログを確認できます。これには通知送信と応答の詳細なログが含まれており、問題のトラブルシューティングと適切な対応を支援します。
結論
API7 Enterpriseの新機能は、ゲートウェイの監視と対応能力を大幅に向上させることを目的としています。コンタクトポイントの統合とアラートポリシーの改良により、アラートがどのように、いつ配信されるかをより正確に制御できます。これにより、重要な情報を見逃すことがなくなり、複雑で変化の激しいビジネス環境を効率的にナビゲートできます。ユーザー体験に関するフィードバックは、製品の最適化と改善を推進する貴重な洞察を提供し、よりシームレスで強力な体験を提供するために役立ちます。