APIゲートウェイ・メトリック

APIゲートウェイによって生成されるメトリックを確認します。

メトリック、アラームおよび通知を使用してAPIゲートウェイおよびAPIゲートウェイ・サービスによって管理されるAPIゲートウェイおよびAPIデプロイメントのヘルス、容量およびパフォーマンスをモニターできます。

このトピックでは、oci_apigatewayメトリック・ネームスペースでAPIゲートウェイ・サービスによって発行されるメトリックについて説明します。

リソース: ゲートウェイ

APIゲートウェイ・サービス・メトリックの概要

APIゲートウェイ・サービス・メトリックは、APIゲートウェイへの接続、およびAPIゲートウェイによって受信および送信されたデータの量の測定に役立ちます。メトリック・データを使用して、APIゲートウェイおよびAPIデプロイメントの問題を診断およびトラブルシューティングできます。

頻度はメトリックによって異なりますが、デフォルトのサービス・メトリックの頻度は通常60秒です(1分当たりに少なくとも1つのデータ・ポイントがポストされます)。

コンソールでメトリック・チャートのデフォルト・セットを表示するには、目的のAPIゲートウェイに移動し、「メトリック」を選択します。モニタリング・サービスを使用して、カスタム問合せを作成することもできます。メトリック問合せの作成を参照してください。

前提条件

IAMポリシー: リソースをモニターするには、管理者が作成するポリシーで、必要なタイプのアクセス権が付与されている必要があります。ユーザーがコンソールを使用しているか、SDK、CLIまたはその他のツールでREST APIを使用しているかにかかわらずです。ポリシーでは、モニタリング・サービスおよびモニター対象のリソースへのアクセス権を付与されている必要があります。アクションを実行しようとして、権限がない、または認可されていないというメッセージが表示された場合は、管理者に連絡して、付与されているアクセスのタイプと作業する必要があるコンパートメントを確認してください。モニタリングのユーザー認可の詳細は、「IAMポリシー」を参照してください。

使用可能なメトリック: oci_apigateway

次の表に示すメトリックは、作成するAPIゲートウェイで自動的に使用可能になります。これらのメトリックを取得するためにリソースのモニタリングを有効にする必要はありません。

APIゲートウェイ・メトリックには、次のディメンションがあります:

RESOURCEID: メトリックが適用されるリソースのOCID。
RESOURCENAME: メトリックが適用されるリソースの名前。
DEPLOYMENTID: APIデプロイメントのOCID。
デプロイメント名: APIデプロイメントの名前。
ROUTE: バックエンド・サービスへのAPIコールのルート・パス。
HTTPMETHODTYPE: バックエンド・サービスが受け入れた受信接続のHTTPメソッド(GET、HEAD、POST、PUT、DELETEなど)。
HTTPSTATUSCODE: APIゲートウェイから受信したHTTPレスポンス・ステータス・コード(200、201、502、504など)。
HTTPSTATUSCATEGORY: APIゲートウェイから受信したHTTPレスポンス・ステータス・コードのカテゴリ(2xx、3xx、4xx、5xxなど)。
バックエンド名: APIゲートウェイがリクエストをルーティングするバックエンドの名前(バックエンド・ルールの名前から派生)。
BACKENDTYPE: APIゲートウェイがリクエストをバックエンド・サービス(HTTP_BACKEND、ORACLE_FUNCTIONS_BACKEND、STOCK_RESPONSE_BACKENDなど)にルーティングするバック・エンドのタイプ。
BACKENDHTTPSTATUSCODE: バック・エンドから受信したHTTPレスポンス・ステータス・コード(200、201、502、504など)。
BACKENDHTTPSTATUSCATEGORY: バック・エンドから受信したHTTPレスポンス・ステータス・コードのカテゴリ(2xx、3xx、4xx、5xxなど)。
RESPONSECACHERESULT: レスポンス・キャッシュによって実行されるアクション(HIT、MISS、BYPASSのいずれか)。
ENTITLEMENTNAME: 権限の名前。
サブスクライバID: サブスクライバのOCID。
SUBSCRIBERNAME: サブスクライバの名前。
クライアント名: サブスクライバのクライアントの名前。
アクション: 権限の割当て制限の期間内のリクエストの最大数を超えた場合に実行されるアクション。
使用計画ID: 使用プランのOCID。
使用プラン名: 使用プランの名前。


