Apigee への API トラフィック データのアップロード - ベータ版リリース

Edge for Private Cloud v. 4.16.09

すべての Edge for Private Cloud のお客様は、API プロキシのトラフィックに関する統計情報を Apigee に提供していただく必要があります。cron ジョブを作成することによって、1 日 1 回統計情報をアップロードすることを推奨しています。

本番環境にデプロイされた API のデータを提供していただく必要がありますが、開発環境やテスト環境にデプロイされた API のデータを提供していただく必要はありません。Edge 実装環境では、多くの場合、本番環境用 API に特定の組織または特定の環境を定義します。ご提供いただいたデータは、本番環境用の組織と環境にのみ使用されます。

このデータのアップロードを支援するため、Apigee は apigee-analytics-collector コマンドライン ユーティリティのベータ版を提供しています。このユーティリティは、API 呼び出しボリューム レポートを Apigee に返します。Edge for Private Cloud のすべてのインストールで、このユーティリティを使用してトラフィック データを取得し、Apigee に報告できます。

Apigee へのトラフィック データのアップロード プロセスの詳細については、よくある質問をご覧ください。

apigee-analytics-collector をインストールする

apigee-analytics-collector ユーティリティは、npm を使用してインストールする Node.js モジュールです。

設置要件

apigee-analytics-collector ユーティリティには、次のものが必要です。

• npm 2.x 以降
• Node.js 4.x。

設置場所

apigee-analytics-collector ユーティリティをインストールするノードは、Edge Management Server の Edge Management API にアクセスできる任意のノードにできます。Management Server に直接インストールすることも、Edge インストールの別のノードにインストールすることも、Management Server に API リクエストを送信できる別のノードにインストールすることもできます。

インターネット アクセスの要件

外部インターネットにアクセスできるマシンに apigee-analytics-collector ユーティリティをインストールします。その後、apigee-analytics-collector ユーティリティはデータを Apigee に直接アップロードできます。

Edge Management Server の Edge Management API にアクセスでき、外部インターネットにアクセスできるノードがない場合は、Edge Management API を使用してトラフィック データをローカルに保存できます。その後、Apigee にアップロードするために、インターネット アクセスできるマシンにデータを転送する必要があります。このシナリオでは、apigee-analytics-collector ユーティリティを使用する必要はありません。詳細については、後述の Apigee へのデータの手動アップロードをご覧ください。

設置

次のコマンドを使用して、apigee-analytics-collector ユーティリティをインストールします。

> npm install apigee-analytics-collector -g

apigee-analytics-collector の実行

このセクションでは、apigee-analytics-collector ユーティリティを実行する方法について説明します。

apigee-analytics-collector の実行に必要な情報

apigee-analytics-collector コマンドを実行して Apigee にデータを転送するには、次の情報が必要です。

• apigee_mgmt_api_uri: Management Server 上の Edge API のベース URL。この URL は通常、次の形式になります。
  http://ms_IP:8080/v1
  
  ここで、ms_IP は Management Server の IP アドレス、8080 は Edge API で使用されるポートです。Edge API の DNS エントリを作成した場合、URL は次の形式になります:
  http://ms_DNS/v1
  
  Edge Management API で TLS を有効にした場合、次の形式になります:
  https://ms_IP:8080/v1
  https://ms_DNS/v1
• apigee_mgmt_api_email: Edge /stats API へのアクセス権を持つアカウントのメールアドレス。多くの場合、これは Edge システム管理者のメールアドレスか、本番環境組織の組織管理者のメールアドレスです。
• apigee_mgmt_api_password: apigee_mgmt_api_email で指定されたアカウントの Edge パスワード。
• apigee_analytics_client_id と apigee_analytics_secret: Apigee にデータをアップロードするための認証情報。apigee_analytics_client_id と apigee_analytics_secret を取得するには、Apigee サポートにチケットを送信してください。

コマンドの例

Edge インストール内のすべての組織と環境のトラフィック データを取得し、そのデータを Apigee にアップロードするコマンドの例を以下に示します。

> apigee-analytics-collector export traffic \
--apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \
--apigee_mgmt_api_email $ae_username \
--apigee_mgmt_api_password $ae_password \
--apigee_analytics_client_id $apigee_analytics_client_id \
--apigee_analytics_secret $apigee_analytics_secret

このコマンドには、apigee_analytics_client_id や apigee_analytics_secret など、必要な情報がすべて含まれています。

結果は次の形式で表示されます。

[
  {
    "org": "myOrg",
    "env": "prod",
    "time_range_start": "08/27/2016 00:00",
    "time_range_end": "08/30/2016 00:00",
    "response": [
      {
        "store_org_env_metrics_hourly_v4": 1
      }
    ]
  },
  {
    "org": "VALIDATE",
    "env": "test",
    "time_range_start": "08/27/2016 00:00",
    "time_range_end": "08/30/2016 00:00",
    "response": [
      {
        "store_org_env_metrics_hourly_v4": 1
      }
    ]
  }
]

コマンドのコマンドライン オプションを使用して、そのアクションを制御します。次のオプションを使用して、生成されたデータに含める組織と環境を指定します。

• -i, --include_orgs <カンマ区切りのリスト>
• -x, --exclude_orgs <カンマ区切りのリスト>
• -n, --include_envs <カンマ区切りのリスト>
• -e, --exclude_envs <カンマ区切りのリスト>

