Tạo và quản lý báo cáo tùy chỉnh

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

Báo cáo tuỳ chỉnh cho phép bạn xem chi tiết các chỉ số API cụ thể và xem dữ liệu chính xác mà bạn muốn xem. Bạn có thể tạo báo cáo tuỳ chỉnh bằng cách sử dụng bất kỳ metrics và phương diện nào được tích hợp trong Edge. Ngoài ra, bạn có thể đính kèm chính sách Thu thập dữ liệu thống kê vào các proxy API để thu thập các chỉ số tuỳ chỉnh, chẳng hạn như mã nhận dạng người dùng hoặc sản phẩm, giá, hành động REST, phiên bản mục tiêu, URL mục tiêu và độ dài thông báo.

Video

Hãy xem các video sau để tìm hiểu thêm về báo cáo tuỳ chỉnh.

Video	Nội dung mô tả
Tạo báo cáo tuỳ chỉnh bằng giao diện người dùng	Tìm hiểu cách tạo báo cáo tuỳ chỉnh bằng giao diện người dùng Edge.
Tổng quan về báo cáo tuỳ chỉnh	Xem thông tin tổng quan về cách sử dụng báo cáo tuỳ chỉnh.
Theo dõi độ trễ API	Xem cách theo dõi độ trễ của API bằng báo cáo tuỳ chỉnh.
Theo dõi phản hồi lỗi API	Theo dõi phản hồi lỗi API bằng báo cáo tuỳ chỉnh.

Giới thiệu về báo cáo tùy chỉnh

Khi tạo báo cáo tuỳ chỉnh, bạn sẽ chọn dữ liệu mà bạn muốn xem (chỉ số), nhóm dữ liệu theo cách có ý nghĩa (phương diện) và tuỳ ý giới hạn dữ liệu được trả về dựa trên các đặc điểm cụ thể (bộ lọc) của dữ liệu.

Bạn cũng có thể đặt loại biểu đồ được hiển thị trong báo cáo tuỳ chỉnh dưới dạng biểu đồ cột hoặc biểu đồ dạng đường. Các hình ảnh sau đây minh hoạ biểu đồ minh hoạ cho chỉ số số lượt giao dịch trên mỗi giây được nhóm theo phương diện proxy API:

• Cột – mỗi proxy API được biểu thị bằng một cột khác:

  

• Dòng – mỗi API được biểu thị bằng một dòng khác nhau:

  

Đặt chỉ số và phương diện

Các metrics bạn chọn cho báo cáo tuỳ chỉnh sẽ xác định dữ liệu mà bạn đang cố gắng đo lường. Các chỉ số phổ biến bao gồm:

• Số giao dịch mỗi giây
• Thời gian phản hồi
• Lỗi chính sách

Một số chỉ số cho phép bạn thiết lập hàm tổng hợp để chạy dựa trên chỉ số đó. Ví dụ: bạn có thể sử dụng các hàm tổng hợp sau đây với chỉ số thời gian phản hồi:

• avg: Trả về thời gian phản hồi trung bình.
• min: Trả về thời gian phản hồi tối thiểu.
• max: Trả về thời gian phản hồi tối đa.
• sum: Trả về tổng của tất cả thời gian phản hồi.

Không phải chỉ số nào cũng hỗ trợ tất cả hàm tổng hợp. Tài liệu về metrics có một bảng chỉ định tên chỉ số và hàm (sum, avg, min, max) mà chỉ số đó hỗ trợ.

Phương diện chỉ định cách nhóm dữ liệu chỉ số. Ví dụ: bạn muốn tạo một báo cáo tuỳ chỉnh thể hiện chỉ số thời gian phản hồi. Bạn có thể sử dụng các phương diện để nhóm dữ liệu chỉ số theo sản phẩm API, proxy API hoặc email của nhà phát triển để có được:

