Xem nhật ký bằng API

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về Apigee X.
thông tin

Tải nhật ký Giám sát API xuống để xem dữ liệu thô dùng để tính toán các chỉ số xuất hiện trong trang tổng quan Giám sát API. Bạn có thể tải nhật ký xuống cho các phạm vi thời gian tuỳ chỉnh, proxy cụ thể, mã trạng thái cụ thể và nhiều biến khác.

Lưu ý: Theo mặc định, các lệnh gọi đến API nhật ký chỉ trả về kết quả có mã trạng thái 4xx và 5xx, chứ không phải mã 2xx. Việc này được thực hiện để giới hạn số lượng kết quả, vì hầu hết kết quả đều có mã trạng thái 2xx. Để nhận kết quả có mã trạng thái 2xx, hãy thêm status=2xx vào yêu cầu. Ví dụ: https://apimonitoring.enterprise.apigee.com/logs?status=2xx.

Các phần sau đây mô tả cách quản lý nhật ký bằng API:

Hãy xem phần API nhật ký để biết thêm thông tin về API nhật ký.

Để biết thông tin về các tuỳ chọn cURL được sử dụng trong các ví dụ này, hãy xem phần Sử dụng cURL.

Tải nhật ký xuống cho một tổ chức và môi trường

Tải nhật ký xuống cho một tổ chức và môi trường cụ thể bằng cách sử dụng API nhật ký:

https://apimonitoring.enterprise.apigee.com/logs

Bạn phải truyền tên của tổ chức và môi trường bằng cách sử dụng các tham số truy vấn orgenv.

Theo mặc định, API sẽ trả về 10 mục nhập nhật ký gần đây nhất trong 1 giờ trước đó. Ví dụ:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Đặt $ACCESS_TOKEN thành mã truy cập OAuth 2.0, như mô tả trong phần Lấy mã truy cập OAuth 2.0.

Phản hồi là một mảng các mục nhập nhật ký ở dạng:

[   
  {
"request":"GET /v1/o/myorg/z HTTP/1.1",
    "request_length":1349,
    "request_message_id":"rrt-0623eb157b650315c-c-ne-7785-16029140-1",
    "virtual_host":"api.enterprise.apigee.com",
    "response_size":144,
    "response_time":0.551,
    "response_status":"404",
    "timestamp":"2018-08-14T17:31:07Z",
    "fault_code":"messaging.adaptors.http.flow.ErrorResponseCode",
    "fault_flow":"-",
    "fault_policy":"null/null",
    "fault_proxy":
        "/organizations/myorg/environments/prod/apiproxies/myAPI/revisions/50",
    "fault_source":"target"
  },
  …
]

Sử dụng các tham số truy vấn fromto để chỉ định một phạm vi thời gian được định dạng theo ISO. Định dạng ngày có thể là:

  • yyyy-mm-ddThh:mm:ssZ
  • yyyy-mm-ddThh:mm:ss+00:00

Ví dụ:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&from=2018-08-13T14%3A04%3A00Z&to=2018-08-13T14%3A10%3A00Z" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

API này có nhiều tham số truy vấn không bắt buộc. Ví dụ: để xem nhật ký cho một proxy có tên myAPI tạo ra phản hồi HTTP 404:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&proxy=myAPI&status=404" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Để trả về nhiều hơn 10 mục nhập nhật ký, hãy đặt tham số truy vấn limit. Bạn có thể đặt giá trị này thành giá trị tối đa là 1000:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs?org=myorg&env=prod&proxy=myAPI&status=404&limit=200" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"

Để biết thêm các tuỳ chọn, hãy xem API nhật ký.

Liệt kê các proxy được liên kết với máy chủ ảo và đường dẫn cơ sở

Máy chủ ảo trên Bộ định tuyến cạnh cho phép bạn chỉ định tên miền, giao thức như HTTP/HTTPS và số cổng. Ví dụ: bạn xác định một máy chủ ảo trên Bộ định tuyến cạnh bằng các chế độ cài đặt sau:

  • tên đại diện của máy chủ = apis.acme.com
  • port = 443
  • Đã bật TLS

Dựa trên các chế độ cài đặt này, yêu cầu đến một proxy API liên kết với máy chủ ảo này sẽ sử dụng biểu mẫu:

https://apis.acme.com/proxy-base-path/resource-path

Trong trường hợp:

  • proxy-base-path được xác định khi bạn tạo một proxy API và là duy nhất cho mỗi proxy API.
  • resource-path là đường dẫn đến một tài nguyên có thể truy cập được thông qua proxy API.

Để biết thêm về máy chủ lưu trữ ảo, hãy xem bài viết Giới thiệu về máy chủ lưu trữ ảo.

Tải danh sách proxy API liên kết với một máy chủ ảo và đường dẫn cơ sở cụ thể bằng cách đưa ra yêu cầu GET đến tài nguyên sau của API nhật ký:

https://apimonitoring.enterprise.apigee.com/logs/apiproxies

Bạn phải truyền tên của tổ chức và môi trường bằng cách sử dụng các tham số truy vấn orgenv cũng như URI liên kết với máy chủ ảo và đường dẫn cơ sở.

Ví dụ: lệnh gọi API sau đây trả về các proxy được liên kết với máy chủ ảo http://apis.acme.com và có đường dẫn cơ sở là /v1/perf:

curl -X GET \
"https://apimonitoring.enterprise.apigee.com/logs/apiproxies?org=myorg&env=prod&select=http://apis.acme.com/v1/perf" \
-H "accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN" 

Đặt $ACCESS_TOKEN thành mã truy cập OAuth 2.0, như mô tả trong phần Lấy mã truy cập OAuth 2.0.

Để biết thêm các tuỳ chọn, hãy xem API nhật ký.