本頁面由 Cloud Translation API 翻譯而成。

將 API 流量資料上傳至 Apigee - Beta 版

所有 Edge for Private Cloud 客戶都必須向 Apigee 提交 API 相關統計資料以及 Proxy 流量Apigee 建議客戶每天上傳該資訊一次，建立 Cron 工作。

您必須提交實際工作環境 API 部署的資料，但不適用於開發中的 API 或測試部署作業在大部分的 Edge 安裝項目中，您將定義特定機構實際工作環境 API 的網路伺服器你提交的資料僅適用於這些產品機構和環境

為協助您上傳這類資料，Apigee 提供 apigee-analytics-collector 指令列公用程式這個公用程式會將 API 呼叫量報表傳回 Apigee。各種邊緣私有雲安裝作業可以使用這個公用程式擷取流量資料，並回報給 Apigee。

注意：apigee-analytics-collector 公用程式需要外部網際網路連線，以便將資料上傳至 Apigee。如果你沒有外部網際網路連線，就可以使用 Edge API 收集統計資料、轉移這些資料連線至可連上網際網路的機器，再將資料上傳至 Apigee。請參閱手動將資料上傳至 Apigee 一文瞭解詳情。

必要操作：上傳資料前請先與 Apigee 支援團隊聯絡

您必須先聯絡 Apigee Edge 支援團隊完成新手上路程序，才能將資料上傳至 Apigee 上傳資料集之後，您可以運用 AutoML 自動完成部分資料準備工作

安裝 apigee-analytics-collector

apigee-analytics-collector 公用程式這個 RPM 是使用 apigee-service 公用程式所安裝。

安裝位置

安裝 apigee-analytics-collector 公用程式的節點可以是可以存取 Edge Management Server 上的 Edge Management API。您可以安裝管理伺服器、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 檔案，則該指令必須由超級使用者或擁有完整的 sudo 存取權限對於完整的 sudo 存取，使用者擁有 sudo 存取權以執行相同的並將作業當做根執行

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

執行 apigee-analytics-collector

本節說明如何執行 apigee-analytics-collector 公用程式。

設定使用者以執行 apigee-analytics-collector

您必須以非根層級執行 apigee-analytics-collector 內容。這位使用者必須具備「apigee」的完整 sudo 存取權內容。

設定使用者俱備「apigee」的完整 sudo 存取權請使用「visudo」指令編輯 sudoers 檔案，以新增：

analyticsUser        ALL=(apigee)      NOPASSWD: ALL

其中 analyticsUser 是跑步者的使用者名稱 apigee-analytics-collector 公用程式。

安裝 apigee-analytics-collector 公用程式後並設定使用者，您可以執行 apigee-analytics-collector 公用程式：

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

執行 apigee-analytics-collector 的必要資訊

您需要以下資訊來執行 apigee-analytics-collector 指令以及如何將資料轉送至 Apigee：

