Edge for Private Cloud 4.18.01 版
所有 Edge for Private Cloud 客戶都必須向 Apigee 提交 API Proxy 流量統計資料。Apigee 建議客戶每天上傳一次這類資訊，例如建立 Cron 工作。
您必須提交正式版 API 部署作業的資料，但不必提交開發或測試部署作業的 API 資料。在大多數 Edge 安裝作業中，您會為正式版 API 定義特定組織或環境。您提交的資料僅適用於這些正式環境和機構。
為協助上傳這類資料，Apigee 提供 Beta 版 apigee-analytics-collector 指令列公用程式。這項公用程式會將 API 呼叫量報表傳回 Apigee。每個 Edge for 私有雲 安裝作業都能使用這項公用程式，擷取流量資料並回報給 Apigee。
存取 apigee-analytics-collector 上傳的資料
使用 apigee-analytics-collector 公用程式上傳資料後，您可以在 Apigee 360 中查看資料。
如要查看資料，請登入 Apigee 360，然後選取「Usage」(用量) 選項。「Usage」(用量) 頁面會顯示用量圖表，以及各個 Edge 組織的用量資料表。
安裝 apigee-analytics-collector
apigee-analytics-collector 公用程式是 RPM，可使用 apigee-service 公用程式安裝。
安裝位置
安裝 apigee-analytics-collector 公用程式的節點，可以是任何能存取 Edge 管理伺服器上 Edge Management API 的節點。您可以直接在管理伺服器、Edge 安裝作業的其他節點，或獨立節點上安裝，只要該節點能向管理伺服器發出 API 要求即可。
網路連線能力需求
在具備外部網路連線能力的機器上，安裝 apigee-analytics-collector 公用程式。接著，apigee-analytics-collector 公用程式就能直接將資料上傳至 Apigee。
如果沒有任何節點可存取 Edge 管理伺服器上的 Edge Management API，且可存取外部網際網路，則可使用 Edge Management API 將流量資料儲存在本機。接著，您必須將資料轉移至具備網路連線能力的機器，才能上傳至 Apigee。在這種情況下，您不需要使用 apigee-analytics-collector 公用程式。詳情請參閱下方的「手動將資料上傳至 Apigee」。
安裝
使用下列指令安裝 apigee-analytics-collector 公用程式。由於您要安裝 RPM 檔案，因此必須由超級使用者或具有完整 sudo 存取權的使用者執行這項指令。如果使用者具備完整的 sudo 存取權，就能執行與 root 相同的作業。
> /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，則網址格式如下：
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 支援團隊提交支援單，取得 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 的 prod 環境收集資料。
如要將資料傾印到螢幕上，以便在傳送至 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、devs、apps、apiproxy (預設) |
|
-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> |
與 -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 |
將輸出內容寫入終端機 (stdout)，而非上傳至 Apigee。 |
|
-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 建議您在具備外部網路連線能力的機器上安裝 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 管理伺服器的 IP 位址或 DNS 名稱。
- {org_name} 和 {env_name} 指定機構和環境。
- apiproxy 是依 API Proxy 將指標分組的維度。
- MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM&timeUnit=hour 指定要收集的指標日期範圍，並以時間單位劃分。請注意，cURL 指令會使用十六進位代碼
%20代表日期範圍中的空格。
舉例來說，如要收集 24 小時內每小時的 API Proxy 訊息數量，請使用下列 Management API 呼叫。timeRange 包含網址編碼字元。
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"
您應該會看到以下格式的回應：
{
"environments" : [ {
"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"
} ],
"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 指令結果。