Edge for Private Cloud phiên bản 4.18.01
Tất cả khách hàng Edge for Private Cloud đều phải gửi cho Apigee số liệu thống kê về lưu lượng truy cập proxy API. Apigee khuyến nghị khách hàng tải thông tin đó lên mỗi ngày một lần, có thể chậm nhất vào tạo một tác vụ chạy ngầm theo thời gian định trước.
Bạn phải gửi dữ liệu để triển khai API chính thức, chứ không phải cho API đang trong quá trình phát triển hoặc triển khai thử nghiệm. Trong hầu hết các bản cài đặt Edge, bạn sẽ xác định các tổ chức hoặc tổ chức cụ thể môi trường cho API sản xuất của bạn. Dữ liệu mà bạn gửi chỉ dành cho các tổ chức và môi trường phát hành công khai đó.
Để hỗ trợ việc tải dữ liệu này lên, Apigee cung cấp bản phát hành Beta của tiện ích dòng lệnh apigee-analytics-collector. Tiện ích này sẽ gửi báo cáo số lượng cuộc gọi API lại cho Apigee. Mọi Edge cho quá trình cài đặt Private Cloud đều có thể sử dụng tiện ích này để truy xuất và báo cáo dữ liệu lưu lượng truy cập cho Apigee.
Truy cập dữ liệu do apigee-analytics-collector tải lên
Sau khi tải dữ liệu lên bằng tiện ích apigee-analytics-collector, bạn có thể xem trong Apigee 360.
Để xem dữ liệu, hãy đăng nhập vào Apigee 360 rồi chọn mục Mức sử dụng. Trang Mức sử dụng hiển thị biểu đồ mức sử dụng và bảng dữ liệu mức sử dụng cho từng tổ chức Edge.
Cài đặt apigee-analytics-collector
Tiện ích apigee-analytics-collector là một RPM mà bạn cài đặt bằng cách sử dụng tiện ích apigee-service.
Vị trí cài đặt
Nút mà bạn cài đặt tiện ích apigee-analytics-collector có thể là bất kỳ nút nào có thể truy cập vào API quản lý Edge trên Máy chủ quản lý Edge. Bạn có thể cài đặt ngay trên Máy chủ quản lý, trên một nút khác của bản cài đặt Edge hoặc trên nút đó miễn là nút đó có thể gửi yêu cầu API đến Máy chủ quản lý.
Yêu cầu về quyền truy cập Internet
Cài đặt tiện ích apigee-analytics-collector trên có kết nối Internet bên ngoài. Sau đó, tiện ích apigee-analytics-collector có thể tải dữ liệu lên trực tiếp Apigee.
Nếu không có nút nào có cả quyền truy cập vào API quản lý Edge trên Máy chủ quản lý Edge và quyền truy cập Internet bên ngoài, thì bạn có thể sử dụng API quản lý Edge để lưu dữ liệu lưu lượng truy cập trên máy. Sau đó, bạn phải chuyển dữ liệu sang máy tính có kết nối Internet để tải lên Apigee. Trong trường hợp này, bạn không cần sử dụng phần mềm tiện ích apigee-analytics-collector. Xem Tải dữ liệu lên theo cách thủ công lên Bạn có thể tìm hiểu thêm thông tin về Apigee bên dưới.
Cài đặt
Sử dụng lệnh sau để cài đặt tiện ích apigee-analytics-collector. Bởi vì bạn đang cài đặt tệp RPM, lệnh này phải được chạy bởi người dùng gốc hoặc người dùng đã quyền truy cập sudo đầy đủ. Để có quyền truy cập sudo đầy đủ, điều đó có nghĩa là người dùng có quyền truy cập sudo để thực hiện cùng làm gốc.
> /opt/apigee/apigee-service/bin/apigee-service apigee-analytics-collector install
Chạy apigee-analytics-collector
Phần này mô tả cách chạy tiện ích apigee-analytics-collector.
Định cấu hình người dùng để chạy apigee-analytics-collector
Bạn phải chạy apigee-analytics-collector dưới dạng người dùng không phải là người dùng gốc. Người dùng này phải có toàn quyền truy cập sudo vào người dùng "apigee".
Để định cấu hình người dùng có toàn quyền truy cập sudo vào "apigee" hãy sử dụng "visudo" CANNOT TRANSLATE chỉnh sửa tệp sudoers để thêm:
analyticsUser ALL=(apigee) NOPASSWD: ALL
trong đó analyticsUser là tên người dùng của người đang chạy phần mềm tiện ích apigee-analytics-collector.
Sau khi cài đặt tiện ích apigee-analytics-collector và định cấu hình người dùng, bạn có thể kiểm thử tiện ích này bằng cách chạy lệnh trợ giúp cho tiện ích apigee-analytics-collector:
> /opt/apigee/apigee-service/bin/ apigee-service apigee-analytics-collector export traffic --help
Thông tin bắt buộc để chạy apigee-analytics-collector
Bạn cần các thông tin sau để chạy lệnh apigee-analytics-collector và chuyển tiếp dữ liệu đến Apigee:
- apigee_mgmt_api_uri: URL cơ sở của API Edge trên máy chủ quản lý. URL này thường có dạng:
http://ms_IP:8080/v1
Trong đó ms_IP là địa chỉ IP hoặc Máy chủ quản lý của bạn và 8080 là cổng mà API Edge sử dụng. Nếu bạn đã tạo một mục DNS cho Edge API thì URL đó sẽ nằm trong biểu mẫu:
http://ms_DNS/v1
Nếu bạn bật TLS trên API quản lý Edge, thì TLS sẽ có dạng:
https://ms_IP:8080/v1
https://ms_DNS/v1 - apigee_mgmt_api_email: Địa chỉ email của một tài khoản có quyền truy cập vào API /stats của Edge. Thông thường, đây sẽ là email của quản trị viên hệ thống Edge hoặc email của quản trị viên tổ chức đối với các tổ chức phát hành công khai.
- apigee_mgmt_api_password: Mật khẩu Edge cho tài khoản do apigee_mgmt_api_email chỉ định.
- apigee_analytics_client_id và apigee_analytics_secret: Thông tin đăng nhập của bạn để tải dữ liệu lên Apigee. Vui lòng gửi phiếu yêu cầu hỗ trợ với Bộ phận hỗ trợ của Apigee để nhận apigee_analytics_client_id và apigee_analytics_secret.
Lệnh mẫu
Dưới đây là ví dụ về lệnh truy xuất dữ liệu lưu lượng truy cập của tất cả các tổ chức và trong ứng dụng Edge rồi tải dữ liệu đó lên Apigee. Hãy chú ý đến cách bạn sử dụng apigee-service để chạy lệnh 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
Xin lưu ý rằng lệnh này chứa tất cả thông tin bắt buộc, chẳng hạn như apigee_analytics_client_id và apigee_analytics_secret.
Bạn sẽ thấy kết quả ở dạng:
[
{
"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
}
]
}
]
Sử dụng các tuỳ chọn dòng lệnh cho lệnh để kiểm soát các hành động của lệnh đó. Hãy sử dụng các lựa chọn sau để chỉ định tổ chức và môi trường cần đưa vào dữ liệu được tạo:
- -i, --include_orgs <danh sách các mục được phân tách bằng dấu phẩy>
- -x, --excluded_org <danh sách các mục được phân tách bằng dấu phẩy>
- -n, --include_envs <danh sách các mục được phân tách bằng dấu phẩy>
- -e, --excluded_envs <danh sách các mục được phân tách bằng dấu phẩy>
Ví dụ: để chỉ xác định các tổ chức và môi trường sản xuất, hãy sử dụng Các tuỳ chọn -i (hoặc --include_orgs) và -n (hoặc --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
Trong ví dụ này, bạn chỉ thu thập dữ liệu từ môi trường sản phẩm của myOrg.
Để kết xuất dữ liệu vào màn hình nhằm kiểm tra dữ liệu đó trước khi gửi đến Apigee, hãy sử dụng tuỳ chọn -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
Tuỳ chọn -S bỏ qua dữ liệu tải lên Apigee. Sau đó, bạn có thể chạy lại lệnh mà không cần dùng tuỳ chọn -S để gửi dữ liệu đến Apigee.
Một lý do để sử dụng -S để bạn có thể hiển thị cục bộ các loại dữ liệu khác nhau. Apigee chỉ yêu cầu bạn tải dữ liệu lưu lượng truy cập API lên, nhưng tuỳ chọn -D cho phép bạn hiển thị dữ liệu về API sản phẩm, nhà phát triển, ứng dụng hoặc proxy API. Ví dụ bên dưới sử dụng các tuỳ chọn -D và -S để hiển thị dữ liệu của nhà phát triển locally:
> /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
Thêm tuỳ chọn -v để nhận đầu ra chi tiết và tuỳ chọn -R để xem các lệnh curl do apigee-analytics-collector tạo:
> /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
Phần tiếp theo chứa danh sách đầy đủ các tuỳ chọn dòng lệnh.
Tham số lệnh
Bảng sau đây liệt kê toàn bộ các lựa chọn cho phần mềm tiện ích apigee-analytics-collector:
|
Lệnh |
Mục đích sử dụng |
|---|---|
|
-h, --trợ giúp |
Thông tin về mức sử dụng đầu ra |
|
-D, --phương diện <dimension> |
Phương diện lưu lượng truy cập cần thu thập. Phương diện hợp lệ: apiproducts, devs, apps, apiproxy (mặc định) |
|
-d, --days <days> |
Số ngày trong quá khứ, bắt đầu từ ngày hiện tại, của dữ liệu cần thu thập. Chiến lược phát hành đĩa đơn mặc định là 3. Nếu bạn chỉ định -d, hãy không chỉ định -s và -z để đặt thời gian dải ô. |
|
-m, --apigee_mgmt_api_uri <apigee_mgmt_api_uri> |
URL đến API quản lý Edge. |
|
-u, --apigee_mgmt_api_email <apigee_mgmt_api_email> |
Địa chỉ email của tài khoản có quyền truy cập vào API /stats của Edge. Thông thường, đây sẽ là email của quản trị viên hệ thống Edge hoặc email của quản trị viên tổ chức đối với các tổ chức phát hành công khai. |
|
-p, --apigee_mgmt_api_password <apigee_mgmt_api_password> |
Mật khẩu được liên kết với tài khoản email API quản lý Edge do -u chỉ định. |
|
-i, --include_orgs <items> |
Danh sách tổ chức được phân tách bằng dấu phẩy để thêm vào kết quả. |
|
-x, --exclude_orgs <items> |
Danh sách các tổ chức được phân tách bằng dấu phẩy mà bạn muốn loại trừ khỏi kết quả. |
|
-n, --include_envs <items> |
Danh sách môi trường được phân tách bằng dấu phẩy để đưa vào dữ liệu đầu ra. |
|
-e, --exclude_envs <items> |
Danh sách môi trường được phân tách bằng dấu phẩy để đưa vào từ đầu ra. |
|
-o, --đầu ra <path> |
Đường dẫn và tên tệp để lưu đầu ra. |
|
-s, --time_range_start <time_range_start> |
Phạm vi thời gian bắt đầu để truy vấn số liệu thống kê về lưu lượng truy cập, ở dạng: "03/01/2016 00:00". Nếu bạn chỉ định -d, đừng chỉ định cả -s và -z để đặt phạm vi thời gian. |
|
-z, --time_range_end <time_range_end> |
Phạm vi thời gian kết thúc truy vấn số liệu thống kê lưu lượng truy cập, có dạng: "01/04/2016 24:00". Nếu bạn chỉ định -d, đừng chỉ định cả -s và -z để đặt khoảng thời gian. |
|
-t, --time_unit <time_unit> |
Đơn vị thời gian cho dữ liệu lưu lượng truy cập. Tuần mặc định. Đơn vị mặc định theo giờ. Đơn vị thời gian hợp lệ: giây, phút, giờ, ngày, tuần. |
|
-S, --đầu_ra_chuẩn |
Ghi đầu ra vào thiết bị đầu cuối (stdout) thay vì tải lên Apigee. |
|
-c, --apigee_analytics_client_id <apigee_analytics_client_id> |
Mã nhận dạng để tải dữ liệu lên Apigee. Vui lòng gửi phiếu yêu cầu hỗ trợ cho Nhóm hỗ trợ Apigee để nhận tài liệu này. |
|
–r, --apigee_analytics_secret <apigee_analytics_secret> |
Khoá bí mật để tải dữ liệu lên Apigee. Vui lòng gửi phiếu yêu cầu hỗ trợ với Bộ phận hỗ trợ Apigee đến nhận được. |
|
-R, --include_curl_commands |
Thêm các lệnh cURL đã tạo vào đầu ra để gỡ lỗi. |
|
-v, --chi tiết |
Hiển thị kết quả chi tiết. |
Tải dữ liệu lên Apigee theo cách thủ công
Apigee khuyên bạn nên cài đặt tiện ích apigee-analytics-collector trên có kết nối Internet bên ngoài. Sau đó, tiện ích apigee-analytics-collector có thể tải lên trực tiếp cho Apigee.
Tuy nhiên, nếu máy không có quyền truy cập Internet bên ngoài, hãy sử dụng API quản lý Edge để thu thập dữ liệu lưu lượng truy cập, rồi sử dụng các lệnh cURL để tải dữ liệu đó lên Apigee từ một máy có Internet. Bạn phải lặp lại quy trình này cho mọi tổ chức và môi trường sản xuất trong quá trình cài đặt Edge.
Dùng lệnh cURL sau đây để thu thập dữ liệu về lưu lượng truy cập cho một tổ chức cụ thể và trong một khoảng thời gian xác định:
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"
Lệnh này sử dụng API Edge Get API message count. Trong lệnh này:
- apigee_mgmt_api_email:apigee_mgmt_api_password chỉ định địa chỉ email của một tài khoản có quyền truy cập vào API Edge /stats.
- <ms_IP> là địa chỉ IP hoặc tên DNS của Máy chủ quản lý Edge.
- {org_name} và {env_name} chỉ định tổ chức và môi trường.
- apiproxy là phương diện nhóm các chỉ số theo proxy API.
- MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM&timeUnit=hour chỉ định
khoảng thời gian được chia thành các đơn vị thời gian của các chỉ số cần thu thập. Lưu ý rằng lệnh cURL
sử dụng mã hex
%20cho các không gian trong phạm vi thời gian.
Ví dụ: để thu thập thông báo proxy API đếm số lượng từng giờ trong khoảng thời gian 24 giờ, hãy sử dụng phương thức đang theo dõi lệnh gọi API quản lý. timeRange chứa các ký tự được mã hoá thành 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"
Bạn sẽ thấy một phản hồi ở dạng:
{
"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" ]
}
}
Sau đó, để tải dữ liệu đó lên Apigee từ một máy có kết nối Internet, hãy sử dụng cURL sau :
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"...}'
trong đó:
- apigee_analytics_client_id:apigee_analytics_secret chỉ định thông tin xác thực của bạn để tải dữ liệu lên Apigee mà bạn nhận được từ Nhóm hỗ trợ Apigee.
- {org_name} chỉ định tổ chức.
- {"environments"...} chứa kết quả của lệnh cURL mà bạn đã sử dụng để thu thập số liệu thống kê ở trên.