• Thời gian phản hồi trên mỗi sản phẩm API
• Thời gian phản hồi trên mỗi proxy API
• Thời gian phản hồi theo email của nhà phát triển

Cách phương diện hiển thị trong biểu đồ của báo cáo tuỳ chỉnh phụ thuộc vào loại biểu đồ:

• Cột: Mỗi cột tương ứng với một giá trị khác nhau của phương diện.
• Đường: Mỗi dòng trong biểu đồ tương ứng với một giá trị thứ nguyên khác nhau và trục x biểu thị thời gian.

Tạo chỉ số và phương diện tuỳ chỉnh

Thêm chính sáchStatsCollection vào các proxy API để thu thập dữ liệu phân tích tuỳ chỉnh, chẳng hạn như mã người dùng hoặc mã sản phẩm, giá, hành động Kiến trúc chuyển trạng thái đại diện (REST), phiên bản mục tiêu, URL mục tiêu và độ dài thông báo. Dữ liệu có thể đến từ các biến luồng được xác định trước bởi Apigee, tiêu đề yêu cầu, tham số truy vấn hoặc biến tuỳ chỉnh mà bạn xác định. Sau khi dữ liệu được thu thập, bạn có thể tạo báo cáo tuỳ chỉnh để xem dữ liệu đó.

Cách bạn hiển thị dữ liệu phân tích tuỳ chỉnh trong báo cáo tuỳ chỉnh phụ thuộc vào loại dữ liệu của báo cáo đó:

• Đối với dữ liệu thuộc loại chuỗi, hãy tham khảo dữ liệu thống kê dưới dạng phương diện trong báo cáo tuỳ chỉnh.
• Đối với các loại dữ liệu số (số nguyên/số thực/số dài/đôi), hãy tham chiếu dữ liệu thống kê trong báo cáo tuỳ chỉnh dưới dạng phương diện hoặc chỉ số.

Vui lòng xem chính sách Thống kê thu thập để xem các ví dụ về cách thu thập dữ liệu phân tích tuỳ chỉnh.

Đặt bộ lọc

Bộ lọc cho phép bạn giới hạn dữ liệu chỉ số hiển thị trong báo cáo tuỳ chỉnh bằng cách đặt các đặc điểm cụ thể của dữ liệu chỉ số cần trả về. Ví dụ: bạn có thể tạo một bộ lọc để chỉ thấy dữ liệu chỉ số đối với thời gian phản hồi lớn hơn một giá trị cụ thể hoặc chỉ thấy một proxy API có tên cụ thể.

Bộ lọc sử dụng cú pháp điều kiện cho phép bạn tạo bộ lọc phức tạp bằng các toán tử như eq, ne, gt, lt và nhiều toán tử khác.

Ví dụ về báo cáo tuỳ chỉnh

Trong loại báo cáo tuỳ chỉnh đơn giản nhất, bạn chỉ định một chỉ số nhỏ và một phương diện duy nhất. Ví dụ: bạn xác định một báo cáo tuỳ chỉnh có các chế độ cài đặt sau:

• loại = Cột
• chỉ số = Số giao dịch trung bình mỗi giây
• phương diện = Proxy API

Báo cáo tuỳ chỉnh này chứa một biểu đồ cột với dữ liệu chỉ số "Số giao dịch trung bình mỗi giây" được nhóm theo phương diện proxy API:

Các chỉ số hiển thị giá trị trung bình cũng hiển thị đường liên kết Hiển thị độ phân tán ở phía bên phải của biểu đồ, như bạn có thể thấy trong biểu đồ trên. Di chuột qua đường liên kết để mở hộp phân tán. Hộp phân tán hiển thị xu hướng tập trung của dữ liệu.

Bạn có thể thêm nhiều chỉ số vào một báo cáo tuỳ chỉnh. Ví dụ: bạn xác định một báo cáo tuỳ chỉnh có hai chỉ số:

