MENU

Soracom

Users

Notification Channel

SORACOM Lagoon (以降、Lagoon) の Alert 機能では、 Alert Rule で設定した Alert 状態への遷移及びその解除の際に、Notification Channel で設定した方法で通知されます。なお、各 Alert Rule は複数の Notification Channel を指定できます。

Notification Channel の作成

まず SORACOM Lagoon ホーム画面のサイドメニュー AlertingNotification Channel をクリックします。

続いて、 New channnel をクリックします。

Notification Channel の設定画面が表示されるので、必要な項目を入力或いは選択します。

Notification Channel の設定項目

  • Name : Notification Channel の名前を入力します。この名前は、ユーザーが Alert Rule に Notification Channel を追加するときに表示されます。
  • Type : チャンネルタイプを選択します。詳細は 動作確認済みのチャンネルタイプ を参照ください。
  • Default : このオプションを選択すると、すべての Alert Rule にこの Notification Channel が指定されます。
  • Include Image : このオプションを選択すると、通知内容に Graph のスクリーンショットを含めることができます。このオプションはデフォルトで選択されています。
  • Disable Resolve Message : このオプションを選択すると、Alert 解除通知を省略できます。
  • Send reminders : このオプションを選択すると、Alert 状態に遷移した後に一定間隔で追加の通知 (リマインダー) を送信できます。リマインダーを送信する頻度は、30s、3m、5m、1h など、秒 (s)、分 (m)、時間 (h) で指定できます。
  • Save : 設定を保存します。
  • Test : Alert のテスト送信ができます。
リマインダーは Alert Rule が評価されるタイミングで送信されます。そのため、リマインダーは設定した Alert Rule の評価間隔よりも短い間隔では送信できません。また、リマインダーの送信間隔は Alert Rule の評価間隔の倍数となります。以下の例では、設定した評価間隔及びリマインダー送信間隔に対する実際のリマインダーの送信間隔を示します。
Alert Rule に設定した評価間隔Send reminders に設定したリマインダー送信間隔実際のリマインダー送信間隔
30s15s~30s
1m5m~5m
5m15m~15m
6m20m~24m
1h15m~1h
1h2h~2h

動作確認済みのチャンネルタイプ

Notification Channel は以下のチャンネルタイプで動作確認を実施しております。

  • Email
  • Slack
  • LINE
  • webhook
上記を除くチャンネルタイプについては、予期できない挙動により正常に動作しない場合があります。

Email

  • Addresses : Alert 通知先のメールアドレスを指定します。複数のメールアドレスを登録する場合は ; で区切ります。
  • Optional Email settings
    • Single email : このオプションを選択すると、Addresses に指定したメールアドレス宛に 1 通のメールが送信されます。オプションを選択しない場合は、Addresses に指定したアドレスごとにそれぞれメールが送信されます。(例えば、Addresses に 3 つのメールアドレスを登録した場合は、3 通のメールが送信されます。)

Slack

  • Url : Slack の chat.postMessage の エンドポイント https://slack.com/api/chat.postMessage を入力します。(設定手順は こちら を参照ください。)
  • Optional Slack settings
    • Recipient : Alert 通知先のチャンネル、或いはユーザーの設定を入力します。それぞれ以下のように指定します。
      • チャンネル : #<channel> (全て小文字、空白なし) 或いは channel Slack ID。 例: #general
      • ユーザー : @<user> (全て小文字、空白なし) 或いは user Slack ID。 例: @demo
    • Username : Slack bot のユーザー名を入力します。
    • Icon emoji : Slack bot のメッセージのアイコンとして使用する絵文字を入力します。例: :smile:
    • Icon URL : Slack bot のメッセージのアイコンとして使用する画像の URL を入力します。
    • Mention Users : Alert を通知する際にメンションするユーザーを入力します。
    • Mention Groups : Alert を通知する際にメンションするグループを入力します。
    • Mention Channel : Alert を通知する際に「チャンネルのメンバー全員にメンション」「チャンネルのアクティブなメンバーにメンション」を選択します。
      • Every channel member : チャンネルのメンバー全員にメンション (@channel)
      • Every active channel member : チャンネルのアクティブなメンバーにメンション (@here)
    • Token : Slack API の Token を入力します。Token の取得手順は以下を参照ください。

設定手順

ここではチャンネルタイプ Slack を利用する際の設定手順をご紹介します。

  1. Notification Channel を設定します。(各項目に入力する内容はスクリーンショットの下に記載しています)
    1. Urlhttps://slack.com/api/chat.postMessage を入力します。
    2. Recipient に通知先の Slack チャンネルを入力します。例: #general
    3. Token に以下の手順で取得した Slack API の Token を入力します。
      1. https://api.slack.com/apps にアクセスします。
      2. 画面右上の Create New App をクリックします。
      3. Create a Slack App というダイアログが表示されるので、 App Name にアプリ名を入力して Development Slack Workspace から対象のワークスペースを選択し、 Create App をクリックします。
      4. Permissions をクリックします。
      5. Scopes でアプリに権限を付与します。 Add an OAuth Scope ボタンをクリックして chat:write (メッセージの投稿)、 files:write (ファイルアップロード) を追加します。
      6. Install to Workspace をクリックします。
      7. 対象の Workspace を確認して間違いがなければ、 Allow をクリックします。
      8. Token が発行されます。
  2. Slack の通知先のチャンネルに作成したアプリを追加します。
    1. Slack で通知先のチャンネル名をクリックし、 MoreAdd apps をクリックします。
    2. 対象のアプリを検索して、 Add をクリックします。

以上でチャンネルタイプ Slack を利用する際の設定は完了です。

LINE

  • Token : LINE のアクセストークンを入力します。アクセストークンは以下の手順で取得します。
    1. LINE Notify にログインします。
    2. 画面右上のプルダウンから マイページ をクリックします。
    3. 画面下の トークンを発行する をクリックします。
    4. トークン名を入力、トークルームを選択した後、 発行する をクリックします。
    5. トークンが発行されるので、コピーします。

webhook

  • Url : Webhook URL を入力します。
  • Optional Webhook settings
    • Http Method : POST, PUT を選択します。
    • Username/Password : authorization ヘッダに Base64 エンコードされたユーザー名、パスワードを付加します。BASIC 認証がかけられた URL にアクセスする場合に利用します。