Khi viết code gọi API thì log những gì

Code gọi API sang bên đối tác quá là điều quen thuộc đối với các developer. Tuy nhiên không phải ai cũng có kinh nghiệm để log và debug khi có lỗi phát sinh liên quan tới việc gọi API.

Vậy khi gọi API thì chúng ta nên log những gì? Theo kinh nghiệm thì log tất :))

Gọi sang địa chỉ nào => log lại địa chỉ đấy. Truyền params nào => log params đấy. Response nhận được là gì log kết quả nhận được đấy

Chú ý code phải bắt được các trường hợp: không kết nối được sang API, kết nối được nhưng đợi response lâu quá nên timeout. Và phải có cảnh báo khi gặp những lỗi này. Cảnh báo thì có thể là mail, SMS, nhắn tin bằng bot qua Facebook Messenger, Telegram...

Nếu log quá nhiều và quá lớn thì nên có chế độ ON OFF log mà mình có thể kích hoạt nhanh trên tool web hoặc thay đổi giá trị 1 trường trong database/1 file config.

Với các thông tin nhạy cảm như mật khẩu, secret key... thì khi log chú ý xóa hoặc mã hóa nó trước. Tránh trường hợp kẻ gian vô tình hay cố ý xem được log thì cũng không làm được gì xấu, gây ảnh hưởng tới hệ thống.

Chú ý log thời gian, và log vào files hay DB thì cũng làm sao để mà có thể tìm nhanh log trong một khoảng thời gian. Ví dụ file thì mỗi ngày log ra 1 file có tên theo ngày. DB thì đánh index trường thời gian log.