API Connectアナリティクスの主要コンセプト

API Connectアナリティクスの仕組みの概要。

ゲートウェイ・サービスと分析サービスの連携

ユーザーが公開された API のいずれかを呼び出すと、その API 呼び出しを処理するゲートウェイは、API 呼び出しの詳細 (アプリケーション ID、現在時刻、結果コードなど) を含む API イベント・レコードを作成します。 API イベント・レコードに保管されているすべてのデータの完全なリストについては、「 API イベント・レコードのフィールド・リファレンス」を参照してください。 ゲートウェイは、イベント数または経過時間のいずれかのしきい値に達するまで、API 呼び出しごとに API イベント・レコードをバッファーに入れます。 このしきい値に達すると、API イベントが分析サブシステムに一括で送信されます。 APIイベントはゲートウェイから管理サブシステムにTCPで送信され、ネットワーク障害が発生した場合、ゲートウェイはリトライを行う。 しかしながら、ゲートウェイは未送信のAPIイベントレコードを保持せず、無期限に再試行するので、すべてのAPIイベントレコードの配信は保証されない。

API 用に保管されている分析データのカスタマイズ

注: 開発者ポータル に表示される API コンシューマー分析は、可視性の構成設定によって異なります。 詳細については、 開発者ポータルでのアナリティクスの設定を参照してください。
API Manager UI で API を構成するときに、 activity log プロパティーを使用して、その API の呼び出しについて API イベント・レコードに保管するデータを選択します。 activity log プロパティーには、成功した API 呼び出しと失敗した API 呼び出しのそれぞれの設定があります。 活動記録ログのオプションは次の通りです。
  • none - APIイベントはログに記録されない。
  • activity - APIリソースURIをログに記録します。 activity は、成功した API 呼び出しのデフォルトのログ設定です。
  • header - API リソースの URI と HTTP ヘッダーを記録します。
  • payload - API リソースの URI、 HTTP ヘッダー、リクエストとレスポンスのペイロードを記録します。 payload は、失敗した API 呼び出しのデフォルトのログ設定です。これは、失敗の原因に関する有用な情報が応答ペイロードに含まれている可能性があるためです。

API イベント・データに対して特定のカスタマイズを行う場合は、カスタマイズする各 API の定義で、ゲートウェイ・スクリプトまたは set-variable 操作を使用できます。 ゲートウェイ・スクリプトまたは変数設定操作を使用したデータのカスタマイズを参照してください。

分析データへのアクセス

API Manager および Developer Portal UI で分析データを表示できます。
  • API Manager UI では、プロバイダー組織の所有者は、カタログに公開されている API の分析データを表示できます。
  • 開発者ポータル UI で、API コンシューマーは、コンシューマー組織で公開された API の分析データを表示できます。
これらの UI からアクセスできる API イベントの最大数は 10,000 です。 UI の 1 ページあたりに表示できるイベント・レコードの最大数は 200 です。

分析データには、 ツールキット CLI または REST APIを使用してアクセスすることもできます。

ユーザーの役割と権限を使用して、分析データへのユーザー・アクセスを管理できます。 ユーザー・ベースの分析データの可視性について詳しくは、 カタログ、スペース、および分析 を参照してください。

UI から分析データをエクスポートできますが、200 を超える API イベント・レコードをエクスポートする場合、UI エクスポートは実用的な方法ではありません。 一度に200件以上のAPIイベント・レコードをエクスポートするには、ツールキットCLIまたはREST APIを使用します。 すべての分析データを定期的にエクスポートする必要があると思われる場合は、 サード・パーティー・システムへの分析データのオフロードを検討してください。

サード・パーティー・システムへの分析データのオフロード

ゲートウェイから受信した API イベント・データは、分析サブシステムによって保管されるのではなく、サード・パーティー・システムに送信することができます。

分析データを AWS S3 または Splunk サーバーにオフロードできます。 オフロードの詳細については、分析データのオフロードを参照してください。