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

Edge for Private Cloud v4.18.05

すべての 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 にデータをアップロードする前に、Apigee Edge サポートに連絡してオンボーディング プロセスを完了する必要があります。

apigee-analytics-collector のインストール

apigee-analytics-collector ユーティリティは、apigee-service ユーティリティを使用してインストールする RPM です。

インストール場所

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 ユーティリティをインストールします。RPM ファイルをインストールするため、このコマンドは root ユーザーまたは sudo へのフルアクセス権を持つユーザーが実行する必要があります。sudo の完全なアクセス権とは、root と同じ操作を実行できる sudo アクセス権がユーザーにあることを意味します。

> /opt/apigee/apigee-service/bin/apigee-service apigee-analytics-collector install 

apigee-analytics-collector の実行

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

apigee-analytics-collector を実行するようにユーザーを構成する

apigee-analytics-collector を root 以外のユーザーとして実行する必要があります。このユーザーには、「apigee」ユーザーに対する sudo フルアクセス権が必要です。

「apigee」ユーザーに対する sudo フルアクセス権限を付与するようにユーザーを構成するには、「visudo」コマンドを使用して sudoers ファイルを編集し、以下を追加します。

analyticsUser        ALL=(apigee)      NOPASSWD: ALL

analyticsUser は、apigee-analytics-collector ユーティリティを実行しているユーザーのユーザー名です。

apigee-analytics-collector ユーティリティをインストールしてユーザーを構成したら、apigee-analytics-collector ユーティリティの help コマンドを実行してユーティリティをテストできます。

> /opt/apigee/apigee-service/bin/ apigee-service apigee-analytics-collector export traffic --help

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 を有効にする場合、URL は次の形式になります。
    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_idapigee_analytics_secret: Apigee にデータをアップロードするための認証情報。apigee_analytics_client_idapigee_analytics_secret を取得するには、Apigee サポートにチケットを送信してください。

コマンドの例

以下は、Edge 環境内のすべての組織と環境のトラフィック データを取得し、そのデータを Apigee にアップロードするコマンドの例を示しています。apigee-service を使用して apigee-analytics-collector コマンドを実行する方法に注意してください。

>  /opt/apigee/apigee-service/bin/apigee-service 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_idapigee_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)オプションを使用します。

>  /opt/apigee/apigee-service/bin/apigee-service 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 の本番環境からのみデータを収集します。

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

>  /opt/apigee/apigee-service/bin/apigee-service 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 オプションを使用する理由の 1 つは、さまざまな種類のデータをローカルで表示できるためです。Apigee で必要なのは、API トラフィック データのアップロードのみですが、-D オプションを使用すると、API プロダクト、デベロッパー、アプリ、API プロキシに関するデータを表示できます。次の例では、-D オプションと -S オプションを使用して、デベロッパー データをローカルで表示しています。

>  /opt/apigee/apigee-service/bin/apigee-service 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 オプションを含めます。

 >  /opt/apigee/apigee-service/bin/apigee-service 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 ユーティリティのすべてのオプションを示します。

コマンド

次のコマンドを実行します。

-h、--help

使用情報を出力する

-D、--dimension <dimension>

収集するトラフィック ディメンション。有効なディメンション: apiproductsdevsappsapiproxy(デフォルト)

-d、--days <days>

収集するデータの、現在の日付からの過去の日数。デフォルト値は 3 です。

-d を指定する場合、時間範囲を設定するために -s-z は指定しないでください。

-m、--apigee_mgmt_api_uri <apigee_mgmt_api_uri>

Edge Management API への URL。

-u、--apigee_mgmt_api_email <apigee_mgmt_api_email>

Edge /stats API へのアクセス権を持つアカウントのメールアドレス。通常は、Edge システム管理者のメールアドレス、または本番環境組織の組織管理者のメールアドレスを使用します。

-p、--apigee_mgmt_api_password <apigee_mgmt_api_password>

-u で指定された Edge Management API メール アカウントに関連付けられているパスワード。

-i、--include_orgs <items>

出力に含める組織のカンマ区切りリスト。

-x、--exclude_orgs <items>

出力から除外する組織のカンマ区切りリスト。

-n、--include_envs <items>

出力に含める環境のカンマ区切りのリスト。

-e、--exclude_envs <items>

出力に含める環境のカンマ区切りのリスト。

-o、--output <path>

出力を保存するパスとファイル名。

-s、--time_range_start <time_range_start>

