本記事では、DingTalk、Lark、Slack、TelegramのボットのWebhookアドレスを取得し、OceanBase CloudのカスタムURLを設定する方法について説明します。
DingTalkグループボットのWebhookアドレスの取得
DingTalkグループボットのWebhookアドレスを取得する手順は以下のとおりです:
説明
DingTalkボットの詳細な使用方法については、Webhookボットを参照してください。
DingTalkクライアントを開き、アラート通知を送信したいグループに入ります。
グループ設定 > ボット > ボットの追加 をクリックします。
カスタムボット を選択します。
ボットの詳細ページで、追加 をクリックします。
ボット追加ページで、関連パラメータを入力します。
パラメータ説明ボット名 グループ内で表示されるボット名。 グループへの追加 デフォルトは現在のグループです。 セキュリティ設定 現在のバージョンでは、カスタムキーワードによるセキュリティ設定のみがサポートされています。 説明
カスタムキーワードはOceanBase、OB、OBCloud、testに設定することを推奨します。これにより、OceanBaseのアラートを正常に受信できます。
「カスタムボットサービスおよび免責事項」 を読んで確認し、チェックを入れた後、確認する をクリックします。
ボットが追加された後の情報画面で、そのボットのWebhookアドレスをコピーします。
説明
このWebhookアドレスは大切に保管してください。GitLabやブログなど、誰でも閲覧できるウェブサイトに掲載しないでください。アドレスが漏えいした場合、悪意のある呼び出しによりスパムメッセージが送信されるのを防ぐためです。
LarkグループボットのWebhookアドレスの取得
LarkグループボットのWebhookアドレスを取得する手順は以下のとおりです:
説明
Larkボットの詳細な使用方法については、カスタムボット使用ガイドを参照してください。
Larkクライアントを開き、対象のグループに入ります。
グループの右上にある「その他」ボタンをクリックし、設定 > グループボット > ボットの追加 をクリックします。
カスタムボット を選択します。
カスタムボットの アバター、名称、説明 を設定し、追加 をクリックします。
ボットの詳細画面で、Webhookアドレスを取得し、セキュリティ設定を行えます。
説明
このWebhookアドレスは大切に保管してください。Gitlabやブログなど、誰でも閲覧できるウェブサイトには掲載しないでください。アドレスが漏洩した場合、悪意のある呼び出しによりスパムメッセージが送信されるのを防ぐためです。
パラメータ説明Webhookアドレス このボットのWebhookアドレスをコピーできます。 セキュリティ設定 現在のバージョンでは、カスタムキーワードによるセキュリティ設定のみをサポートしています。 説明
OceanBaseとOBをカスタムキーワードで設定することを推奨します。これにより、OceanBaseのアラートを正常に受信できます。
設定 ボットの管理権限を設定します。
Telegramボット
以下の手順に従って、TelegramボットのWebhookアドレスを取得し、OceanBase Cloudに設定してください:
アラートを受信するためのTelegramボットを作成します。
Telegramの検索バーで @BotFather と検索し、チャット画面に入ります。
/newbotと入力し、プロンプトに従ってボットの表示名とユーザー名を設定します。作成後、ボットのユーザー名とBotFatherから返されたAPIトークンを記録します。
説明
APIトークンは大切に保管してください。このトークンを取得した人は、ボットを完全に制御できます。
グループチャットIDを取得します。
グループチャットを作成し、先ほど作成したボットを検索して追加します。
ボットが受信可能なコマンドをグループチャットで送信します。例えば、
/start@<bot_username>と入力します。ここで、<bot_username>はボットのユーザー名に置き換えてください。TelegramクライアントにはグループチャットIDが表示されないため、ブラウザでBot APIを使用して取得する必要があります。
ブラウザのアドレスバーに以下のURLを入力し、ボットが最近受信したアップデートを取得します:
URLの形式は
https://api.telegram.org/bot<token>/getUpdatesです。ここで、<token>はボット作成時に取得したAPIトークンに置き換えてください。URLの例:
https://api.telegram.org/bot123456:ABC-DEF1234ghIkl-zyx57W2v1********/getUpdates。説明
ボットにTelegram outgoing webhookが設定されている場合、
getUpdatesは使用できません。戻されたJSONデータの中から
result[].message.chat.idを探します。その値がグループチャットIDになります。説明
グループチャットがスーパーグループにアップグレードされた場合、グループチャットIDが変更される可能性があります。変更された場合は、再度取得してください。
Webhookアドレスを生成します。
以下の形式でWebhookアドレスを生成します。ここで、
<token>はボットのAPIトークンに、<chat_id>はグループチャットIDに置き換えてください。OceanBase CloudがTelegram Bot APIを呼び出す際、アラートメッセージの内容は自動的に埋め込まれます。https://api.telegram.org/bot<token>/sendMessage?chat_id=<chat_id>例:
https://api.telegram.org/bot123456:ABC-DEF1234ghIkl-zyx57W2v1********/sendMessage?chat_id=-45********Telegram WebhookをOceanBase Cloudに設定します。
- アラート連絡先の作成または編集ページの Webhook 項目で、Telegram を選択します。
- 前の手順で生成したWebhookアドレスを入力し、テスト をクリックします。
- テストに成功したら、通知言語を選択し、アラート連絡先を保存します。
Slackボット
以下の手順に従って、SlackボットのWebhookアドレスを取得し、OceanBase Cloudに設定してください:
説明
Slack Incoming Webhookの詳細な使い方については、Sending messages using incoming webhooksを参照してください。
Slackアプリケーションの管理ページに移動し、Create New App をクリックします。
From scratch を選択し、アプリケーション名を入力してターゲットのワークスペースを選択した後、Create をクリックします。
左側のナビゲーションバーで Incoming Webhooks を選択し、Activate Incoming Webhooks を有効にします。
Add New Webhook to Workspace をクリックします。
アラートを受信するためのチャンネルを選択し、Authorize をクリックします。プライベートチャンネルを選択した場合は、そのチャンネルに既に参加していることを確認してください。
Webhook URLs for Your Workspace 項目で、生成されたWebhookアドレスをコピーします。
説明
Webhookアドレスは大切に保管してください。誰でも閲覧できるウェブサイトやコードリポジトリには掲載しないでください。
OceanBase Cloudのアラート連絡先の作成または編集ページで、Slack を選択し、Webhookアドレスを入力して、テスト をクリックします。
テストに成功したら、通知言語を選択し、アラート連絡先を保存します。
カスタムURL
アラート連絡先の作成または編集時には、以下の手順に従ってカスタムWebhookアドレスを設定してください:
Webhook 項目で カスタムURL を選択します。
Webhookアドレスを入力し、必要に応じて以下の設定を行います。
パラメータ設定HTTP Header HTTPリクエストヘッダーの名前と対応する値を入力します。複数のヘッダーを追加できます。例: API-Key: ******、Content-Type: application/json;charset=UTF-8。リクエスト方式 POST または PUT を選択します。 成功応答検証ルール HTTPリクエストが正常に送信されたかどうかを判断するために使用されます。ID、タイムスタンプ、traceId、通し番号などの動的フィールドは入力しないでください。システムが応答内容を読み取って検証します。JSON応答の場合は、 {"code":"SUCCESS"}のように、値が固定されているフィールドを指定します。応答にこのキーと値のペアが含まれていれば成功です。非JSON応答の場合は、正規表現パターンを指定します。応答内容がそれに一致すれば成功です。テスト をクリックします。テストに成功したら、通知言語を選択し、アラート連絡先を保存します。
説明
カスタムWebhookアドレスがファイアウォールによって遮断された場合は、OceanBaseのサポートチームに連絡し、対応を依頼してください。