# AWS X-RayでREST APIのトレース情報を取得する方法

## 目次

1. 概要
2. AWS X-Rayの設定
   1. IAMポリシーの設定
   2. X-Rayデーモンのインストール
3. REST APIのトレースを有効にする
   1. API Gatewayとの統合
   2. Lambda関数のトレース設定
4. トレースデータの確認方法
5. トラブルシューティング
6. まとめ

## 1. 概要

AWS X-Rayは、分散アプリケーションのトレース情報を提供するサービスです。API GatewayやLambda関数を利用したREST APIにおいても、リクエストの追跡が可能です。X-Rayを導入することで、アプリケーションのパフォーマンスや問題解決に役立つ情報を得ることができます。

## 2. AWS X-Rayの設定

### 2-1. IAMポリシーの設定

まず、X-Rayを利用するためのIAMロールに必要なポリシーを設定します。

以下は、基本的なポリシーの例です。

![img](/mosaic-code.jpg)

このポリシーをLambda関数やその他のサービスが使用するIAMロールにアタッチします。

### 2-2. X-Rayデーモンのインストール

X-Rayデーモンは、トレースデータを送信するために必要です。デーモンは、EC2インスタンスや、ECSタスクなどで動作させます。

- Amazon Linuxの場合、インストールは以下のコマンドで行います。

![img](/mosaic-code.jpg)

- デーモンを起動します。

![img](/mosaic-code.jpg)

## 3. REST APIのトレースを有効にする

### 3-1. API Gatewayとの統合

API GatewayでX-Rayトレースを有効にするには、各ステージのトレース設定を行います。

1. AWSコンソールからAPI Gatewayを選択します。
2. 設定したいAPIを選び、**[Settings]**を開きます。
3. **[Enable X-Ray Tracing]**オプションをチェックします。

### 3-2. Lambda関数のトレース設定

Lambda関数がX-Rayと連携してトレースを行うには、以下の設定が必要です。

1. Lambda関数を選択し、**[Configuration]** タブを開きます。
2. **[Monitoring and operations tools]** セクションで **[Enable active tracing]** を選択します。

## 4. トレースデータの確認方法

AWSコンソールでX-Rayセグメントを確認できます。

1. X-Rayコンソールを開きます。
2. **[Service Map]** でサービス間のリクエストを視覚的に確認できます。
3. **[Traces]** タブで詳細なトレース情報を確認し、リクエストの遅延やエラーなどの発生箇所を特定します。

## 5. トラブルシューティング

- X-Rayトレースが正常に取得できない場合、IAMポリシーやX-Rayデーモンの接続設定を確認してください。
- Lambda関数では、環境変数 `AWS_XRAY_CONTEXT_MISSING=LOG_ERROR` を利用して、トレース未取得時のログを確認します。

## 6. まとめ

AWS X-Rayを利用することで、分散型アプリケーションのトレース情報を詳細に取得し、性能改善やデバッグに役立てることが可能です。API GatewayおよびLambda関数でのトレース有効化は比較的容易であり、特に問題解決の迅速化に貢献します。これにより、効率的なアプリケーション運営を実現するための強力なツールとして活用できます。 [cv:issue_marketplace_engineer]

# AWS X-RayでREST APIのトレース情報を取得する方法

## 目次

1. 概要
2. AWS X-Rayの設定
   1. IAMポリシーの設定
   2. X-Rayデーモンのインストール
3. REST APIのトレースを有効にする
   1. API Gatewayとの統合
   2. Lambda関数のトレース設定
4. トレースデータの確認方法
5. トラブルシューティング
6. まとめ

## 1. 概要

AWS X-Rayは、分散アプリケーションのトレース情報を提供するサービスです。API GatewayやLambda関数を利用したREST APIにおいても、リクエストの追跡が可能です。X-Rayを導入することで、アプリケーションのパフォーマンスや問題解決に役立つ情報を得ることができます。

## 2. AWS X-Rayの設定

### 2-1. IAMポリシーの設定

まず、X-Rayを利用するためのIAMロールに必要なポリシーを設定します。

以下は、基本的なポリシーの例です。

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

このポリシーをLambda関数やその他のサービスが使用するIAMロールにアタッチします。

### 2-2. X-Rayデーモンのインストール

X-Rayデーモンは、トレースデータを送信するために必要です。デーモンは、EC2インスタンスや、ECSタスクなどで動作させます。

- Amazon Linuxの場合、インストールは以下のコマンドで行います。

```sh
sudo yum install -y amazon-cloudwatch-agent
wget https://s3.amazonaws.com/aws-xray-us-east-1/xray-daemon/aws-xray-daemon-latest-linux-x86_64.rpm
sudo rpm -Uvh aws-xray-daemon-latest-linux-x86_64.rpm
```

- デーモンを起動します。

```sh
sudo /etc/init.d/xray start
```

## 3. REST APIのトレースを有効にする

### 3-1. API Gatewayとの統合

API GatewayでX-Rayトレースを有効にするには、各ステージのトレース設定を行います。

1. AWSコンソールからAPI Gatewayを選択します。
2. 設定したいAPIを選び、**[Settings]**を開きます。
3. **[Enable X-Ray Tracing]**オプションをチェックします。

### 3-2. Lambda関数のトレース設定

Lambda関数がX-Rayと連携してトレースを行うには、以下の設定が必要です。

1. Lambda関数を選択し、**[Configuration]** タブを開きます。
2. **[Monitoring and operations tools]** セクションで **[Enable active tracing]** を選択します。

## 4. トレースデータの確認方法

AWSコンソールでX-Rayセグメントを確認できます。

1. X-Rayコンソールを開きます。
2. **[Service Map]** でサービス間のリクエストを視覚的に確認できます。
3. **[Traces]** タブで詳細なトレース情報を確認し、リクエストの遅延やエラーなどの発生箇所を特定します。

## 5. トラブルシューティング

- X-Rayトレースが正常に取得できない場合、IAMポリシーやX-Rayデーモンの接続設定を確認してください。
- Lambda関数では、環境変数 `AWS_XRAY_CONTEXT_MISSING=LOG_ERROR` を利用して、トレース未取得時のログを確認します。

## 6. まとめ

AWS X-Rayを利用することで、分散型アプリケーションのトレース情報を詳細に取得し、性能改善やデバッグに役立てることが可能です。API GatewayおよびLambda関数でのトレース有効化は比較的容易であり、特に問題解決の迅速化に貢献します。これにより、効率的なアプリケーション運営を実現するための強力なツールとして活用できます。 

AWS X-RayでREST APIのトレース情報を取得する方法

目次

続きを読むには単価診断を受けてください（30秒）