Alibaba Cloud API ゲートウェイ
Alibaba Cloud API ゲートウェイ の監視データを収集します
設定¶
Func のインストール¶
推奨: Guance の統合 - 拡張 - マネージド版 Func を有効化してください
Func を自前でデプロイする場合はFunc を自前でデプロイする
有効化スクリプト¶
ヒント: 要件を満たす Alibaba Cloud AK をあらかじめ用意してください(簡単にするため、グローバルの読み取り専用権限
ReadOnlyAccessを直接付与できます)
マネージド版の有効化スクリプト¶
- Guance コンソールにログインします
- 【統合】メニューをクリックし、【クラウドアカウント管理】を選択します
- 【クラウドアカウントの追加】をクリックし、【Alibaba Cloud】を選択して画面に必要な情報を入力します。すでにクラウドアカウント情報を設定済みの場合は、この手順は省略できます
- 【テスト】をクリックし、テストに成功したら【保存】をクリックします。失敗した場合は、関連する設定情報が正しいか確認してから再テストしてください
- 【クラウドアカウント管理】の一覧で追加済みのクラウドアカウントを確認できます。該当のクラウドアカウントをクリックして詳細ページに入ります
- クラウドアカウント詳細ページの【統合】ボタンをクリックし、
未インストール一覧からAlibaba Cloud API ゲートウェイを見つけて【インストール】ボタンをクリックすると、インストール画面でインストールできます。
手動有効化スクリプト¶
-
Func コンソールにログインし、【スクリプトマーケット】をクリックして Guance スクリプトマーケットに入り、
integration_alibabacloud_apigatewayを検索します -
【インストール】をクリックしたあと、対応するパラメータとして Alibaba Cloud AK ID、AK Secret、およびアカウント名を入力します。
-
【デプロイしてスクリプトを起動】をクリックすると、システムが自動で
Startupスクリプトセットを作成し、対応する起動スクリプトを自動で設定します。 -
有効化後は、「管理 / 自動トリガー設定」で対応する自動トリガー設定を確認できます。【実行】をクリックすれば、定期実行を待たずにすぐ 1 回実行できます。少し待つと、実行タスクの記録と対応するログを確認できます。
確認¶
- 「管理 / 自動トリガー設定」で対象タスクに対応する自動トリガー設定が存在するか確認し、あわせてタスク記録とログを確認して異常がないかチェックします
- Guance の「インフラストラクチャー / カスタム」で資産情報が存在するか確認します
- Guance の「メトリクス」で対応する監視データがあるか確認します
メトリクス¶
Alibaba Cloud - CloudMonitor を設定すると、デフォルトのメトリクスセットは以下のとおりです。設定によってさらに多くのメトリクスを収集できます Alibaba Cloud CloudMonitor メトリクス詳細
API ゲートウェイ¶
| MetricName | メトリクス種別 | MetricDescribe | Dimensions | Statistics | Unit |
|---|---|---|---|---|---|
| Latency | インスタンス次元 | 応答時間 | userId,region,apiUid | Average | ms |
| SumQPS | インスタンス次元 | 総リクエスト数 | userId,region,apiUid | Count | count |
| TrafficRX | インスタンス次元 | 流入トラフィック | userId,region,apiUid | Sum | B |
| TrafficTX | インスタンス次元 | 流出トラフィック | userId,region,apiUid | Sum | B |
| code2XX | インスタンス次元 | 2XX 応答コード数 | userId,region,apiUid | Value | count |
| code429 | インスタンス次元 | 429 応答コード数 | userId,region,apiUid | Value | count |
| code4XX | インスタンス次元 | 4XX 応答コード数 | userId,region,apiUid | Value | count |
| code5XX | インスタンス次元 | 5XX 応答コード数 | userId,region,apiUid | Value | count |
| error_count_instance | apigateway | インスタンスリクエストエラー数 | userId,region,apiUid | Sum | count |
| instance_lost | apigateway | インスタンスノード喪失率 | userId,region,instanceId | Average | % |
| request_count_instance | apigateway | インスタンス総リクエスト数 | userId,region,instanceId | Sum | count |
API グループ¶
| MetricName | メトリクス種別 | MetricDescribe | Dimensions | Statistics | Unit |
|---|---|---|---|---|---|
| Latency_group | apiGroupUid | 応答時間 | userId,region,apiGroupUid | Average | ms |
| SumQPS_group | apiGroupUid | 総リクエスト数 | userId,region,apiGroupUid | Count | count |
| TrafficRX_group | apiGroupUid | 流入トラフィック | userId,region,apiGroupUid | Sum | B |
| TrafficTX_group | apiGroupUid | 流出トラフィック | userId,region,apiGroupUid | Sum | B |
| code2XX_group | apiGroupUid | 2XX 応答コード数 | userId,region,apiGroupUid | Value | count |
| code429_group | apiGroupUid | 429 応答コード数 | userId,region,apiGroupUid | Value | count |
| code4XX_group | apiGroupUid | 4XX 応答コード数 | userId,region,apiGroupUid | Value | count |
| code5XX_group | apiGroupUid | 5XX 応答コード数 | userId,region,apiGroupUid | Value | count |
API インスタンス¶
| MetricName | メトリクス種別 | MetricDescribe | Dimensions | Statistics | Unit |
|---|---|---|---|---|---|
| Latency_instance | インスタンス次元 | 応答時間 | userId,region,instanceId | Average | ms |
| SumQPS_instance | インスタンス次元 | 総リクエスト数 | userId,region,instanceId | Count | count |
| TrafficRX_instance | インスタンス次元 | 流入トラフィック | userId,region,instanceId | Sum | B |
| TrafficTX_instance | インスタンス次元 | 流出トラフィック | userId,region,instanceId | Sum | B |
| code2XX_instance | インスタンス次元 | 2XX 応答コード数 | userId,region,instanceId | Value | count |
| code429_instance | インスタンス次元 | 429 応答コード数 | userId,region,instanceId | Value | count |
| code4XX_instance | インスタンス次元 | 4XX 応答コード数 | userId,region,instanceId | Value | count |
| code5XX_instance | インスタンス次元 | 5XX 応答コード数 | userId,region,instanceId | Value | count |
オブジェクト¶
収集された Alibaba Cloud API ゲートウェイのオブジェクトデータ構造。オブジェクトデータは「インフラストラクチャー-カスタム」で確認できます
{
"measurement": "aliyun_apigateway",
"tags": {
"instance_spec" : "api.s1.small",
"instance_name" : "xxxx-test",
"instance_id" : "i-xxxxx",
"region_id" : "cn-hangzhou"
},
"fields": {
"zone_local_name" : "xxxxx",
"internet_egress_address" : "114.55.1xx.xxx",
"created_time" : "2025/09/01 16:10:09",
"vpc_egress_address" : "100.xxx.xxx.0/xx",
"instance_spec_attributes" : "xxxxx",
"instance_charge_type" : "PayAsYouGo",
"vpc_slb_intranet_enable" : "False",
"instance_type" : "VPC_SHARED",
"status" : "RUNNING",
"zone_id" : "cn-hangzhou",
"instance_cidr_block" : "172.16.xx.xx/xx",
"ipv_6_acl_status" : "off",
"egress_ipv_6_enable" : "False",
"maintain_start_time" : "18:00Z",
"maintain_end_time" : "22:00Z"
}
}
注意:
tags、fieldsのフィールドは、今後の更新により変更される場合があります