Chuyển tới nội dung chính

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 chép chi tiết về 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 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 ghi chép quá mức.

Chính sách này có thể ghi lại một cách chọn lọc 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ườngLoạiMô Tả
withBodyLogChuyển đổiGhi 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 ghi chép lớn.
withHeaderLogChuyển đổiGhi lại các tiêu đề yêu cầu khi được kích hoạt.
withErrorBodyLogChuyển đổiKhi được kích hoạt, chỉ ghi lại nội dung yêu cầu/phản hồi cho các phản hồi thất bại (mã trạng thái HTTP >= 300),
customFieldsTrình chỉnh sửa JSONCho phép chèn thêm các trường tùy chỉnh vào dữ liệu ghi chép. Giá trị phải là JSON hợp lệ. Ví dụ: "request_uri": "xyz"
maskingFieldsBiểu mẫuXác định các trường cần được che giấu trong các ghi chép để bảo vệ quyền riêng 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 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 ý xóa các quy tắc che giấu để tránh ghi chép không nhất quán.

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

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

  • Loại: Một trong các Nội dung Yêu cầu, Nội dung Phản hồi, hoặc Tiêu đề Yêu cầu.
  • 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 Trọng​

"withBodyLog": true,
"withHeaderLog": true,
"withErrorBodyLog": false
  • Ghi lại nội dung 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 nội dung 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 chép trong khi vẫn nắm bắt được các lỗi quan trọng.

Trường Tùy Chỉnh Trong Ghi Chép​

{
	"customFields": {
	"request_id": "abc123",
	"env": "staging"
	}
}
  • Thêm siêu dữ liệu tùy chỉnh vào mỗi mục ghi chép.

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

LoạiTrườngGiá Trị Bị Che Giấu
Nội dung Yêu cầutài khoản*****
Nội dung Yêu cầuđiện thoại010--

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