# API Gateway で AWS X-Ray サービスマップとトレースビューを使用する
<a name="apigateway-using-xray-maps"></a>

このセクションでは、[AWS X-Ray](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-apigateway.html) サービスマップとトレースビューを API Gateway で使用する方法について詳しく説明します。

**Topics**
+ [X-Ray のサービスマップの例](#apigateway-using-xray-maps-active)
+ [X-Ray のトレースビューの例](#apigateway-using-xray-trace-view-active)

## X-Ray のサービスマップの例
<a name="apigateway-using-xray-maps-active"></a>

AWS X-Ray サービスマップは、API とそのすべてのダウンストリームサービスに関する情報を表示します。API Gateway で API のステージに対して X-Ray を有効にすると、サービスマップにノードが表示され、API Gateway のサービスにかかった全体の時間についての情報が示されます。レスポンスのステータスに関する詳細情報、および選択されたタイムフレームの API 応答時間のヒストグラムを取得できます。AWS Lambda や Amazon DynamoDB などの AWS のサービスと統合している API では、それらのサービスに関連するパフォーマンスメトリクスを提供するノードの数が多くなります。API ステージごとにサービスマップが作成されます。

以下の例に示しているのは、`test` という API の `xray` ステージのサービスマップです。この API には 2 つの Lambda 統合があります。ノードは、API Gateway サービス、と 2 つの Lambda 関数を表しています。

サービスマップ構造の詳細については、「[X-Ray トレースマップを使用する](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-console.html#xray-console-servicemap)」を参照してください。

![\[API Gateway の API のステージのサービスマップの例\]](http://docs.aws.amazon.com/ja_jp/apigateway/latest/developerguide/images/apigateway-xray-servicemap-2.png)


サービスマップから拡大して API ステージのトレースビューを表示できます。トレースには、API に関する詳細情報が、セグメントおよびサブセグメントとして表示されます。例えば、上記のサービスマップのトレースには、Lambda サービスと Lambda 関数のセグメントが含まれます。詳細については、[AWS LambdaおよびAWS X-Ray](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-lambda.html)を参照してください。

X-Ray のサービスマップでノードまたはエッジを選択すると、X-Ray コンソールにレイテンシーの分布のヒストグラムが表示されます。レイテンシーのヒストグラムを使用して、サービスでリクエストを完了するのにかかる時間を確認できます。次の図は、上記のサービスマップの `xray/test` という API Gateway のステージのヒストグラムです。レイテンシー分散ヒストグラムの詳細については、「[レイテンシーのヒストグラムを使用する](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-console.html#xray-console-histograms)」を参照してください。

![\[API Gateway の API のステージの X-Ray のヒストグラム\]](http://docs.aws.amazon.com/ja_jp/apigateway/latest/developerguide/images/apigateway-xray-histogram-1.png)


## X-Ray のトレースビューの例
<a name="apigateway-using-xray-trace-view-active"></a>

次の図は、Lambda バックエンド関数を使用して、上記のサンプル API で生成されたトレース ビューを示しています。正常に行われた API メソッドリクエストと、レスポンスコード 200 を示しています。

トレースビューの詳細については、「[トレースとトレースの詳細を表示する](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-console.html#xray-console-traces)」を参照してください。

![\[アクティブトレースを有効にした API Gateway\]](http://docs.aws.amazon.com/ja_jp/apigateway/latest/developerguide/images/apigateway-xray-traceview-1.png)