Soracom

Funk を利用して、AWS Lambda の関数を実行し、Slack へ通知できます。

ステップ 1: Slack の Webhook URL を発行する

Slack の Webhook URL を発行します。詳しくは、Slack App の Incoming Webhook を利用する を参照してください。

ステップ 2: AWS Lambda の関数を作成する

このページで説明する機能を体験するために、お客様の AWS アカウントに以下の設定の AWS Lambda の関数を作成します。操作手順について詳しくは、AWS Lambda の関数を作成する を参照してください。

import https from "https";
import url from "node:url";
const slackUrl = process.env.SLACK_URL;

export const handler = async function (e, ctx) {
  console.log("event: %j", e);
  console.log("context: %j", ctx);

  var slackReqOptions = url.parse(slackUrl);
  slackReqOptions.method = "POST";
  slackReqOptions.headers = { "Content-Type": "application/json" };

  var payload = {
    text: "--- *lambda function called with following parameters.* ---",
    attachments: [
      {
        title: "clientContext",
        color: "#34cdd7",
        text: "```\n" + JSON.stringify(ctx.clientContext, null, "  ") + "```\n",
        mrkdwn_in: ["text"],
      },
      {
        title: "event",
        color: "#e47911",
        text: "```\n" + JSON.stringify(e, null, "  ") + "```\n",
        mrkdwn_in: ["text"],
      },
    ],
  };
  var body = JSON.stringify(payload);
  slackReqOptions.headers = {
    "Content-Type": "application/json",
    "Content-Length": Buffer.byteLength(body),
  };

  try {
    // https.request を Promise を使わずに async/await で扱う
    const res = await new Promise((resolve, reject) => {
      const req = https.request(slackReqOptions, (res) => {
        resolve(res);
      });
      req.on("error", (e) => {
        reject(e);
      });
      req.write(body);
      req.end();
    });

    if (res.statusCode === 200) {
      console.log("Posted to slack");
      return { result: "ok" };
    } else {
      return { result: "ng", reason: "Failed to post slack " + res.statusCode };
    }
  } catch (error) {
    console.error("Error posting to slack:", error);
    return { result: "ng", reason: error.message };
  }
};

この関数の ARN は、これ以降、${lambda_func_arn} と表記します。例: arn:aws:lambda:ap-northeast-1:XXXXXXXXXXXX:function:funk-sample-button

ステップ 3: IAM ポリシーと IAM ロールを作成する

Funk が、お客様の AWS アカウントの AWS Lambda の関数 URL を呼び出すために、お客様の AWS アカウントに以下の設定の IAM ポリシーと IAM ロールを作成します。操作手順について詳しくは、IAM ポリシーと IAM ロールを作成する を参照してください。

ステップ 4: SORACOM Funk をセットアップする

IoT SIM を利用するデバイスから送信されたデータに応じて、Funk から AWS Lambda の関数を呼び出すための設定を、SORACOM ユーザーコンソールで行います。

認証情報ストアに AWS IAM ロール認証情報を登録する

Funk から AWS Lambda の関数を呼び出すために、IAM ロールに関する認証情報を、SORACOM ユーザーコンソールに登録します。

具体的には、認証情報ストアの「認証情報を登録」画面で以下のように登録します。この画面の表示方法については、認証情報を登録する を参照してください。

SORACOM Funk を有効化する

IoT SIM に対して Funk を有効化します。

1. SIM グループ画面で [SORACOM Funk 設定] をクリックします。

   SIM グループ画面を表示する操作について詳しくは、グループの設定を変更する を参照してください。

2. スイッチをクリックして「ON」にします。

3. 以下の項目を設定します。

   項目	説明
   [サービス]	「AWS Lambda」を選択します。
   [関数の ARN]	${lambda_func_arn} を入力します。例: arn:aws:lambda:ap-northeast-1:XXXXXXXXXXXX:function:funk-sample-button
   [認証情報]	認証情報ストアに AWS IAM ロール認証情報を登録する で登録した認証情報を選択します。例: AWS-IAM-role-credentials-invokeFunction
   [送信データ形式]	ここでは、「JSON」を選択します。詳しくは、SORACOM Funk を有効化する を参照してください。

   

4. [保存] をクリックします。

5. IoT SIM が所属するグループを切り替えます。

   IoT SIM の Funk の設定が完了しました。

ステップ 5: デバイスから Slack へ通知を行う

Funk を利用して AWS Lambda の関数を実行し、Slack へ通知します。

動作確認のために、Funk を有効化した IoT SIM を利用するデバイスで、Unified Endpoint の HTTP エントリポイント にリクエストを送信します。

$ curl -v -X POST http://uni.soracom.io \
-H "content-type:application/json" \
-d '{
  "hello": "funk"
}' 

Slack に以下のようなメッセージが送信されます。

トラブルシューティング

Slack へ通知できなかった場合は、以下の点を確認してください。

SORACOM Harvest Data を有効化してデータが保存されること

Unified Endpoint に送信しているため、SORACOM Harvest Data を有効化する と、送信したデータが Harvest Data にも保存されます。Harvest Data を有効化してから、もう一度 ステップ 5: デバイスから Slack へ通知を行う の手順に従ってデバイスからリクエストを送信してください。

Harvest Data を有効化しても、送信したデータが Harvest Data に保存されない場合は、以下の点を確認してください。

• デバイスから SORACOM に到達できること。

  たとえば、デバイスで PING 応答サービス を利用して、IoT SIM を利用するデバイスから SORACOM に到達できることを確認してください。

• Funk および Harvest Data を有効化したグループに、IoT SIM が所属できていること。

  SIM 管理画面で、デバイスで利用する IoT SIM の [グループ] 欄に、Funk および Harvest Data を有効化したグループが表示されていることを確認してください。詳しくは、IoT SIM の情報を確認する を参照してください。

AWS Lambda にデータが送信されていること

AWS Lambda のログで、Funk で転送されたデータが AWS Lambda に送信されていることを確認できます。

• Harvest Data にデータが保存されているのに、AWS Lambda のログで確認できない場合は、ステップ 4: SORACOM Funk をセットアップする の設定 ([関数の ARN] に入力した ARN や [認証情報] で選択した認証情報) が正しいことを確認してください。

  認証情報ストアに登録した AWS IAM ロール認証情報 は確認できません。

• AWS Lambda でログが確認できたのに、Slack へ通知されない場合は、ステップ 2: AWS Lambda の関数を作成する の設定 (コードソースや環境変数) が正しいことを確認してください。