• loại = Cột
• chỉ số = Số giao dịch trung bình mỗi giây
• chỉ số = Lỗi chính sách
• phương diện = Proxy API

Báo cáo tuỳ chỉnh chứa một biểu đồ riêng cho từng chỉ số:

Bạn có thể thêm nhiều phương diện vào báo cáo tuỳ chỉnh. Ví dụ: bạn xác định một báo cáo tuỳ chỉnh có các chế độ cài đặt sau đây, bao gồm 2 chỉ số và 2 phương diện:

• loại = Cột
• chỉ số = Số giao dịch trung bình mỗi giây
• chỉ số = Lỗi chính sách
• phương diện = Proxy API
• phương diện = Động từ yêu cầu

Ban đầu, biểu đồ hiển thị các chỉ số được nhóm theo Proxy, phương diện đầu tiên được chỉ định khi bạn tạo báo cáo tuỳ chỉnh:

Sau đó, bạn có thể sử dụng trình đơn thả xuống Proxy, tương ứng với thứ nguyên đầu tiên, để chọn một proxy riêng. Giờ đây, biểu đồ mới cập nhật sẽ hiển thị các chỉ số cho proxy đã chọn theo động từ yêu cầu:

Khi bạn thêm ngày càng nhiều phương diện vào báo cáo tuỳ chỉnh, giao diện người dùng sẽ điều chỉnh để cho phép bạn xem chi tiết báo cáo theo từng phương diện.

Xem tất cả báo cáo tuỳ chỉnh

Truy cập vào trang báo cáo tuỳ chỉnh theo mô tả dưới đây.

Trang báo cáo tuỳ chỉnh cho thấy tất cả các báo cáo tuỳ chỉnh đã được tạo cho tổ chức của bạn, như minh hoạ trong hình sau:

Như được làm nổi bật trong hình, trang báo cáo tuỳ chỉnh cho phép bạn:

• Xem danh sách tất cả báo cáo tuỳ chỉnh.
• Thêm báo cáo tuỳ chỉnh.
• Hãy chạy một báo cáo tuỳ chỉnh bằng cách nhấp vào tên của báo cáo đó trong danh sách. Theo mặc định, báo cáo này được chạy bằng dữ liệu đã thu thập trong 1 giờ qua và dữ liệu đó sẽ xuất hiện trong trang tổng quan tuỳ chỉnh về báo cáo. Hãy xem bài viết Khám phá trang tổng quan của báo cáo tuỳ chỉnh.
• Tìm kiếm danh sách báo cáo tuỳ chỉnh bằng cách nhập toàn bộ hoặc một phần của chuỗi có liên quan vào hộp tìm kiếm; tất cả các trường hiển thị đều được tìm kiếm theo chuỗi đó.
• Xoá báo cáo tuỳ chỉnh.

Khám phá trang tổng quan báo cáo tuỳ chỉnh

Trang tổng quan tuỳ chỉnh của báo cáo hiển thị kết quả của báo cáo tuỳ chỉnh trong một khoảng thời gian cụ thể, bao gồm cả biểu đồ cột hoặc biểu đồ dạng đường của chỉ số được chỉ định:

Trang tổng quan báo cáo tuỳ chỉnh cho phép bạn:

• Xem dữ liệu báo cáo tuỳ chỉnh cho phạm vi thời gian đã chọn.
• Chọn Môi trường mà bạn muốn xem dữ liệu báo cáo tuỳ chỉnh.
• Chọn một phương diện cụ thể để lọc dữ liệu báo cáo tuỳ chỉnh. Vùng này chỉ được bật khi bạn chỉ định nhiều phương diện cho báo cáo.

• Chọn chế độ xem Biểu đồ hoặc Bảng.

