Stdout Log

Tổng Quan

Chính sách stdout-log được sử dụng để ghi lại dữ liệu yêu cầu và phản hồi API vào bảng điều khiển (đầu ra tiêu chuẩn). Nó cung cấp ghi lại chi tiết các tiêu đề, nội dung và các trường tùy chỉnh trong quá trình xử lý yêu cầu. Điều này hữu ích cho việc gỡ lỗi và giám sát, đặc biệt là khi chẩn đoán các lỗi hoặc theo dõi luồng dữ liệu giữa các dịch vụ. Tuy nhiên, cần thận trọng vì việc ghi lại các tải trọng yêu cầu/phản hồi lớn có thể dẫn đến các vấn đề về hiệu suất hoặc khối lượng nhật ký quá mức.

Chính sách này có thể chọn lọc ghi lại toàn bộ nội dung, tiêu đề, hoặc chỉ các phản hồi lỗi, và nó hỗ trợ cả việc chèn trường tùy chỉnh và che giấu dữ liệu nhạy cảm.

Chi Tiết Cấu Hình

Trường	Loại	Mô Tả
withBodyLog	Chuyển đổi	Ghi lại cả nội dung yêu cầu và phản hồi khi được kích hoạt. Có thể dẫn đến khối lượng nhật ký lớn.
withHeaderLog	Chuyển đổi	Ghi lại các tiêu đề yêu cầu khi được kích hoạt.
withErrorBodyLog	Chuyển đổi	Khi được kích hoạt, ghi lại nội dung yêu cầu/phản hồi chỉ cho các phản hồi thất bại (mã trạng thái HTTP >= 300),
customFields	Trình chỉnh sửa JSON	Cho phép chèn thêm các trường tùy chỉnh vào dữ liệu nhật ký. Giá trị phải là JSON hợp lệ. Ví dụ: "request_uri": "xyz"
maskingFields	Biểu mẫu	Xác định các trường cần được che giấu trong nhật ký để bảo mật. Áp dụng cho Nội dung Yêu cầu, Nội dung Phản hồi, hoặc Tiêu đề Yêu cầu. Cần kích hoạt withBodyLog hoặc withHeaderLog.

ghi chú

Không thể thay đổi: Chuyển đổi để ngăn chính sách này bị xóa.

Không thể thay đổi giá trị cài đặt: Chuyển đổi để ngăn thay đổi các giá trị cấu hình sau khi thiết lập.

Nếu withBodyLog hoặc withHeaderLog bị vô hiệu hóa trong khi việc che giấu vẫn đang hoạt động, một hộp thoại cảnh báo sẽ xuất hiện gợi ý loại bỏ các quy tắc che giấu để tránh sự không nhất quán trong việc ghi lại.

Tùy Chọn Trường Che Giấu

Mỗi quy tắc che giấu yêu cầu:

• Loại: Một trong các loại Request Body, Response Body, hoặc Request Headers.
• Tên Trường: Trường cần che giấu (ví dụ: tài khoản, điện thoại).
• Giá Trị Che Giấu: Giá trị để thay thế trường (ví dụ: *** hoặc mẫu che giấu).

Người dùng có thể nhấp vào nút thêm màu xanh để thêm trường che giấu mới để cấu hình hoặc nhấp vào nút trừ màu đỏ trên trường tương ứng để xóa.

Ví Dụ

Ghi Lại Tất Cả Tải Payloads

"withBodyLog": true,
"withHeaderLog": true,
"withErrorBodyLog": false

• Ghi lại các thân yêu cầu và phản hồi cũng như tất cả các tiêu đề cho mỗi yêu cầu.
• Phù hợp cho các môi trường phát triển.

Ghi Lại Chỉ Lỗi

"withErrorBodyLog": true

• Ghi lại thân và tiêu đề chỉ khi trạng thái phản hồi là 300 trở lên.
• Giúp giảm khối lượng ghi lại trong khi vẫn ghi lại các lỗi quan trọng.

Trường Tùy Chỉnh Trong Nhật Ký

{
	"customFields": {
	"request_id": "abc123",
	"env": "staging"
	}
}

• Thêm siêu dữ liệu tùy chỉnh vào mỗi mục nhật ký.

Che Giấu Thông Tin Nhạy Cảm

Loại	Trường	Giá Trị Bị Che Giấu
Request Body	tài khoản	*****
Request Body	điện thoại	010--

Các giá trị này sẽ được che giấu tự động trong đầu ra thân yêu cầu/phản hồi đã ghi lại.