• ログイン無料アカウント

本書は、お客様のご参考のために原文の英語版を機械翻訳したものです。

英語版と齟齬がある場合、英語版の定めが優先するものとします。より詳しい情報については、本リンクをご参照ください。

問題を作成する

Amazon API Gatewayのモニタリング統合

重要

AWS CloudWatch Metric Streams integration を有効にすると、カスタムネームスペースを含むAWSサービスからのすべてのCloudWatchメトリクスを監視することができます。個別の統合はもはや推奨されるオプションではありません。

New Relic infrastructure integrations には、Amazon API Gateway のデータを New Relic にレポートするための統合があります。このドキュメントでは、この統合を有効にする方法と、レポート可能なデータについて説明します。

機能

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 Management Consoleにアクセスし、CloudWatchの Settings オプションを選択し、CloudWatchの詳細なメトリクスを有効にするオプションを選択します。
  • Amazon API Gateway REST API の stage:update アクションを呼び出して、 metricsEnabled プロパティを true に更新します。

統合を有効にする

このインテグレーションを有効にするには、標準手順に従い、AWSサービスをNew Relicに接続します

設定およびポーリング

設定オプションを使用し、ポーリングの頻度を変更し、データを絞り込むことができます。

デフォルト ポーリング Amazon APIゲートウェイ統合のための情報です。

  • New Relicのポーリング間隔:5分
  • Amazon CloudWatchのデータ間隔:1分

データの検索と使用

インフラストラクチャーで統合データを見つけるには、 one.newrelic.com > インフラストラクチャー> AWS にアクセスし、API Gateway統合リンクの1つを選択します。

ApiGatewaySample イベントタイプを使用して、データのクエリと探索を行うことができます。

データの利用方法については、 統合データの理解と利用 を参照してください。

メトリックデータ

このNew Relicインフラストラクチャ統合は、以下のAmazon API Gatewayデータを収集します。

メトリック

説明

4XXError

クライアント側で捕捉されたエラーの数

5XXエラー

捕捉されたサーバー側のエラーの数です。

CacheHitCount

APIキャッシュから提供されたリクエストの数です。

CacheMissCount

APIキャッシングが有効な場合に、バックエンドから提供されたリクエストの数です。

Count

APIメソッドの呼び出し回数です。

IntegrationLatency

API Gatewayがバックエンドにリクエストを中継してから、バックエンドからレスポンスを受信するまでの時間(ミリ秒)です。

レイテンシー

API Gatewayがクライアントからのリクエストを受信してから、クライアントにレスポンスを返すまでの時間(ミリ秒)。レイテンシーには、統合レイテンシーとその他のAPI Gatewayのオーバーヘッドが含まれます。

インベントリデータ

有効期限(EOL)の通知

2022年3月以降は、クラウド統合用のインベントリデータなど、いくつかの機能のサポートを終了します。この移行に向けて簡単に準備できる方法など、詳細については、 Explorers Hubの投稿 をご覧ください。

インベントリデータは、サービスの状態と構成に関する情報を提供します。API Gatewayの構成オプションは、インベントリデータとして報告されます。インベントリデータの詳細については、 Understand and use data を参照してください。

オブジェクト

インベントリデータ

/aws/apigateway/api

apiId

apiName

awsRegion

/aws/apigateway/resource

awsRegion

メソッド

リソース

リソースID

/aws/apigateway/stage

apiName

awsRegion

cacheClusterEnable

cacheClusterSize

cacheClusterStatus

lastUpdatedDate

ステージ名

/aws/apigateway/stage/variables

value

/aws/apigateway/stage/settings

CacheDataEncrypted

CacheTtlInSeconds

CachingEnabled

DataTraceEnabled

ログインレベル

MetricsEnabled

RequireAuthorizationForCacheControl

UnauthorizedCacheControlHeaderStrategy

ThrottlingBurstLimit

スロットリングレートリミット

/aws/apigateway/stage/resource-with-metrics

apiName

awsRegion

メソッド

リソース

ステージ名

ディメンション

次の表の ディメンション を使って、API Gateway のメトリクスをフィルタリングすることができます。

ディメンション

説明

ApiName

指定されたAPI名のAPIに対するAPI Gatewayメトリクスをフィルタリングします。

ApiName, Method, Resource, Stage

指定されたAPI、ステージ、リソース、メソッドのAPIメソッドに対するAPI Gatewayメトリクスをフィルタリングします。

ApiName, Stage

指定されたAPIとステージのAPIステージのAPI Gatewayメトリクスをフィルタリングします。

Copyright © 2022 New Relic Inc.