新しいアラート通知テンプレートを作成すると、複数の対象にまとめて効率よくアラートルールを設定できます。
手順
OceanBase CloudのBYOCコンソールにログインします。
左側のナビゲーションバーで、アラート管理 をクリックします。
アラート管理ページに移動し、その他 の下の アラート通知テンプレート タブをクリックします。
アラート通知テンプレートタブで、通知テンプレートを作成 をクリックします。
テンプレートルールを設定し、作成 をクリックします。
注意
セキュリティ検証のため、アラート通知内容テンプレートには OBCloud または OceanBase という文字列を含める必要があります。
パラメータ説明テンプレート名 アラート通知テンプレートの名前を指定します。 アラート方法 アラート通知方法を指定します。異なる通知方法は異なる通知形式に対応しています。 - メール:アラート通知テンプレートのタイトルと内容を入力します。
- DingTalk:アラート通知テンプレートのタイトルと内容を入力します。
- Lark:テキスト形式で、アラート通知テンプレートの内容を入力します。
- WeCom:テキスト形式で、アラート通知テンプレートの内容を入力します。
- カスタムURL:デフォルトはテンプレートのJSON形式で、カスタムURLがサポートする形式に変更できます。例については、本記事の カスタムURL形式の例 セクションを参照してください。
アラートタイプ メトリクス または イベント を選択できます。 アラート通知有効時間 有効時間の開始時刻と終了時刻は同日の2つの時点を指し、開始時刻は終了時刻より早くなければなりません。有効時間を指定しない場合、アラートルールは終日有効になります。 アラート通知テンプレートタイトル アラート通知に表示される見出しです。 ${AlertName}形式で変数を入力できます。AlertNameはアラート名です。説明
最大50文字まで表示されます。変数を展開した後の文字数で数え、上限を超えた部分は切り捨てられます。
アラート通知テンプレート内容 アラート通知に表示される内容です。右側でプレビューおよび送信テストが可能です。 ${AlertName}形式で変数を入力できます。AlertNameはアラート名です。サポートされている変数については、アラート変数リストを参照してください。説明
最大500文字まで表示されます。変数を展開した後の文字数で数え、上限を超えた部分は切り捨てられます。
アラート解除通知テンプレートタイトル アラート解除通知に表示される見出しです。 ${AlertName}形式で変数を入力できます。AlertNameはアラート名です。説明
最大50文字まで表示されます。変数を展開した後の文字数で数え、上限を超えた部分は切り捨てられます。
アラート解除通知テンプレート内容 アラート解除通知に表示される内容です。右側でプレビューおよび送信テストが可能です。 ${AlertName}形式で変数を入力できます。AlertNameはアラート名です。サポートされている変数については、アラート変数リストを参照してください。説明
最大500文字まで表示されます。変数を展開した後の文字数で数え、上限を超えた部分は切り捨てられます。
作成完了後、リストで確認し、操作列から管理・メンテナンスを行えます。
アラート変数リスト
現在、アラート通知で使用できる変数は以下のとおりです:
変数の意味 |
変数名 |
|---|---|
| アラート名 | ${AlertName} |
| アラート対象 | ${AlertTarget} |
| アラートレベル | ${AlertLevel} |
| アラートメトリクス名 | ${MetricNames} |
| アラートトリガー時間 | ${AlertStartTime} |
| 最終アラート時間 | ${AlertUpdateTime} |
| アラートオブジェクト情報 | ${AlertResourceInfo} |
| アラート概要 | ${AlertSummary} |
| アラートの説明 | ${AlertDescription} |
| アラート詳細URL | ${AlertDetailUrl} |
カスタムURL形式の例
DingTalk、Lark、Slack、TelegramのボットのWebhookアドレスやカスタムURLの設定方法の詳細については、Webhookアドレスの取得を参照してください。
DingTalkボットのAPIを呼び出す例を以下に示します。
curl 'https://oapi.dingtalk.com/robot/send?access_token=********' \
-X 'POST' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data '{"msgtype": "text", "text": {"content": "OceanBase テスト"} }' \
--compressed
この場合、アラートルールと通知テンプレートの設定に記入する内容は次のとおりです:
カスタムURLの形式は次のとおりです:
https://oapi.dingtalk.com/robot/send?access_token=********アラート通知テンプレートの内容形式は次のとおりです:
{ "msgtype": "text", "text": { "content": "こんにちは!\n\nお客様のOBCloudクラウドデータベース${AlertTarget}で${AlertStartTime}に${MetricNames}(${AlertLevel})のアラートが発生しました。速やかにご確認のうえ、対応をお願いいたします。\nアラート名:${AlertName}\nアラート概要:${AlertSummary}\nアラート説明:${AlertDescription}\n関連指標:${MetricNames}\nトリガー時間:${AlertStartTime}\n最終更新時間:${AlertUpdateTime}\n関連リソース情報:${AlertResourceInfo}\nアラート詳細:${AlertDetailUrl}" } }