12 phương pháp hay nhất về ghi log: Những điều nên làm và không nên làm

Một số phương pháp, đoạn này mình xin phép để nguyên bản tài liệu để dễ hiểu nhé:

1. Define clear logging objectives
2. Use appropriate log levels
3. Implement structured logging
4. Write meaningful log messages
5. Centralize log management
6. Implement log rotation and retention policies
7. Don't log sensitive information
8. Don't ignore performance impact
9. Don't rely solely on logs for monitoring
10. Don't neglect log security
11. Don't log everything
12. Don't forget to review and maintain logs

Video liên quan từ YouTube: https://youtu.be/9L77QExPmI0

1. Xác định mục tiêu ghi log rõ ràng

Căn chỉnh mục tiêu

Đặt mục tiêu ghi log rõ ràng giúp tập trung nỗ lực của bạn và đảm bảo bạn đang theo dõi đúng thứ. Nếu không có mục tiêu rõ ràng, bạn có thể ghi log quá nhiều hoặc quá ít, lãng phí thời gian và bỏ lỡ thông tin quan trọng.

Sử dụng mức độ log

Khi thiết lập mục tiêu ghi log, hãy nghĩ về việc sử dụng mức log nào. Mức log giúp sắp xếp các thông báo theo mức độ quan trọng của chúng. Các mức phổ biến là:

Chọn mức độ phù hợp với nhu cầu của bạn và giúp bạn theo dõi những gì quan trọng nhất.

Định dạng có cấu trúc

Sử dụng định dạng được thiết lập cho các thông điệp logs của bạn. Điều này giúp chúng dễ đọc và phân tích hơn. Bao gồm những thứ như:

• Time the event happened
• Log level
• Message
• Any other useful details

Một định dạng tốt giúp bạn tìm và sử dụng thông tin bạn cần một cách nhanh chóng. Tại sao mục tiêu ghi logs rõ ràng lại quan trọng Mục tiêu ghi logs rõ ràng giúp bạn:

Một định dạng tốt sẽ giúp bạn tìm và sử dụng thông tin cần thiết một cách nhanh chóng.

Tại sao mục tiêu ghi logs rõ ràng lại quan trọng

Mục tiêu ghi logs rõ ràng sẽ giúp bạn:

• Tập trung vào những gì quan trọng
• Tránh ghi logs quá nhiều hoặc quá ít
• Tìm và khắc phục sự cố nhanh hơn
• Phù hợp việc ghi logs của bạn với nhu cầu của hệ thống

2. Sử dụng mức log phù hợp

Sử dụng mức độ log

Chọn đúng cấp độ log giúp sắp xếp các mục log theo mức độ quan trọng của chúng. Điều này giúp tìm và khắc phục sự cố dễ dàng hơn. Sau đây là các cấp độ log phổ biến:

Sử dụng đúng mức độ giúp bạn ghi lại đúng lượng thông tin và phát hiện ra những vấn đề lớn một cách nhanh chóng.

Thông tin theo ngữ cảnh

Hãy nghĩ về nơi bạn sẽ sử dụng log khi chọn cấp độ. Ví dụ:

Thực hành tốt nhất cho Mức log

Sau đây là cách sử dụng mức log hiệu quả:

• Sử dụng Fatal cho những vấn đề lớn có thể ngăn chặn mọi thứ
• Sử dụng Lỗi cho các vấn đề phá vỡ mọi thứ
• Sử dụng Cảnh báo cho các vấn đề có thể xảy ra trong tương lai
• Sử dụng Thông tin để cập nhật hệ thống chung
• Sử dụng Debug để biết thêm chi tiết khi khắc phục sự cố
• Sử dụng Trace để biết thông tin rất chi tiết khi săn bọ
• Đừng sử dụng quá nhiều cấp độ - điều này làm cho việc sắp xếp trở nên khó khăn
• Sử dụng cùng một cấp độ trong toàn bộ ứng dụng của bạn để rõ ràng hơn

3. Thực hiện ghi log có cấu trúc

Định dạng có cấu trúc

Ghi log có cấu trúc sắp xếp dữ liệu log theo một định dạng được thiết lập. Nó sử dụng cặp khóa-giá trị thay vì văn bản thuần túy. Điều này giúp log dễ đọc và phân tích hơn.

Lợi ích của việc ghi log có cấu trúc

Thực hành tốt nhất cho việc ghi log có cấu trúc

Để sử dụng ghi log có cấu trúc tốt:

1. Chọn một định dạng : Sử dụng cùng một định dạng, như JSON, cho tất cả các log

2. Thêm thông tin chi tiết hữu ích : Bao gồm những thông tin như thời gian, mã lỗi và thông tin hữu ích khác

