OCI API Gatewayの監視

Oracle Cloud Infrastructure（OCI）API Gatewayは、APIを大規模に公開、保護、監視、管理できるフルマネージドサービスです。バックエンドサービスの単一エントリーポイントとして機能し、認証、リクエスト検証、レート制限、トラフィック管理ポリシーを適用しながら、クライアントリクエストをサポート対象のバックエンドリソースにルーティングします。

OCI API Gatewayとの連携により、API Gatewayリソースとデプロイメントの健全性とパフォーマンスをエンドツーエンドで可視化できます。ゲートウェイのアクティビティを監視し、デプロイメントのパフォーマンスを分析し、しきい値を設定し、アラートを受信することで、APIの可用性と応答性に影響を与える問題を迅速に特定できます。

OCI API Gatewayとの連携により、以下の監視タイプを監視できます：

• API Gateway
  OCI API Gatewayインスタンスの全体的な健全性、可用性、運用パフォーマンスを監視します。
• APIデプロイメント
  OCI API Gatewayインスタンス内で実行されている個々のAPIデプロイメントを監視し、設定されたバックエンドサービスのパフォーマンスを追跡します。
• APIルート
  APIデプロイメント内で設定されたルートを監視し、その設定と関連するバックエンドルーティングを可視化します。

ゲートウェイとデプロイメントの両方を監視することで、運用チームは問題の原因がゲートウェイ層にあるのか、特定のデプロイメント内にあるのかを迅速に切り分けることができます。監視アプリケーションのアラート機能、しきい値プロファイル、ダッシュボード、レポートと組み合わせることで、OCI API Gatewayの監視は、クラウド環境全体で信頼性の高いAPI配信を保証するのに役立ちます。

目次

• ユースケース
• OCI API Gateway連携の利点
• 設定
• ポリシーと権限
• ポーリング間隔
• サポートしているメトリクス
• しきい値設定
• ライセンス
• 監視グループを使用したOCI API Gatewayの整理
• キャパシティプランニング
• API Gatewayデータの表示
• 監視データ

ユースケース

中断のないAPI可用性を確保

ある組織が、OCI API Gatewayを通じて顧客向けAPIを公開しています。ビジネスのピーク時間中に、あるデプロイメントで異常なトラフィックが発生したため、応答時間が増加し始めました。監視アプリケーションはパフォーマンスの低下を検出し、設定されたしきい値に基づいてアラートを生成し、管理者は顧客が広範囲なサービス中断を経験する前に、影響を受けているデプロイメントを迅速に特定できます。

複数のバックエンドサービスを監視

ある開発チームが、単一のゲートウェイを通じて複数のAPIをデプロイし、それぞれがコンピュートインスタンス、OCI Functions、ロードバランサーなどの異なるバックエンドサービスにリクエストをルーティングしています。各デプロイメントは個別に監視されるため、管理者は各サービスを手動で検査することなく、どのバックエンドがパフォーマンス低下の原因であるかを特定できます。

本番デプロイメントの検証

新しいAPIバージョンが本番環境にデプロイされます。リリース直後にデプロイメントメトリクスを監視することで、運用チームはトラフィックが正常に処理されていることを確認し、予期しないパフォーマンス問題が発生していないことを確認します。

OCI API Gateway連携の利点

OCI API Gatewayとの連携には、以下の利点があります。

• 単一のコンソールからAPI Gatewayの可用性と運用状態を監視できます。
• 個々のデプロイメントのパフォーマンスをゲートウェイとは独立して追跡できます。
• API利用者に影響が及ぶ前にパフォーマンスの低下を検出できます。
• しきい値プロファイルを設定して、プロアクティブなアラートを受信できます。
• ゲートウェイとデプロイメントの情報を一緒に表示して、より迅速な根本原因分析が可能です。
• 監視対象のAPI Gatewayを監視グループを使用して整理し、運用を簡素化できます。
• API Gatewayの監視をダッシュボード、レポート、インシデント管理ワークフローと連携できます。

