Sử dụng công cụ Theo dõi

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu Apigee X. Thông tin

Công cụ Trace là gì?

Trace là một công cụ để khắc phục sự cố và giám sát các proxy API đang chạy trên Apigee Edge. Trace cho phép bạn kiểm tra chi tiết của từng bước thông qua một luồng proxy API.

Cách sử dụng Trace

Trace rất dễ sử dụng. Bạn bắt đầu một phiên theo dõi, sau đó thực hiện một lệnh gọi API đến nền tảng Edge và đọc kết quả.

1. Truy cập vào trang API proxy, như mô tả bên dưới.
   

   Edge

   Cách truy cập vào trang proxy API bằng giao diện người dùng Edge:

   1. Đăng nhập vào apigee.com/edge.
   2. Chọn Develop > API Proxies (Phát triển > API Proxy) trong thanh điều hướng bên trái.

   Classic Edge (Private Cloud)

   Cách truy cập vào trang proxy API bằng giao diện người dùng Classic Edge:

   1. Đăng nhập vào http://ms-ip:9000, trong đó ms-ip là địa chỉ IP hoặc tên DNS của nút Máy chủ quản lý.
   2. Chọn API > API Proxies (API > API Proxy) trong thanh điều hướng trên cùng.
2. Chọn một API proxy trên trang API Proxies (API Proxy).
3. Đảm bảo rằng API mà bạn muốn theo dõi đã được triển khai.
4. Nhấp vào Trace (Dấu vết) để chuyển đến khung hiển thị công cụ Trace.
5. Sử dụng trình đơn thả xuống Triển khai để theo dõi để chọn môi trường triển khai và bản sửa đổi proxy mà bạn muốn theo dõi.
6. Nhấp vào Start Trace Session (Bắt đầu phiên theo dõi). Khi phiên Theo dõi đang hoạt động, proxy API sẽ ghi lại thông tin chi tiết của từng bước trong quy trình xử lý. Trong khi phiên theo dõi đang chạy, các thông báo và dữ liệu theo ngữ cảnh sẽ được thu thập từ lưu lượng truy cập trực tiếp.
   

   

7. Nếu bạn không có lưu lượng truy cập trực tiếp nào thông qua proxy, thì chỉ cần gửi yêu cầu đến API. Bạn có thể dùng bất kỳ công cụ nào bạn muốn để gửi yêu cầu, chẳng hạn như curl, Postman hoặc bất kỳ công cụ quen thuộc nào. Hoặc bạn có thể gửi yêu cầu ngay trong công cụ Trace. Bạn chỉ cần nhập URL rồi nhấp vào Gửi. Lưu ý: Bạn chỉ có thể gửi yêu cầu GET từ công cụ Theo dõi chứ không thể gửi yêu cầu POST.
   
   Lưu ý: Một phiên Trace có thể hỗ trợ 10 giao dịch yêu cầu/phản hồi cho mỗi trình xử lý thông báo thông qua proxy API đã chọn. Trong đám mây Edge, với 2 bộ xử lý thông báo xử lý lưu lượng truy cập, 20 giao dịch yêu cầu/phản hồi được hỗ trợ. Một phiên theo dõi sẽ tự động dừng sau 10 phút nếu bạn không dừng theo cách thủ công.
   
8. Khi bạn đã ghi lại đủ số lượng yêu cầu, hãy nhấp vào Dừng phiên theo dõi.
9. Một danh sách các giao dịch yêu cầu/phản hồi đã ghi lại sẽ xuất hiện trong trình đơn bên trái. Nhấp vào một giao dịch bất kỳ để xem kết quả chi tiết.

Cách đọc dấu vết

Công cụ theo dõi có hai phần chính là bản đồ giao dịch và thông tin chi tiết về giai đoạn:

• Bản đồ giao dịch sử dụng biểu tượng để đánh dấu từng bước đáng chú ý diễn ra trong một giao dịch proxy API, bao gồm cả việc thực thi chính sách, các bước có điều kiện và các quá trình chuyển đổi. Di chuột qua bất kỳ biểu tượng nào để xem thông tin tóm tắt. Các bước trong quy trình yêu cầu xuất hiện ở đầu bản đồ giao dịch và các bước trong quy trình phản hồi xuất hiện ở cuối.
• Phần thông tin chi tiết về giai đoạn của công cụ liệt kê thông tin về quá trình xử lý nội bộ của proxy, bao gồm cả các biến được đặt hoặc đọc, tiêu đề yêu cầu và phản hồi, cũng như nhiều thông tin khác. Nhấp vào biểu tượng bất kỳ để xem thông tin chi tiết về giai đoạn của bước đó.