• Phân tích một chỉ số bằng cách chọn biểu tượng trong hàng của bảng của chỉ số được liên kết. Xem các điểm bất thường và so sánh với khoảng thời gian trước đó hoặc với các chỉ số khác.
• Chạy báo cáo tuỳ chỉnh bằng cách nhấp vào và đặt phạm vi thời gian.
• Tải báo cáo tuỳ chỉnh xuống dưới dạng tệp CSV. Tệp này có tên như sau: metric.csv. Ví dụ: Average_of_total_response_time.csv.
• Chỉnh sửa báo cáo tuỳ chỉnh.

Khám phá trang tổng quan phân tích chỉ số

Nếu bạn chọn biểu tượng trong hàng của bảng tóm tắt, thì những biểu đồ sau đây sẽ xuất hiện (biểu đồ trên cùng chỉ xuất hiện nếu bạn đã thiết lập báo cáo để sử dụng nhiều chỉ số):

Những biểu đồ này hiển thị thông tin sau:

• So sánh với: Nếu bạn đã thiết lập để báo cáo sử dụng nhiều chỉ số, hãy so sánh các chỉ số với nhau.
• So sánh với khoảng thời gian trước đó: Xem chỉ số của khoảng thời gian trước đó. Ví dụ: nếu bạn chọn xem báo cáo tuỳ chỉnh trong 24 giờ qua, thì biểu đồ này sẽ hiển thị dữ liệu trong 24 giờ trước đó.

• Phân tích điểm bất thường: Hiển thị mọi điểm dữ liệu ngoại lệ trong dữ liệu báo cáo. Biểu đồ này hiển thị hai giá trị:

  • Giá trị trung bình động của chỉ số được hiển thị dưới dạng đường. Đối với một điểm nhất định trên đường kẻ, giá trị trung bình động được tính bằng cách lấy trung bình cộng của giá trị chỉ số tại thời điểm đó và của chỉ số đối với hai điểm dữ liệu trước đó.
  • Vùng màu xanh dương của biểu đồ xác định giá trị tối đa trung bình và trung bình tối thiểu của chỉ số. Tối đa trung bình là 1,2 * (trung bình động) và tối thiểu trung bình là 0,8 * (trung bình động).

  Nếu giá trị trung bình động nằm ngoài phạm vi của giá trị trung bình tối đa hoặc trung bình tối thiểu, thì đó được coi là điểm bất thường có thể xảy ra và được vẽ dưới dạng dấu chấm đỏ trên biểu đồ.

Thêm báo cáo tuỳ chỉnh

Bằng cách thêm báo cáo tuỳ chỉnh, bạn có thể tạo một bộ biểu đồ cung cấp thông tin chi tiết về mọi khía cạnh của chương trình API.

Sau khi thêm báo cáo tuỳ chỉnh, bạn phải run báo cáo đó một cách đồng bộ hoặc không đồng bộ.

Cách thêm báo cáo tuỳ chỉnh:

1. Truy cập vào trang Báo cáo tuỳ chỉnh.
2. Nhấp vào + Báo cáo tuỳ chỉnh.
3. Trong phần Cơ bản, hãy nhập thông tin sau:

   Trường	Mô tả
   Tên báo cáo	Tên báo cáo.
   Báo cáo phần mô tả có vấn đề	Mô tả báo cáo.
   Loại biểu đồ	Chọn kiểu biểu đồ cần sử dụng để trình bày dữ liệu phân tích tuỳ chỉnh. Cột: Trục X biểu thị các nhóm được chỉ định theo phương diện. Đường: Trục X biểu thị thời gian.

4. Trong phần Chỉ số:
   1. Nhấp vào biểu tượng cho Chỉ số.
   2. Chọn chỉ số bạn muốn phân tích.
   3. Chọn một Hàm tổng hợp để hiển thị các giá trị Tổng, Trung bình, Tối thiểu hoặc Tối đa.
   4. Nhấp vào Lưu.
   5. Hãy nhấp vào biểu tượng để thêm các chỉ số khác.