3. Sử dụng nhãn chuẩn : Tạo nhãn và định dạng thời gian giống nhau trên tất cả các bản ghi

4. Giữ cho nó đơn giản : Không sử dụng quá nhiều trường trong log của bạn

5. Sử dụng công cụ ghi log : Chọn một công cụ có thể xử lý và phân tích log có cấu trúc của bạn

Ghi log có cấu trúc so với không có cấu trúc

4. Hãy viết những tin nhắn log có ý nghĩa

Thông tin theo ngữ cảnh

Tin nhắn log tốt nên bao gồm các chi tiết chính giúp giải thích những gì đã xảy ra. Điều này giúp dễ hiểu và khắc phục sự cố hơn. Bao gồm những điều như:

• Mã lỗi
• Dữ liệu quan trọng liên quan đến sự kiện
• Thời gian đã xảy ra
• ID người dùng hoặc hệ thống
• Hệ thống đã làm gì

Việc thêm thông tin này sẽ giúp các nhóm nhanh chóng tìm ra và khắc phục sự cố.

Phù hợp với mục tiêu

Viết tin nhắn log giúp ích cho:

• Theo dõi những gì hệ thống làm
• Tìm và khắc phục sự cố
• Đáp ứng các yêu cầu về an ninh và quy định
• Làm cho hệ thống hoạt động tốt hơn

Hãy ghi nhớ những mục tiêu này khi viết tin nhắn log.

Sử dụng Mức Log

Viết tin nhắn phù hợp với cấp độ log phù hợp:

Sử dụng đúng cấp độ sẽ giúp truyền tải đúng thông tin tới đúng người.

Định dạng có tổ chức

Sử dụng định dạng được thiết lập cho các thông điệp log. Điều này giúp chúng dễ đọc và sử dụng hơn. Ví dụ:

2022-07-27 14:30:00 ERROR [USER-123] User login failed: wrong password

Định dạng này hiển thị:

• Khi nó xảy ra
• Nó nghiêm trọng đến mức nào
• Nó ảnh hưởng đến ai
• Có gì sai sót

5. Tập trung quản lý log

Quản lý log tập trung giúp thu thập và lưu trữ log từ nhiều nguồn khác nhau tại một nơi. Điều này giúp bạn dễ dàng tìm và khắc phục sự cố trên toàn bộ hệ thống.

Tại sao nên sử dụng Quản lý log tập trung?

Cách chọn công cụ quản lý log

Khi chọn công cụ để quản lý log, hãy nghĩ đến:

• Nó có thể xử lý được nhiều bản ghi không?
• Có an toàn không?
• Nó có dễ sử dụng không?
• Nó có hoạt động với các công cụ khác của bạn không?
• Giá của nó là bao nhiêu?

Một số công cụ phổ biến là ELK Stack , Splunk và Sumo Logic .

Các bước thiết lập quản lý log tập trung

1. Chọn một công cụ phù hợp với nhu cầu của bạn

2. Thiết lập thu thập log từ tất cả các nguồn của bạn

3. Lưu trữ log ở nơi trung tâm

4. Thiết lập các cách để tìm kiếm và phân tích log của bạn

5. Tạo cảnh báo cho các sự kiện quan trọng

6. Đào tạo nhóm của bạn sử dụng hệ thống mới

6. Thực hiện chính sách luân chuyển và lưu giữ log

Xoay và giữ lại

Chính sách luân chuyển và lưu giữ log giúp quản lý log tốt hơn. Sau đây là những gì chúng làm:

• Xoay vòng log: Đổi tên, nén hoặc xóa các tệp log cũ khi chúng quá lớn hoặc quá cũ.
• Lưu giữ log: Thiết lập thời gian lưu giữ log trước khi xóa hoặc lưu trữ chúng ở nơi khác.

Các chính sách này giúp tiết kiệm không gian, duy trì hệ thống hoạt động tốt và tuân thủ các quy tắc về lưu trữ dữ liệu.

Lợi ích của việc luân chuyển và lưu giữ log

Làm thế nào để thực hiện luân chuyển và giữ lại bản ghi tốt

1. Đặt ra các quy tắc rõ ràng : Quyết định tần suất xoay vòng các bản ghi và thời gian lưu giữ chúng.
2. Sử dụng Công cụ : Thiết lập phần mềm để xoay vòng log tự động.
3. Giữ log an toàn : Lưu trữ log ở nơi chỉ những người có thẩm quyền mới có thể nhìn thấy.
4. Kiểm tra hệ thống của bạn : Đảm bảo tính năng xoay vòng và lưu giữ log hoạt động đúng.