概要

ColdFusion API Manager は、API が生成する情報を収集および分析します。この情報は、API のパフォーマンスを測定するのに便利です。API Manager によって提供された情報は、次に関する判断に使用できます。

  • 任意の API での変更。
  • 最長時間または最短時間 API を使用しているアプリケーション。
  • 使用量が最大の HTTP メソッド(GET、PUT、POST など)。
  • API の容量計画。

指標

API が API Manager にランタイムリクエストを行うと、分析サーバーはリクエストから次のような情報を引き出します。

  • タイムスタンプ
  • API 名
  • バージョン
  • パブリッシャー
  • 利用者
  • アプリケーション
  • SLA
  • エラー
  • リクエストメソッド
  • ステータスコード
  • リクエストのコンテンツサイズ
  • 応答のコンテンツサイズ
  • リクエスト時間
  • サブリソースのパターン
  • リクエストのコンテンツタイプ
  • 応答のコンテンツタイプ
  • クラスターノード名
  • リクエスト IP

分析を表示するために、パブリッシャー、利用者または管理者は、ダッシュボードへのアクセス権を持ちます。パブリッシャーおよび管理者には、ビジュアライゼーションやダッシュボードなどを編集および追加できる独自の個人用ダッシュボードがあります。ただし、利用者用ダッシュボードは、パーソナライズできません。

このダッシュボードは、指標分析およびログ情報をチャートおよび円グラフの形式で公開する Web インターフェイスです。

指標設定の変更

管理者の場合、指標を生成する API リクエストの数を設定できます。管理者ポータルで、サーバー/API 分析サーバー設定を選択して、指標設定ページを表示します。

API 分析サーバー設定

Cluster Name(クラスター名) - API がリクエストするクラスターの名前を入力します。これらのリクエストの分析は、ポータルに公開されます。詳しくは、「クラスターサポートのセットアップ」を参照してください。

Sniff(スニッフ) - 分析サーバー設定で、クライアントは、クラスターが使用できるノードを追加する、残りのクラスターをスニッフできます。この機能を有効にするには、「Sniff(スニッフ)」を選択します。

Flush Interval(フラッシュの間隔) - ElasticSearch サーバーが指定された数の API リクエストを受け取ってからの時間の間隔を秒単位で入力します。

Maximum Actions Per Bulk Request(バルクリクエストごとの最大アクション数) - 指標計算およびビジュアライゼーションのために ElasticSearch サーバーにまとめて送信される API リクエストの数を入力します。このフィールドに "1000" と入力した場合、サーバーに送信できるリクエスト数は 1,000 以下です。

Maximum Concurrent Bulk Request(最大同時バルクリクエスト) - ElasticSearch サーバーに送信される API リクエストの同時ブロックの数を入力します。例えば、このフィールドに "2" と入力した場合、サーバーに送信できる API リクエストの同時ブロック数は 2 以下です。

Maximum Volume Per Bulk Request(バルクリクエストごとの最大ボリューム) - 同時リクエストのサイズを入力します。サイズは、MB 単位で計算されます。例えば、このフィールドに "5" と入力した場合、同時 API リクエストのサイズは 5 MB を超えることはありません。

API Manager のログ分析

ユーザー(パブリッシャーまたは管理者またはサブスクライバー)は、API Manager がログに記録した情報を表示できます。

API Manager は、マルチテナントシステムなので、複数のパブリッシャーがプラットフォームを同時に使用できます。そのため、パブリッシャーがログ情報を取得すると、API Manager はパブリッシャー専用のそれらのログを取得します。あるパブリッシャーは別のパブリッシャーのログへのアクセス権を持たないので、より安全です。

ダッシュボードでは、パブリッシャーは、次のような特定のフィルターを使用して、ログを表示および分析できます。

  • 最近 15 分/30 分/先日/先月/任意の時間のログ
  • エラーログ
  • 特定の利用者からのログ
  • 特定のサービスまたはバージョンのログ
  • 1 つ以上のフィルターの組み合わせ

本作品は Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License によってライセンス許可を受けています。  Twitter™ および Facebook の投稿には、Creative Commons の規約内容は適用されません。

法律上の注意   |   プライバシーポリシー