Sau đây là bản đồ công cụ theo dõi mẫu có các phân đoạn xử lý proxy chính được gắn nhãn:

Bản đồ giao dịch của công cụ theo dõi

Chú giải bản đồ giao dịch

Bảng sau đây mô tả ý nghĩa của các biểu tượng mà bạn sẽ thấy trong bản đồ giao dịch. Các biểu tượng này đánh dấu từng bước xử lý đáng chú ý trong suốt quy trình proxy.

Biểu tượng giao dịch trên bản đồ

	Ứng dụng khách gửi yêu cầu đến ProxyEndpoint của API proxy.
	Các vòng tròn đánh dấu các điểm cuối chuyển tiếp trong luồng proxy. Chúng xuất hiện khi có yêu cầu từ ứng dụng, khi yêu cầu chuyển đến mục tiêu, khi phản hồi quay lại từ mục tiêu và khi phản hồi quay lại ứng dụng.
	Các thanh cao cho biết điểm bắt đầu của một phân đoạn luồng trong luồng proxy API. Các phân đoạn của luồng là: Yêu cầu ProxyEndpoint, yêu cầu TargetEndpoint, phản hồi TargetEndpoint và phản hồi ProxyEndpoint. Một phân đoạn bao gồm PreFlow, Conditional Flows và PostFlow. Hãy xem phần Định cấu hình luồng để biết thêm thông tin.
	Cho biết các thao tác Analytics đã diễn ra ở chế độ nền.
	Một luồng có điều kiện đánh giá là đúng. Để tìm hiểu về quy trình có điều kiện, hãy xem phần Định cấu hình quy trình. Xin lưu ý rằng một số điều kiện do Edge tạo. Ví dụ: sau đây là một biểu thức mà Edge dùng để kiểm tra xem có lỗi xảy ra trong ProxyEndpoint hay không: ((error.state equals PROXY_REQ_FLOW) or (error.state equals PROXY_RESP_FLOW))
	Một luồng có điều kiện đánh giá là sai. Để tìm hiểu về quy trình có điều kiện, hãy xem phần Định cấu hình quy trình. Xin lưu ý rằng một số điều kiện do Edge tạo. Ví dụ: sau đây là một biểu thức mà Edge dùng để kiểm tra xem có lỗi xảy ra trong TargetEndpoint hay không: (((error.state equals TARGET_REQ_FLOW) or (error.state equals TARGET_RESP_FLOW)) or ((error.state equals REQ_SENT) or (error.state equals RESP_START)))
	Chính sách. Mỗi loại chính sách đều có một biểu tượng riêng. Đây là chính sách AssignMessage. Các biểu tượng này cho phép bạn xem các chính sách được thực thi theo đúng thứ tự và liệu chúng có thành công hay không. Bạn có thể nhấp vào biểu tượng chính sách để xem kết quả thực thi và liệu kết quả đó có đúng như dự kiến hay không. Ví dụ: bạn có thể biết liệu thông báo có được chuyển đổi đúng cách hay không hoặc liệu thông báo có đang được lưu vào bộ nhớ đệm hay không. Việc thực thi đúng cách các chính sách được biểu thị rõ ràng bằng dấu đánh dấu. Trong trường hợp xảy ra lỗi, dấu chấm than màu đỏ sẽ xuất hiện trên biểu tượng. Lưu ý: Chú ý đến chú thích hoặc dòng thời gian để xem có chính sách nào mất nhiều thời gian hơn dự kiến hay không.
	Xuất hiện khi đích đến phụ trợ là một ứng dụng Node.js. Xem phần Tổng quan về Node.js trên Apigee Edge.
	Mục tiêu phụ trợ được gọi bởi proxy API.
	Dòng thời gian cho biết thời gian xử lý (tính bằng mili giây) cần thiết để hoàn tất. Việc so sánh các phân đoạn thời gian đã trôi qua giúp bạn tách biệt những chính sách mất nhiều thời gian thực thi nhất và đang làm chậm các lệnh gọi API của bạn.
	Epsilon cho biết một khoảng thời gian nhỏ hơn một mili giây.
	Đang tắt. Xuất hiện trên biểu tượng chính sách khi một chính sách bị tắt. Bạn có thể tắt một chính sách bằng API công khai. Xem Tài liệu tham khảo về cấu hình proxy API.
	Đã có lỗi. Xuất hiện trên biểu tượng chính sách khi điều kiện Bước chính sách đánh giá là sai (xem Các biến và điều kiện của quy trình) hoặc trên biểu tượng chính sách RaiseFault bất cứ khi nào một chính sách RaiseFault thực thi.
	Đã bỏ qua. Xuất hiện trên biểu tượng chính sách khi chính sách không được thực thi vì điều kiện bước được đánh giá là sai. Hãy xem phần Biến và điều kiện của luồng để biết thêm thông tin.