トラフィック統計情報のクエリを開始する期間。形式は「03/01/2016 00:00」です。

-d を指定する場合、時間範囲を設定するために -s と -z も指定しないでください。

-z、--time_range_end <time_range_end>

トラフィック統計情報をクエリする期間の終了日。形式は「04/01/2016 24:00」です。

-d を指定する場合、時間範囲を設定するために -s と -z も指定しないでください。

-t、--time_unit <time_unit>

トラフィック データの時間単位。デフォルトの単位は時間です。有効な時間単位は、秒、分、時、日、週です。

-S、--standard_output

出力を Apigee にアップロードするのではなく、ターミナル(stdout)に書き込みます。

-c、--apigee_analytics_client_id <apigee_analytics_client_id>

Apigee にデータをアップロードするための ID。Apigee サポートにチケットを送信して取得してください。

-r、--apigee_analytics_secret <apigee_analytics_secret>

Apigee にデータをアップロードするためのシークレット。Apigee サポートにチケットを送信して取得してください。

-R、--include_curl_commands

デバッグのために、生成された cURL コマンドを出力に含めます。

-v、--verbose

詳細な出力を表示します。

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/apiproxy?select=sum(message_count)&timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM&timeUnit=hour"

このコマンドは、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} は組織と環境を指定します。
  • apiproxy は、API プロキシ別に指標をグループ化するディメンションです。
  • MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM&timeUnit=hour には、収集する指標の時間単位に分割された時間範囲を指定します。cURL コマンドは、時間範囲内のスペースに 16 進数コード %20 を使用します。

たとえば、24 時間の 1 時間ごとの API プロキシ メッセージ数を収集するには、次の Management API 呼び出しを使用します。timeRange には、URL エンコードされた文字が含まれます。

curl -X GET -u apigee_mgmt_api_email:apigee_mgmt_api_password \
"http://192.168.56.103:8080/v1/organizations/myOrg/environments/prod/stats/apiproxy?select=sum(message_count)&timeRange=01%2F01%2F2018%2000%3A00~01%2F02%2F2018%2000%3A00&timeUnit=hour"

次のようなレスポンスが表示されます。

{
  "environments" : [ {
    "dimensions" : [ {
      "metrics" : [ {
        "name" : "sum(message_count)",
        "values": [
                {
                  "timestamp": 1514847600000,
                  "value": "35.0"
                },
                {
                  "timestamp": 1514844000000,
                  "value": "19.0"
                },
                {
                  "timestamp": 1514840400000,
                  "value": "58.0"
                },
                {
                  "timestamp": 1514836800000,
                  "value": "28.0"
                },
                {
                  "timestamp": 1514833200000,
                  "value": "29.0"
                },
                {
                  "timestamp": 1514829600000,
                  "value": "33.0"
                },
                {
                  "timestamp": 1514826000000,
                  "value": "26.0"
                },
                {
                  "timestamp": 1514822400000,
                  "value": "57.0"
                },
                {
                  "timestamp": 1514818800000,
                  "value": "41.0"
                },
                {
                  "timestamp": 1514815200000,
                  "value": "27.0"
                },
                {
                  "timestamp": 1514811600000,
                  "value": "47.0"
                },
                {
                  "timestamp": 1514808000000,
                  "value": "66.0"
                },
                {
                  "timestamp": 1514804400000,
                  "value": "50.0"
                },
                {
                  "timestamp": 1514800800000,
                  "value": "41.0"
                },
                {
                  "timestamp": 1514797200000,
                  "value": "49.0"
                },
                {
                  "timestamp": 1514793600000,
                  "value": "35.0"
                },
                {
                  "timestamp": 1514790000000,
                  "value": "89.0"
                },
                {
                  "timestamp": 1514786400000,
                  "value": "42.0"
                },
                {
                  "timestamp": 1514782800000,
                  "value": "47.0"
                },
                {
                  "timestamp": 1514779200000,
                  "value": "21.0"
                },
                {
                  "timestamp": 1514775600000,
                  "value": "27.0"
                },
                {
                  "timestamp": 1514772000000,
                  "value": "20.0"
                },
                {
                  "timestamp": 1514768400000,
                  "value": "12.0"
                },
                {
                  "timestamp": 1514764800000,
                  "value": "7.0"
                }
              ]
            }
          ],
          "name" : "proxy1"
      } ],
    "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 コマンドの結果が含まれます。