5. Trong mục Phương diện, hãy nhấp vào rồi chọn một phương diện, chẳng hạn như "Uỷ quyền" để ràng buộc tập dữ liệu dùng để tạo báo cáo. Bạn có thể thêm các phương diện khác để ràng buộc thêm dữ liệu.

6. Trong mục Bộ lọc, hãy thu hẹp thêm dữ liệu hiển thị bằng cách thêm bộ lọc vào định nghĩa báo cáo. Ví dụ: bạn có thể thêm một bộ lọc loại trừ dữ liệu cho proxy API thời tiết hoặc nhà phát triển jane@example.com.

   1. Nhấp vào rồi chọn Tên của thực thể bạn muốn lọc, một toán tử như = hoặc != và một Giá trị.
   2. Nhấp vào Thêm để lưu bộ lọc.
   3. Nhấp vào để thêm các bộ lọc khác rồi chọn trình kết nối AND hoặc OR.

7. Để giới hạn những người có thể truy cập vào báo cáo tuỳ chỉnh, hãy chỉnh sửa Vai trò tuỳ chỉnh đã xác định cho báo cáo đó.

   1. Nhấp vào để chỉnh sửa chế độ cài đặt vai trò tuỳ chỉnh.
   2. Chọn vai trò tuỳ chỉnh cần thiết để truy cập vào báo cáo và cấp truy cập (xem, chỉnh sửa, xoá).
   3. Nhấp vào Thêm.
   4. Nhấp vào để chỉnh sửa các vai trò khác.
8. Nhấp vào Lưu để lưu báo cáo.

Chạy báo cáo tuỳ chỉnh

Edge Analytics cho phép bạn chạy báo cáo đồng bộ hoặc không đồng bộ.

• Đối với báo cáo đồng bộ, bạn sẽ chạy yêu cầu báo cáo và yêu cầu đó sẽ bị chặn cho đến khi máy chủ phân tích cung cấp phản hồi. Tuy nhiên, vì một báo cáo có thể cần phải xử lý một lượng lớn dữ liệu (ví dụ: 100 GB), nên một báo cáo đồng bộ có thể không thực hiện được do hết thời gian chờ.

  Báo cáo đồng bộ có thể có phạm vi thời gian tối đa là 14 ngày. Nếu bạn chọn phạm vi thời gian từ 15 ngày trở lên, thì báo cáo sẽ luôn chạy không đồng bộ.

• Đối với báo cáo không đồng bộ, bạn sẽ chạy yêu cầu báo cáo và truy xuất kết quả vào lúc khác. Sau đây là một số trường hợp mà việc xử lý truy vấn không đồng bộ có thể là một phương án thay thế phù hợp:

  • Phân tích và tạo báo cáo trong những khoảng thời gian lớn.
  • Phân tích dữ liệu với nhiều phương diện nhóm và các quy tắc ràng buộc khác làm tăng độ phức tạp cho truy vấn
  • Quản lý truy vấn khi bạn nhận thấy rằng lượng dữ liệu đã tăng đáng kể đối với một số người dùng hoặc tổ chức.

  Tài liệu này mô tả cách bắt đầu một báo cáo không đồng bộ bằng cách sử dụng giao diện người dùng. Bạn cũng có thể sử dụng API, như mô tả trong bài viết Sử dụng API báo cáo tuỳ chỉnh không đồng bộ.

Cách chạy báo cáo tuỳ chỉnh cho một phạm vi thời gian cụ thể:

1. Truy cập vào trang Báo cáo tuỳ chỉnh.
2. Chọn báo cáo để chạy. Theo mặc định, báo cáo sẽ hiển thị dữ liệu cho giờ trước đó.