たとえば、本番環境の組織と環境のみを指定するには、-i（または --include_orgs）オプションと -n（または --include_envs）オプションを使用します。

> apigee-analytics-collector export traffic -i myOrg -n prod \
--apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \
--apigee_mgmt_api_email $ae_username \
--apigee_mgmt_api_password $ae_password \
--apigee_analytics_client_id $apigee_analytics_client_id \
--apigee_analytics_secret $apigee_analytics_secret

この例では、myOrg の prod 環境からのみデータを収集します。

Apigee に送信する前にデータを画面にダンプして確認するには、-S オプションを使用します。

> apigee-analytics-collector export traffic -i myOrg -n prod -S \
--apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \
--apigee_mgmt_api_email $ae_username \
--apigee_mgmt_api_password $ae_password \
--apigee_analytics_client_id $apigee_analytics_client_id \
--apigee_analytics_secret $apigee_analytics_secret 

-S オプションは、Apigee へのデータ アップロードを省略します。その後、-S オプションを指定せずにコマンドを再実行して、データを Apigee に送信できます。

-S オプションを使用する理由の一つは、さまざまな種類のデータをローカルに表示できることです。Apigee では、API トラフィック データのアップロードのみが必要ですが、-D オプションを使用すると、API プロダクト、デベロッパー、アプリ、API プロキシに関するデータを表示できます。次の例では、-D オプションと -S オプションを使用して、デベロッパー データをローカルに表示しています。

> apigee-analytics-collector export traffic -i myOrg -n prod -S -D devs \
--apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \
--apigee_mgmt_api_email $ae_username \
--apigee_mgmt_api_password $ae_password \
--apigee_analytics_client_id $apigee_analytics_client_id \
--apigee_analytics_secret $apigee_analytics_secret 

詳細な出力を取得するには -v オプションを、apigee-analytics-collector によって生成された curl コマンドを表示するには -R オプションを指定します。

 > apigee-analytics-collector export traffic -i myOrg -n prod -S -R -v \
--apigee_mgmt_api_uri http://192.168.56.103:8080/v1 \
--apigee_mgmt_api_email $ae_username \
--apigee_mgmt_api_password $ae_password \
--apigee_analytics_client_id $apigee_analytics_client_id \
--apigee_analytics_secret $apigee_analytics_secret 

次のセクションでは、コマンドライン オプションの全リストを示します。

コマンド パラメータ

次の表に、apigee-analytics-collector ユーティリティのオプションの一覧を示します。

Apigee へのデータの手動アップロード

Apigee では、外部インターネット アクセスが可能なマシンに apigee-analytics-collector ユーティリティをインストールすることをおすすめします。その後、apigee-analytics-collector ユーティリティはデータを Apigee に直接アップロードできます。

ただし、マシンに外部インターネット アクセスがない場合は、Edge Management API を使用してトラフィック データを収集し、cURL コマンドを使用して、インターネット アクセスのあるマシンから Apigee にアップロードします。Edge 実装環境内のすべての本番環境の組織と環境に対して、この手順を繰り返してください。

次の cURL コマンドを使用して、特定の組織と環境のトラフィック データを指定の時間間隔で収集します。

curl -X GET -u apigee_mgmt_api_email:apigee_mgmt_api_password \
"http://<ms_IP>:8080/v1/organizations/{org_name}/environments/{env_name}/stats/?select=sum(message_count)&timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM"

このコマンドは、Edge の Get API message count API を使用します。コマンドの内容:

• apigee_mgmt_api_email:apigee_mgmt_api_password には、Edge /stats API へのアクセス権を持つアカウントのメールアドレスを指定します。
• <ms_IP> は、Edge Management Server の IP アドレスまたは DNS 名です。
• {org_name} と {env_name} は、組織と環境を指定します。
• MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM は、収集する統計情報の期間を指定します。cURL コマンドでは、期間内のスペースに 16 進数コード %20 が使用されていることに注意してください。

たとえば、24 時間の統計情報を収集するには、次のコマンドを使用します。

curl -X GET -u apigee_mgmt_api_email:apigee_mgmt_api_password \
"http://192.168.56.103:8080/v1/organizations/myOrg/environments/prod/stats/?select=sum(message_count)&timeRange=08/29/2016%2000:00~08/30/2016%2000:00"

レスポンスは次の形式で表示されます。

{
  "environments" : [ {
    "metrics" : [ {
      "name" : "sum(message_count)",
      "values" : [ "42.0" ]
    } ],
    "name" : "prod"
  } ],
  "metaData" : {
    "errors" : [ ],
    "notices" : [ "query served by:53dab80c-e811-4ba6-a3e7-b96f53433baa", "source pg:6b7bab33-e732-405c-a5dd-4782647ce096", "Table used: myorg.prod.agg_api" ]
  }
}

インターネットにアクセスできるマシンから Apigee にデータをアップロードするには、次の cURL コマンドを使用します。

curl -X POST -H 'Content-Type:application/json' \
-u apigee_analytics_client_id:apigee_analytics_secret \
https://nucleus-api-prod.apigee.com/v1/apigee-analytics-cli-api/traffic/orgs/{org_name}/apis -d '{"environments"...}'

ここで

• apigee_analytics_client_id:apigee_analytics_secret: Apigee サポートから取得した、Apigee にデータをアップロードするための認証情報を指定します。
• {org_name} は組織を指定します。
• {"environments"...} には、上記の統計情報の収集に使用した cURL コマンドの結果が含まれています。