重要
AWS CloudWatch Metric Streams統合を有効にして、カスタムネームスペースを含むAWSサービスからのすべてのCloudWatchメトリクスをモニターします。個別の統合は、もはや推奨されるオプションではありません。
New Relic infrastructure integrations には、Amazon API Gateway のデータを New Relic にレポートするための統合があります。このドキュメントでは、この統合を有効にする方法と、レポート可能なデータについて説明します。
ヒント
API Gateway v1 メトリクスは、Amazon API Gateway の API ポーリング統合を通じてのみ利用できます。 API Gateway v2 メトリクスは、 CloudWatch Metric Streamsを通じてストリーミングされます。
特徴
AmazonのAPI Gateway は、あらゆる規模のAPIを作成、公開、維持、監視、保護することができるフルマネージドサービスです。New Relic API Gatewayの統合により、APIレイヤーが舞台裏でどのように機能しているか、より多くのデータを得ることができます。APIコールの数、処理されたリクエスト、エラーの数、レイテンシーカウントなどの指標データを受け取ることができます。
API ゲートウェイのデータを New Relic から直接監視したり、アラートを出したりすることができ、データの照会やダッシュボードの作成も可能です。
要件
API Gateway は、CloudWatch の詳細メトリクスを明示的に有効にしていない限り、"Call count by resource" 、"4xx error by resource" 、"5xx errors by resource" のメトリクスを送信しません。
ヒント
これらのメトリクスを有効にすると、 Amazon CloudWatchアカウントの価格設定に追加料金が発生する場合があります 。
CloudWatchメトリクスを有効にするには、以下のいずれかのオプションを使用します。
AWSマネジメントコンソールに移動し、CloudWatch の
Settings
オプションを選択してから、詳細な CloudWatch メトリックを有効にするオプションを選択します。
Amazon API Gateway REST APIの
stage:update
アクションを呼び出して、metricsEnabled
プロパティをtrue
に更新します。
統合をアクティブ化する
この統合を有効にするには、標準の手順に従ってAWSサービスをNewRelicに接続します。
構成とポーリング
構成オプションを使用して、ポーリング頻度とフィルターデータを変更できます。
デフォルト ポーリング Amazon APIゲートウェイ統合のための情報です。
- New Relicのポーリング間隔:5分
- Amazon CloudWatchデータ間隔:1分
データを見つけて使用する
インフラストラクチャUIでインテグレーション データを検索するには、one.newrelic.com > All capabilities > Infrastructure > AWS に移動し、 API Gateway インテグレーション リンクの 1 つを選択します。
ApiGatewaySample
イベントタイプを使用してデータをクエリおよび探索できます。
データの使用方法の詳細については、統合データの理解と使用を参照してください。
メトリックデータ
このNew Relicインフラストラクチャ統合は、以下のAmazon API Gatewayデータを収集します。
メトリック | 説明 |
---|---|
| クライアント側で捕捉されたエラーの数 |
| 捕捉されたサーバー側のエラーの数です。 |
| APIキャッシュから提供されたリクエストの数です。 |
| API キャッシュが有効な場合にバックエンドから提供されるリクエストの数。 |
| APIメソッドの呼び出し回数です。 |
| API Gateway がリクエストをバックエンドにリレーしてから、バックエンドからレスポンスを受信するまでのミリ秒単位の時間。 |
| API Gatewayがクライアントからのリクエストを受信してから、クライアントにレスポンスを返すまでの時間(ミリ秒)。レイテンシーには、統合レイテンシーとその他のAPI Gatewayのオーバーヘッドが含まれます。 |
ディメンション
次の表の ディメンション を使って、API Gateway のメトリクスをフィルタリングすることができます。
ディメンション | 説明 |
---|---|
| 指定されたAPI名のAPIに対するAPI Gatewayメトリクスをフィルタリングします。 |
| 指定されたAPI、ステージ、リソース、メソッドのAPIメソッドに対するAPI Gatewayメトリクスをフィルタリングします。 |
| 指定されたAPIとステージのAPIステージのAPI Gatewayメトリクスをフィルタリングします。 |