AWS API Gateway¶

AWS API Gateway の表示指標には、リクエスト応答時間、スループット、同時接続数、エラー率が含まれます。これらの指標は、API Gateway が API リクエストの処理とトラフィック管理を行う際のパフォーマンスと信頼性を示します。

設定¶

Func のインストール¶

Guance の統合 - 拡張 - マネージド版 Func を有効にすることを推奨します。前提条件はすべて自動でインストールされるため、そのままスクリプトのインストールを続けてください

Func を自分でデプロイする場合はFunc を自分でデプロイを参照してください

インストールスクリプト¶

ヒント：要件を満たす AWS AK を事前に用意してください（簡単にするため、全体の読み取り専用権限 ReadOnlyAccess を直接付与しても構いません）

マネージド版有効化スクリプト¶

Guance コンソールにログインします
[統合] メニューをクリックし、[クラウドアカウント管理] を選択します
[クラウドアカウントを追加] をクリックし、[AWS] を選択して画面に必要な情報を入力します。以前にクラウドアカウント情報を設定済みの場合は、この手順は省略できます
[テスト] をクリックし、成功したら [保存] をクリックします。失敗した場合は、関連する設定が正しいか確認してから再度テストしてください
[クラウドアカウント管理] の一覧で追加済みのクラウドアカウントを確認できます。該当するクラウドアカウントをクリックして詳細ページに入ります
クラウドアカウント詳細ページの [統合] ボタンをクリックし、未インストール リストから AWS API Gateway を見つけて [インストール] ボタンをクリックし、表示されるインストール画面でインストールします

手動有効化スクリプト¶

Func コンソールにログインし、[スクリプトマーケット] をクリックして Guance スクリプトマーケットに入り、integration_aws_gateway を検索します
[インストール] をクリックし、対応するパラメータである AWS AK ID、AK Secret、アカウント名を入力します
[デプロイして起動] をクリックすると、システムが自動的に Startup スクリプトセットを作成し、対応する起動スクリプトを自動で設定します
有効化後は、「管理 / 自動トリガー設定」で該当する自動トリガー設定を確認できます。[実行] をクリックすると、定期実行を待たずにすぐ 1 回実行できます。少し待ってから、実行タスクの記録および対応するログを確認できます

検証¶

「管理 / 自動トリガー設定」で該当タスクに対応する自動トリガー設定が存在するか確認し、あわせてタスク記録とログを確認して異常がないかチェックします
Guance の「インフラストラクチャ / カスタム」で資産情報が存在するか確認します
Guance の「メトリクス」で対応する監視データがあるか確認します

指標¶

AWS CloudWatch を設定すると、既定の指標セットは次のとおりです。設定によってさらに多くの指標を収集できます AWS CloudWatch 指標の詳細

インスタンス指標¶

AWS/ApiGateway 名前空間には以下のインスタンス指標が含まれます。

指標	説明
`4XXError`	指定期間中に捕捉されたクライアントエラー数。Sum 統計値はこの指標の、指定期間内における 4XXError の総件数を示します。Average 統計値は 4XXError のエラー率、つまり 4XXError の総件数をその期間のリクエスト総数で割った値を示します。分母は Count 指標（下記参照）に対応します。Unit: Count
`5XXError`	指定期間中に捕捉されたサーバー側エラー数。Sum 統計値はこの指標の、指定期間内における 5XXError の総件数を示します。Average 統計値は 5XXError のエラー率、つまり 5XXError の総件数をその期間のリクエスト総数で割った値を示します。分母は Count 指標（下記参照）に対応します。Unit: Count
`Count`	指定期間内の API リクエスト総数。SampleCount 統計値はこの指標を示します。Unit: Count
`Latency`	API Gateway がクライアントからリクエストを受信してから、そのレスポンスをクライアントへ返すまでの経過時間です。遅延には統合遅延とその他の API Gateway のオーバーヘッドが含まれます。Unit: Millisecond

オブジェクト¶

収集された AWS API Gateway のオブジェクトデータ構造です。「インフラストラクチャ-カスタム」でオブジェクトデータを確認できます

{
  "measurement": "aws_gateway",
  "tags": {
    "account_name"   : "AWS",
    "api_name"       : "helloworld-API",
    "ApiId"          : "c72z3thtq8",
    "ApiKeySelectionExpression": "$request.header.x-api-key",
    "class"          : "aws_gateway",
    "cloud_provider" : "aws",
    "create_time"    : "2023/08/07 14:29:19",
    "CreatedDate"    : "2022-11-11T09:17:35Z",
    "date"           : "2023/08/07 14:29:19",
    "date_ns"        :"0",
    "Description"    :"Created by AWS Lambda",
    "instance_tags"  :"{}",
    "name"           :"c72z3thtq8",
    "ProtocolType"   :"HTTP",
    "region_id"      :"cn-northwest-1"
  }
}

注意：tags、fields 内のフィールドは、今後の更新に伴って変更される場合があります

ヒント 1：ApiId の値はインスタンス ID であり、一意識別子として使用されます