3. Cách chạy báo cáo cho một phạm vi thời gian khác:

   1. Nhấp vào khu vực phạm vi thời gian ở đầu báo cáo để mở cửa sổ bật lên Lựa chọn thời gian cho báo cáo tuỳ chỉnh.
   2. Chọn một trong hai chế độ sau:
      • Phạm vi thời gian xác định trước, chẳng hạn như Giờ qua, Hôm qua hoặc 7 ngày qua.

      • Phạm vi tuỳ chỉnh bằng cách chọn ngày và giờ Từ/Đến hoặc dùng lịch để chọn ngày bắt đầu và ngày kết thúc. Nhấp vào UTC để sử dụng Múi giờ phối hợp quốc tế (UTC).

   3. Để chạy báo cáo, hãy chọn một trong các mục sau:

      • Áp dụng để chạy báo cáo một cách đồng bộ. Kết quả sẽ hiển thị trong trang tổng quan tuỳ chỉnh của báo cáo sau khi báo cáo hoàn tất. Nếu mất hơn 60 giây để chạy báo cáo, báo cáo đó sẽ được tự động chuyển đổi thành báo cáo không đồng bộ.

      • Gửi công việc để chạy báo cáo không đồng bộ dưới dạng công việc trong nền. Hộp thoại sau đây sẽ xuất hiện:

        

        Nhấp vào Xem trạng thái trong hộp thoại để xem trạng thái của công việc báo cáo tuỳ chỉnh.

Xem công việc trong báo cáo tuỳ chỉnh không đồng bộ

Để xem các công việc trong báo cáo tuỳ chỉnh không đồng bộ, hãy chọn một trong các lựa chọn sau:

• Nhấp vào Xem trạng thái trong hộp thoại Báo cáo đã gửi dưới dạng công việc trong nền.
• Chọn Phân tích > Báo cáo tuỳ chỉnh > Báo cáo công việc từ thanh điều hướng bên trái.

Trang Báo cáo công việc được hiển thị, như được minh hoạ trong hình sau:

Trang Công việc báo cáo cho phép bạn:

• Xem tất cả kết quả công việc trong báo cáo tuỳ chỉnh không đồng bộ đã được gửi trong 7 ngày qua.

• Chọn môi trường mà bạn muốn hiển thị các công việc báo cáo tuỳ chỉnh.

• Để xem báo cáo tuỳ chỉnh, hãy đảm bảo đã hoàn tất Trạng thái của báo cáo đó. Sau đó, hãy di chuột qua hàng tương ứng với báo cáo. Biểu tượng và sẽ xuất hiện. Chọn để xem báo cáo.

• Tải báo cáo tuỳ chỉnh xuống bằng cách nhấp vào .

  Bạn có thể tải báo cáo đầy đủ xuống dưới dạng tệp ZIP có tên OfflineQueryResult-xxx.zip. Tệp này chứa các tệp CSV.

• Tìm danh sách báo cáo tuỳ chỉnh bằng cách nhập toàn bộ hoặc một phần của chuỗi có liên quan vào hộp tìm kiếm; tất cả các trường hiển thị đều được tìm kiếm theo chuỗi đó.

Chỉnh sửa báo cáo tuỳ chỉnh

Cách chỉnh sửa báo cáo tuỳ chỉnh:

1. Truy cập vào trang Báo cáo tuỳ chỉnh.
2. Di chuột qua tên của báo cáo mà bạn muốn chỉnh sửa. Các biểu tượng chỉnh sửa và xoá xuất hiện ở bên phải của trang.
3. Nhấp vào biểu tượng chỉnh sửa.
4. Chỉnh sửa thông tin chi tiết về báo cáo tuỳ chỉnh.
5. Nhấp vào Lưu.

Bạn sẽ được đưa trở lại kết quả báo cáo tuỳ chỉnh.

Xoá báo cáo tuỳ chỉnh

Cách xoá báo cáo tuỳ chỉnh:

1. Truy cập vào trang Báo cáo tuỳ chỉnh.
2. Di chuột qua tên của báo cáo mà bạn muốn chỉnh sửa. Các biểu tượng chỉnh sửa và xoá xuất hiện ở bên phải của trang.
3. Nhấp vào biểu tượng xoá để xoá báo cáo.