設定

• 監視アプリケーションは、クロステナンシアクセスを使用して、テナンシユーザーを使ってリソースを監視します。アカウントにログインし、特定のポリシーを作成して、セキュリティに影響を与えることなく監視アプリケーションがリソースを表示できるようにします。
• ［OCI監視の連携］ページで、［ディスカバリするサービス］一覧から［API Gateway］を選択します。

ポリシーと権限

関連するOCIポリシーに以下のステートメントが含まれていることを確認してください。

• "ListGateways",
• "GetGateway",
• "ListDeployments",
• "GetDeployment"

ポーリング間隔

監視アプリケーションは、設定されたポーリング頻度（1分に1回から1日に1回まで）に従ってOCIサービスレベルのAPIをクエリし、API Gateway監視からメトリクスを収集します。

サポートしているメトリクス

API Gateway監視でサポートされているメトリクスは以下の通りです。

しきい値設定

API Gateway監視のしきい値を設定するには、

1. アカウントにログインし、［管理］→［設定プロファイル］→［しきい値と可用性］に移動します。
2. ［しきい値プロファイルの追加］をクリックします。
3. ［監視タイプ］ドロップダウンメニューから［API Gateway］または［APIデプロイメント］を選択し、［表示名］フィールドに適切な名前を入力します。
4. サポートされているメトリクスが［しきい値設定］セクションに表示されます。上記のすべてのメトリクスにしきい値を設定できます。
5. ［保存］をクリックします。

ステータスベースのアラート

メトリクスベースのしきい値に加えて、API Gatewayとそのデプロイメントのステータスに基づいてアラートを設定できます。

• ［ゲートウェイが失敗ステータスの場合に通知］
  API Gatewayが失敗ステータスになったときにアラートを受信します。
• ［デプロイメントが失敗ステータスの場合に通知］
  APIデプロイメントが失敗ステータスになったときにアラートを受信します。
• ［ルートが失敗ステータスの場合に通知］
  APIルートが失敗ステータスになったときにアラートを受信します。

ライセンス

• 各API GatewayおよびAPIデプロイメント監視は、ベーシック監視ライセンスを1つ使用します。
• APIルート監視はフリー監視です。

監視グループを使用したOCI API Gatewayの整理

監視グループは、アプリケーション、環境、ビジネスユニット、またはプロジェクトに基づいてOCI API Gatewayリソースを整理するのに役立ち、大規模なAPI環境の管理を容易にします。

たとえば、同じアプリケーションに属するAPI Gatewayとその関連APIデプロイメントを単一の監視グループにまとめることができます。これにより、管理者は完全なAPIインフラストラクチャーの健全性を1か所から監視し、ゲートウェイ、デプロイメント、ルートにわたる問題の影響を迅速に理解できます。

監視グループはまた、通知、レポート、ダッシュボード、ビジネスビューをグループレベルで設定できるため、アラート管理を簡素化します。

キャパシティプランニング

キャパシティプランニングは、OCI API Gatewayリソース全体の過去のパフォーマンストレンドを分析して、ワークロードの増加を理解し、将来のインフラストラクチャー要件を計画するのに役立ちます。

API GatewayおよびAPIデプロイメント全体のリクエスト量、トラフィックパターン、レイテンシー、その他の利用可能なパフォーマンスメトリクスを監視することで、API需要の増加を特定し、ワークロードパターンを分析し、バックエンドのキャパシティをプロアクティブに計画できます。

過去のパフォーマンスデータは、インフラストラクチャーの変更を検証し、個々のデプロイメントやルート全体のパフォーマンストレンドを特定し、ワークロードが増加してもAPIサービスが期待されるパフォーマンスレベルを維持し続けることを保証するのに役立ちます。

API Gatewayデータの表示

サービスゲートウェイ環境を監視するには、アカウントにログインし、［クラウド］→［OCI］→［API Gateway］に移動します。

監視データ

各API Gateway監視の監視データは以下の通りです。