AWS LambdaでX-Rayを有効化する方法と無効化する方法

LambdaでX-Rayを有効化する方法と無効化する方法について記載します。

X-Rayを有効化するには、以下の設定を行うだけで簡単に始められます

有効化の設定

新規関数作成時
- 関数の作成
- ロールの設定
- X-Rayの設定
既存関数使用時
- ロール設定
- X-Rayの設定

X-Rayの使い方は以下の記事をご参照ください

LambdaでX-Rayを使用すると、Service Mapでサービス全体の性能を見ることができます。トレースではリクエスト毎の性能を見ることができます。トレースではコールドスタートの情報を取得することも可能です。Lambda 関数コード内の処理を AWS X-Ray でトレースすることもできます。

X-Rayを無効化したい場合は「AWS X-Rayの無効化(終了)方法」まで読み飛ばして大丈夫です。

それでは、関数作成して、X-Rayの有効化をしていきます

X-Rayの有効化

関数作成して、X-Rayを有効化していきます。

やること

関数の作成
→既存関数のX-Rayを有効化する場合はこのステップはスキップしてください
ロールの設定
X-Rayの設定

Lambda関数の作成

Lambda関数を作成します。既存関数のX-Rayを有効化する場合はこのステップはスキップしてください。

関数名：適切なもの
ランタイム：Node.js 18.x

ソースコードを以下のソースコードに置き換えデプロイします。

1秒スリープ後にレスポンスを返すソースコードになります。


const sleep = (m) => {
  return new Promise((resolve) => setTimeout(resolve, m));
};
export const handler = async(event) => {
    console.log("Start!");
    await sleep(1000);
    console.log("End!");
    const response = {
        statusCode: 200,
        body: JSON.stringify('Hello from Lambda!'),
    };
    return response;
};

Lambdaのロール設定

X-Rayを開始するために必要なロールを割り当てます。

必要なロールは、トレースデータをアップロードするロールとなります。具体的には以下の設定を追加すれば大丈夫です。


{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "xray:PutTraceSegments",
                "xray:PutTelemetryRecords"
            ],
            "Resource": [
                "*"
            ]
        }
    ]
}