メトリック	メトリック表示名	単位	説明	ディメンション
`BytesReceived`	受信バイト数	バイト	APIゲートウェイがAPIクライアントから受信したバイト数。	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType`
`BytesSent`	送信バイト数	バイト	APIゲートウェイがAPIクライアントに送信したバイト数。	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType`
`HttpRequests`	APIリクエスト	カウント	APIゲートウェイが受信したAPIクライアント・リクエストの数。	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `backendType` `backendName`
`HttpResponses`	APIレスポンス	カウント	APIゲートウェイが返信したhttpレスポンスの数。	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType` `backendName`
`BackendHttpResponses`	バックエンド・レスポンス	カウント	バックエンド・サービスから返されるHTTPレスポンスの数。	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType` `backendName` `backendHttpStatusCode` `backendHttpStatusCategory`
`Latency`	ゲートウェイ・レイテンシ	秒	リクエストの処理と、そのレスポンスの送信にかかる平均時間。これは、APIゲートウェイがHTTPリクエストの最初のバイトを受信した時点から、レスポンス送信操作が完了した時点まで計算されます。	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType`
`IntegrationLatency`	バックエンド・レイテンシ	秒	APIゲートウェイがバックエンド・サービスにリクエストを送信し、バックエンド・サービスからレスポンスを受信する間の時間。	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory` `backendType`
`InternalLatency`	内部レイテンシ	秒	リクエストを処理するためにAPIゲートウェイで内部的に費やされた時間。	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `httpMethodType` `httpStatusCode` `httpStatusCategory`
`ResponseCacheAction`	レスポンス・キャッシュのアクション	数	レスポンス・キャッシュによって実行されるアクション。	`resourceId` `resourceName` `deploymentId` `deploymentName` `route` `responseCacheResult`
`ResponseCacheAvailability`	レスポンス・キャッシュの可用性	数	APIゲートウェイに表示されるレスポンス・キャッシュの可用性。	`resourceId` `resourceName`
`ResponseCacheLatency`	レスポンス・キャッシュのレイテンシ	ミリ秒	レスポンス・キャッシュに対する操作の接続、読取りおよび格納にかかる合計時間。	`resourceId` `resourceName` `deploymentId` `deploymentName` `route`
`UsagePlanRequests`	使用プラン・リクエスト	合計	指定された権限に対するリクエストの数。要求ごとに発行されます。	`resourceId` `resourceName` `entitlementName` `subscriberId` `subscriberName` `clientName` `action`
`SubscriberRequests`	サブスクライバ・リクエスト	合計	サブスクライバによって実行されたリクエスト数。要求ごとに発行されます。	`resourceId` `resourceName` `clientName` `usagePlanId` `usagePlanName` `entitlementName` `action`
`SubscriberQuotaProportionUsed`	使用済サブスクライバ割当て制限の割合	平均値	サブスクライバによって消費された資格の割当ての割合。要求ごとに発行されます。計算方法: `<current number of requests this period> / <quota for entitlement this period>`	`resourceId` `resourceName` `clientName` `usagePlanId` `usagePlanName` `entitlementName`
`SubscriberRateLimitProportionUsed`	使用済サブスクライバレート制限の割合	平均	サブスクライバによって消費された資格のレート制限の割合。要求ごとに発行されます。計算方法: `<current number of requests this period> / <rate limit for entitlement this period>`	`resourceId` `resourceName` `clientName` `usagePlanId` `usagePlanName` `entitlementName`

コンソールの使用

単一のAPIゲートウェイのデフォルトのメトリック・チャートを表示するには

「ゲートウェイ」リスト・ページで、メトリックを表示するAPIゲートウェイを選択します。リスト・ページまたはAPIゲートウェイの検索に関するヘルプが必要な場合は、APIゲートウェイのリストを参照してください。
「リソース」で、「メトリック」を選択します。

「メトリック」ページには、APIゲートウェイのメトリック・ネームスペースによって生成された各メトリックのチャートが表示されます。生成されるメトリックの詳細は、使用可能なメトリック: oci_apigatewayを参照してください。

メトリックのモニタリングおよびアラームの使用の詳細は、モニタリングの概要を参照してください。アラームの通知の詳細は、通知の概要を参照してください。

予期しているAPIゲートウェイ・メトリック・データが表示されませんか。

予期しているAPIゲートウェイのメトリック・データが表示されない場合は、次の考えられる原因および解決策を参照してください。


問題	考えられる原因	チェック方法	解決策
APIゲートウェイにデプロイされたAPIをコールしましたが、HTTPリクエスト・チャートにAPIコールが表示されません。	HTTPリクエスト・チャートの対象となる期間外にAPIをコールした可能性があります。	開始時間と終了時間がAPIをコールした期間であることを確認します。	必要に応じて、開始時間と終了時間を調整します。
APIゲートウェイにデプロイされたAPIをコールしましたが、開始時間と終了時間の間にAPIをコールした場合でも、HTTPリクエスト・チャートにはAPIコールが表示されません。	開始時間と終了時間の間にAPIをコールしましたが、x軸(データ表示のウィンドウ)でAPIコールを除外している可能性があります。	APIがコールされた期間がx軸(データ表示のウィンドウ)に含まれていることを確認します。	必要に応じて、x軸(データ表示のウィンドウ)を調整します。
チャート内のデータを連続した線として経時的に表示したいのですが、線にギャップがあります。	これは予期された動作です。選択した間隔で表示するメトリック・データがない場合、データ行は不連続になります。	間隔を増やします(たとえば、1分から5分、1分から1時間)。	必要に応じて間隔を調整します。

コンパートメント内のすべてのAPIゲートウェイのデフォルトのメトリック・チャートを表示するには

ナビゲーション・メニューを開き、「監視および管理」を選択します。「モニタリング」で、「サービス・メトリック」を選択します。
APIゲートウェイで使用するリージョンを選択します
メトリックを表示するAPIゲートウェイが含まれるコンパートメントを選択します。
「メトリック・ネームスペース」で、「oci_apigateway」を選択します。

「サービス・メトリック」ページでは、選択したメトリック・ネームスペースによって生成される各メトリックのチャートを示すために、ページが動的に更新されます。生成されるメトリックの詳細は、使用可能なメトリック: oci_apigatewayを参照してください。

メトリックのモニタリングおよびアラームの使用の詳細は、モニタリングの概要を参照してください。アラームの通知の詳細は、通知の概要を参照してください。

APIの使用

APIの使用およびリクエストの署名の詳細は、REST APIのドキュメントおよびセキュリティ資格証明を参照してください。SDKの詳細は、SDKおよびCLIを参照してください。

次のAPIをモニタリングに使用します:

メトリックおよびアラームの場合は、モニタリングAPI
(アラームで使用される)通知の場合は、通知API