Tải dữ liệu lưu lượng truy cập API lên Apigee – Bản phát hành beta

Edge for Private Cloud v. 4.17.09

Tất cả khách hàng Edge for Private Cloud đều phải gửi số liệu thống kê về lưu lượng truy cập proxy API cho Apigee. Apigee khuyến nghị khách hàng tải thông tin đó lên một lần mỗi ngày, có thể bằng cách tạo một công việc định kỳ.

Bạn phải gửi dữ liệu cho các bản triển khai API chính thức, nhưng không phải cho các API đang trong quá trình phát triển hoặc bản triển khai thử nghiệm. Trong hầu hết các lượt cài đặt Edge, bạn sẽ xác định các tổ chức hoặc môi trường cụ thể cho API phát hành công khai. 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ợ 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 về số lượng lệnh gọi API trở lại 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 dữ liệu đó trong Apigee 360.

Để xem dữ liệu, hãy đăng nhập vào Apigee 360 rồi chọn tuỳ chọn Usage (Mức sử dụng). Trang Sử dụng hiển thị một biểu đồ sử dụng và bảng dữ liệu sử dụng của từng hoặc các tổ chức Edge của bạn.

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.

Nơi 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 trực tiếp trên Máy chủ quản lý, trên một nút khác của quá trình cài đặt Edge hoặc trên một nút riêng biệt, miễn là nút đó có thể tạo 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 một máy có quyền truy cập 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ột máy 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 tiện ích apigee-analytics-collector. Hãy xem phần Tải dữ liệu lên Apigee theo cách thủ công bên dưới để biết thêm thông tin.

Cài đặt

Sử dụng lệnh sau để cài đặt tiện ích apigee-analytics-collector. Vì bạn đang cài đặt tệp RPM, nên lệnh này phải do người dùng gốc hoặc người dùng có toàn quyền truy cập sudo chạy. Đối với quyền truy cập sudo đầy đủ, tức là người dùng có quyền truy cập sudo để thực hiện các thao tác tương tự như quyền truy cập 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ó quyền truy cập sudo đầy đủ vào người dùng "apigee", hãy sử dụng lệnh "visudo" để chỉnh sửa tệp sudoers nhằm thêm:

analyticsUser        ALL=(apigee)      NOPASSWD: ALL

trong đó analyticsUser là tên người dùng của người 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á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 nhập DNS cho API Edge, thì URL sẽ có dạng:
    http://ms_DNS/v1

    Nếu bạn bật TLS trên API quản lý Edge, thì URL 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 xác thực 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ợ cho Nhóm hỗ trợ Apigee để lấy apigee_analytics_client_id và apigee_analytics_secret.

Lệnh mẫu

Dưới đây là lệnh mẫu để truy xuất dữ liệu lưu lượng truy cập cho tất cả các tổ chức và môi trường trong quá trình cài đặt Edge, đồng thời tải dữ liệu đó lên Apigee. Hãy lưu ý 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 đó. Sử dụng các tuỳ chọn sau để chỉ định tổ chức và môi trường cần đưa vào dữ liệu đã tạo:

  • -i, --include_orgs <danh sách mục được phân tách bằng dấu phẩy>
  • -x, --excluded_orgs <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, --exclude_envs <danh sách các mục được phân tách bằng dấu phẩy>

Ví dụ: để chỉ chỉ đị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 xuất 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 việc tải dữ liệu lên Apigee. Sau đó, bạn có thể chạy lại lệnh mà không cần tuỳ chọn -S để gửi dữ liệu đến Apigee.

Một lý do để sử dụng tuỳ chọn -S là để bạn có thể hiển thị nhiều loại dữ liệu trên máy. 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ề 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 nhà phát triển trên máy:

>  /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

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, --ngày <days>

Số ngày trước đây, bắt đầu từ ngày hiện tại, mà bạn muốn thu thập dữ liệu. Giá trị mặc định là 3.

Nếu bạn chỉ định -d, đừng chỉ định cả -s và -z để đặt phạm vi thời gian.

-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 một tài khoản có quyền truy cập vào các API /stats của Edge. Thông thường, đó 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 cho các tổ chức sản xuất của bạn.

-p, --apigee_mgmt_api_password <apigee_mgmt_api_password>

Mật khẩu 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 các tổ chức được phân tách bằng dấu phẩy để đưa 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 kết quả.

-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, có dạng: "01/03/2016 00:00".

Nếu bạn chỉ định -d, đừng chỉ định cả -s và -z để đặt khoảng thời gian.

-z, --time_range_end <time_range_end>

Thời điểm kết thúc phạm vi thời gian để truy vấn số liệu thống kê về lưu lượng truy cập, ở dạng: "04/01/2016 24:00".

Nếu bạn chỉ định -d, đừng chỉ định cả -s và -z để đặt phạm vi 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ờ. Các đơn vị thời gian hợp lệ: giây, phút, giờ, ngày, tuần.

-S, --standard_output

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 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ợ cho Nhóm hỗ trợ Apigee để nhận được.

–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ợ cho Nhóm hỗ trợ Apigee để nhận tài liệu này.

-R, --include_curl_commands

Thêm các lệnh cURL đã tạo vào đầu ra để gỡ lỗi.

-v, --verbose

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 một máy có quyền truy cập Internet bên ngoài. Sau đó, tiện ích apigee-analytics-collector có thể tải dữ liệu trực tiếp lên 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, sau đó sử dụng các lệnh cURL để tải dữ liệu đó lên Apigee từ một máy có quyền truy cập 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.

Sử dụng lệnh cURL sau để thu thập dữ liệu lưu lượng truy cập cho một tổ chức và môi trường cụ thể trong một khoảng thời gian đã chỉ đị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/?select=sum(message_count)&timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM"

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 các 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.
  • MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM chỉ định phạm vi thời gian của số liệu thống kê cần thu thập. Lưu ý rằng lệnh cURL sử dụng mã thập lục phân %20 cho các dấu cách trong phạm vi thời gian.

Ví dụ: để thu thập số liệu thống kê trong khoảng thời gian 24 giờ, hãy sử dụng lệnh sau:

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"

Bạn sẽ thấy một phản hồi ở dạng:

{
  "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" ]
  }
}

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 lệnh 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.