apigee_mgmt_api_uri：管理作業上的 Edge API 基準網址伺服器格式如下：
```
http://ms_IP:8080/v1
```
其中 ms_IP 是 IP 位址或您的管理伺服器，8080 是以及 Edge API 使用的通訊埠如果您為 Edge API 建立了 DNS 項目，則該網址位於表單：
```
http://ms_DNS/v1
```
如果您在 Edge Management API 上啟用 TLS，這個 API 的格式為：
```
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。
apigee_analytics_client_id 和 apigee_analytics_secret：用於將資料上傳至 Apigee 的憑證。請向 Apigee Edge 支援提交支援單，以便取得支援 apigee_analytics_client_id和apigee_analytics_secret。

範例指令

以下顯示的範例指令是擷取所有機構和安裝在 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_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 comma-separated list of items
-x, --exclude_orgs comma-separated list of items
-n, --include_envs comma-separated list of items
-e, --exclude_envs comma-separated list of items

舉例來說，如果只要指定實際工作環境中的機構和環境，請使用 -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 的理由之一可讓您在本機顯示不同類型的資料。Apigee 只需要上傳 API 流量資料，但 -D 選項可讓您顯示 API 相關資料產品、開發人員、應用程式或 API Proxy以下範例使用 -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 選項即可取得詳細輸出和 -R 選項查看 apigee-analytics-collector 產生的 curl 指令：

/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`	要收集的流量維度。有效值如下： `apiproducts` `apiproxy` (預設) `apps` `devs`
`-d, --days days`	要收集的資料天數 (從目前日期起算)。預設值為 3。如果指定 `-d`，請不要同時指定 `-s`，並且使用 `-z` 設定時間範圍。
`-m, --apigee_mgmt_api_uri apigee_mgmt_api_uri`	Edge Management API 的網址。
`-u, --apigee_mgmt_api_email apigee_mgmt_api_email`	可存取 Edge `/stats` API 的帳戶電子郵件地址。這通常是 Edge 系統管理員的電子郵件，或是貴機構管理員的電子郵件地址保護生產環境
`-p, --apigee_mgmt_api_password apigee_mgmt_api_password`	與 Edge Management API 電子郵件帳戶相關聯的密碼 `-u`。
`-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`	查詢流量統計資料的起始時間範圍，格式為：「`MM/DD/YYYY HH:MM`」。如果指定 `-d`，請勿同時指定 `-s` 和 `-z` 來設定時間範圍。
`-z, --time_range_end time_range_end`	查詢流量統計資料的時間範圍結束，格式為：「04/01/2016 24:00」。如果指定 `-d`，請勿同時指定 `-s` 和 `-z` 來設定時間範圍。
`-t, --time_unit time_unit`	路況資料的時間單位。預設值為 `hour`。有效時間單位是： `second` `minute` `hour` (預設) `day` `week` 如果您將 `-t` 設為 `week`，並將 `-d` 設為 `365`，然後 Apigee 會傳回大量資料，並以 52 個不同範圍分組 (每週一次)。
`-S, --standard_output`	將輸出內容寫入終端機 (stdout)，而不是上傳至 Apigee。
`-c, --apigee_analytics_client_id apigee_analytics_client_id`	將資料上傳至 Apigee 的 ID。請向 Apigee Edge 支援提交支援單，以便：。
`-r, --apigee_analytics_secret apigee_analytics_secret`	將資料上傳至 Apigee 的密鑰。請向 Apigee Edge 支援提交支援單，以便：。
`-R, --include_curl_commands`	在輸出內容中加入產生的 `curl` 指令來進行偵錯。
`-v, --verbose`	顯示詳細輸出。

手動將資料上傳至 Apigee

Apigee 建議您將 apigee-analytics-collector 公用程式安裝在可存取外部網際網路的機器接著使用 apigee-analytics-collector 公用程式就能將資料直接上傳至 Apigee

不過，如果電腦無法連上外部網際網路，請用 Edge Management API ，然後使用 curl 指令從搭載網路連線。您必須為每個實際工作環境機構重複執行這項程序安裝在 Edge 版本的環境中

注意：在這種情況下，請勿使用「apigee-analytics-collector」公用程式。

使用下列 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 是邊緣的 IP 位址或 DNS 名稱 Management Server。
org_name 和 env_name 會指定機構和環境
apiproxy 是依 API Proxy 將指標分組的尺寸。
MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM&timeUnit=hour 會指定時間範圍細分為要收集的指標時間範圍請注意， curl 指令會使用十六進位代碼 %20 代表空格範圍。

舉例來說，如要收集 24 小時內每小時的 API Proxy 訊息數量，請使用正在追蹤 API 呼叫。

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"

(請注意，timeRange 包含網址編碼字元)。

回應的格式如下：

{
  "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
org_name 會指定機構名稱。
"environments"... 包含 curl 指令的結果，您所使用的統計資料

將 API 流量資料上傳至 Apigee - Beta 版

必要操作：上傳資料前請先與 Apigee 支援團隊聯絡

安裝 apigee-analytics-collector

安裝位置

網際網路連線 相關規定

安裝

執行 apigee-analytics-collector

設定使用者以執行 apigee-analytics-collector

執行 apigee-analytics-collector 的必要資訊

範例指令

指令參數

手動將資料上傳至 Apigee

網際網路連線相關規定