Tìm hiểu thông tin chi tiết về giai đoạn

Phần Phase Details (Thông tin chi tiết về giai đoạn) của công cụ này cho bạn biết nhiều thông tin về trạng thái của proxy ở mỗi bước xử lý. Sau đây là một số thông tin chi tiết được cung cấp trong phần Chi tiết về giai đoạn. Nhấp vào biểu tượng bất kỳ trong công cụ theo dõi để xem thông tin chi tiết về bước đã chọn hoặc sử dụng các nút Tiếp theo/Quay lại để di chuyển từ bước này sang bước khác.

Tinh chỉnh việc ghi lại thông báo bằng bộ lọc

Bạn có thể lọc những yêu cầu xuất hiện trong công cụ Theo dõi bằng cách chỉ định các giá trị tham số tiêu đề và/hoặc truy vấn. Bộ lọc cho phép bạn nhắm đến những lệnh gọi cụ thể có thể gây ra vấn đề. Ví dụ: bạn có thể cần tập trung vào những yêu cầu có nội dung cụ thể hoặc yêu cầu đến từ các đối tác hoặc ứng dụng cụ thể. Bạn có thể lọc theo:

• Tiêu đề HTTP – Giới hạn dấu vết chỉ cho các lệnh gọi có chứa một tiêu đề cụ thể. Đây là một cách hay để giúp bạn khắc phục vấn đề. Bạn có thể gửi một tiêu đề cho nhà phát triển ứng dụng và yêu cầu họ thêm tiêu đề đó vào lệnh gọi đang gây ra vấn đề. Sau đó, Apigee Edge sẽ chỉ ghi lại các lệnh gọi có tiêu đề cụ thể đó để bạn có thể kiểm tra kết quả.
• Tham số truy vấn – Chỉ những lệnh gọi có một giá trị cụ thể của một tham số mới được ghi lại.

Những điều bạn cần biết về tính năng Bộ lọc

• Bạn phải khởi động lại phiên theo dõi sau khi chỉ định các tham số bộ lọc trong các trường bộ lọc.
• Các tham số bộ lọc được kết hợp với nhau bằng toán tử AND. Tất cả các cặp tên/giá trị tiêu đề và/hoặc truy vấn được chỉ định phải có trong yêu cầu để khớp thành công.
• Công cụ Bộ lọc không hỗ trợ tính năng so khớp mẫu.
• Các tham số và giá trị bộ lọc có phân biệt chữ hoa chữ thường.

Cách tạo bộ lọc dấu vết

1. Nếu một phiên theo dõi đang chạy, hãy dừng phiên đó bằng cách nhấp vào Stop Trace Session (Dừng phiên theo dõi).
2. Nhấp vào Bộ lọc ở góc trên cùng bên trái của Công cụ theo dõi để mở rộng trường Bộ lọc.
   
   
   
3. Trong trường Bộ lọc, hãy chỉ định tham số truy vấn và/hoặc giá trị tiêu đề mà bạn muốn lọc. Trong ví dụ này, chúng ta chỉ định 2 tham số truy vấn để lọc. Cả hai tham số đều phải có trong yêu cầu để khớp thành công.
   
   
   
4. Bắt đầu phiên theo dõi.
5. Gọi API của bạn. Chỉ những yêu cầu bao gồm tất cả(các) tiêu đề và/hoặc(các) tham số truy vấn được chỉ định mới tạo ra kết quả khớp thành công.

Trong ví dụ trên, lệnh gọi API này sẽ xuất hiện trong Dấu vết:

http://docs-test.apigee.net/cats?name=Penny&breed=Calico

Tuy nhiên, thao tác này sẽ không:

http://docs-test.apigee.net/cats?name=Penny

Gỡ lỗi bằng tính năng Theo dõi

Tính năng Theo dõi cho phép bạn xem nhiều thông tin chi tiết nội bộ về một proxy API. Ví dụ:

• Bạn có thể xem nhanh những chính sách đang thực thi đúng cách hoặc không thực thi được.
• Giả sử bạn nhận thấy thông qua một trong các trang tổng quan Analytics rằng một trong các API của bạn đang gặp phải tình trạng hiệu suất giảm bất thường. Giờ đây, bạn có thể sử dụng Trace để xác định vị trí xảy ra tình trạng tắc nghẽn. Dấu vết cho biết thời gian (tính bằng mili giây) cần thiết để hoàn tất từng bước xử lý. Nếu thấy một bước mất quá nhiều thời gian, bạn có thể thực hiện biện pháp khắc phục.
• Bằng cách xem thông tin chi tiết về giai đoạn, bạn có thể kiểm tra các tiêu đề đang được gửi đến phần phụ trợ, xem các biến do chính sách đặt, v.v.
• Bằng cách xác minh đường dẫn cơ sở, bạn có thể đảm bảo rằng một chính sách đang định tuyến thông báo đến đúng máy chủ.

Chọn chế độ xem

Chọn các chế độ xem cho phiên theo dõi.

Tải kết quả dấu vết xuống

Bạn có thể tải tệp XML chứa kết quả theo dõi thô xuống để xem và tìm kiếm khi không có mạng trong một trình chỉnh sửa văn bản. Tệp này cho thấy thông tin chi tiết đầy đủ về phiên nghe, bao gồm cả nội dung của tất cả các tiêu đề, biến và chính sách.

Để tải xuống, hãy nhấp vào Tải phiên theo dõi xuống.

Hiển thị các yêu cầu dưới dạng curl

Sau khi theo dõi một lệnh gọi API được thực hiện đến một máy chủ đích, bạn có thể xem yêu cầu dưới dạng một lệnh curl. Điều này đặc biệt hữu ích khi gỡ lỗi vì một số lý do:

• API proxy có thể sửa đổi yêu cầu, vì vậy, bạn nên xem yêu cầu từ proxy đến máy chủ đích khác với yêu cầu ban đầu như thế nào. Lệnh curl đại diện cho yêu cầu đã sửa đổi.
• Đối với tải trọng thông báo lớn hơn, curl cho phép bạn xem tiêu đề HTTP và nội dung thông báo ở cùng một nơi. (Hiện tại,giới hạn là khoảng 1.000 ký tự. Để biết mẹo vượt qua giới hạn này, hãy xem bài đăng này trên thẻ Cộng đồng.)

Để bảo mật, tính năng curl sẽ che tiêu đề Uỷ quyền HTTP.

Để xem các yêu cầu dưới dạng curl sau khi một lệnh gọi API xuất hiện trong Trace, hãy chọn giai đoạn "Yêu cầu được gửi đến máy chủ đích" trong sơ đồ Transaction Map (Bản đồ giao dịch), sau đó nhấp vào nút Show curl (Hiện curl) trong cột "Yêu cầu được gửi đến máy chủ đích" trong ngăn Phase Details (Thông tin chi tiết về giai đoạn).

Sử dụng tính năng Trace của Apigee Support

Theo mặc định, Apigee Edge cho phép bộ phận hỗ trợ Apigee sử dụng công cụ Theo dõi trên các API API để hỗ trợ. Bạn có thể tắt tùy chọn này bất cứ lúc nào. Tuy nhiên, việc tắt tuỳ chọn này có thể hạn chế khả năng của Apigee Support để hỗ trợ bạn.

Để vô hiệu hóa Hỗ trợ Apigee sử dụng công cụ Theo dõi:

1. Đăng nhập vào https://apigee.com/edge.
2. Chọn Quản trị > Bảo mật và quyền riêng tư trong thanh điều hướng bên trái.
3. Nhấp vào nút bật/tắt Enable Apigee Support to Trace (Bật tính năng hỗ trợ Apigee) để tắt tính năng sử dụng công cụ Theo dõi của Apigee.