Điều gì cần ghi vào tệp nhật ký?

Question

Câu hỏi của tôi rất đơn giản: viết gì vào nhật ký. Có bất kỳ quy ước nào không? Tôi phải làm gì?

Vì ứng dụng của tôi phải được phát hành, tôi muốn có nhật ký thân thiện, có thể được đọc bởi hầu hết mọi người mà không hỏi nó là gì.

Tôi đã có một số ý tưởng, như dấu thời gian, số nhận dạng duy nhất cho từng chức năng/phương pháp, v.v. Tôi muốn có một số mức nhật ký, như truy tìm/gỡ lỗi, thông tin, lỗi/cảnh báo.

Bạn có sử dụng một số tài nguyên nhật ký được định dạng trước không?

Cảm ơn bạn

Answer 1

Dưới đây là một số gợi ý cho nội dung:

• timestamp
• nhắn
• log loại tin nhắn (như lỗi, cảnh báo, dấu vết, debug)
• id chủ đề (để bạn có thể hiểu được tệp nhật ký từ một ứng dụng đa luồng)

Thực hành tốt nhất để thực hiện:

• Đặt một mutex xung quanh phương pháp ghi do đó bạn có thể chắc chắn rằng mỗi ghi là chủ đề an toàn và sẽ có ý nghĩa.
• Gửi 1 thư tại một thời điểm vào tệp nhật ký và chỉ định loại thông báo tường trình mỗi lần. Sau đó, bạn có thể đặt loại ghi nhật ký bạn muốn thực hiện khi khởi động chương trình.
• Không sử dụng bộ đệm trên tệp hoặc xả thường xuyên trong trường hợp xảy ra sự cố chương trình.

Chỉnh sửa: Tôi vừa nhận thấy câu hỏi được gắn thẻ bằng Python, vì vậy hãy xem câu trả lời của S. Lott trước tôi. Nó có thể là đủ cho nhu cầu của bạn.

Answer 2

Khá dễ chịu và đã được triển khai.

đọc này: http://docs.python.org/library/logging.html

---

Sửa

"dễ dàng để phân tích, đọc," nói chung là tính năng mâu thuẫn. Tiếng Anh - dễ đọc, khó phân tích. XML - dễ phân tích cú pháp, khó đọc. Không có định dạng nào đạt được dễ đọc và dễ phân tích cú pháp. Một số định dạng nhật ký "không khủng khiếp để đọc và không thể phân tích cú pháp".

Một số người tạo nhiều trình xử lý để một nhật ký có nhiều định dạng: một bản tóm tắt để mọi người đọc và phiên bản XML để phân tích cú pháp tự động.

Answer 3

Vì bạn đã gắn thẻ python câu hỏi của mình, tôi cũng giới thiệu bạn đến this question. Đối với nội dung, đề xuất của Brian là tốt. Tuy nhiên, hãy nhớ thêm tên chương trình nếu bạn đang sử dụng nhật ký dùng chung.

Điều quan trọng về logfile là "greppability". Cố gắng cung cấp tất cả thông tin của bạn trong một dòng, với các số nhận dạng chuỗi thích hợp là duy nhất (cũng trong cơ số) cho một điều kiện cụ thể. Đối với dấu thời gian, hãy sử dụng tiêu chuẩn ISO-8601 sắp xếp tốt.

Answer 4

timestamp tức DateTime YYYY/MM/DD: HH: mm: ss: ms tài Chủ đề ID hàm Tên nhắn/Thông báo lỗi/thành công tin nhắn/Chức năng vết

Có này ở định dạng XML và bạn sau đó có thể dễ dàng viết một trình phân tích cú pháp cho nó.

<log> 
    <logEntry DebugLevel="0|1|2|3|4|5...."> 
    <TimeStamp format="YYYY/MM/DD:HH:mm:ss:ms" value="2009/04/22:14:12:33:120" /> 
    <ThreadId value="" /> 
    <FunctionName value="" /> 
    <Message type="Error|Success|Failure|Status|Trace"> 
     Your message goes here 
    </Message> 
    </logEntry> 
</log> 

Answer 5

Ý tưởng hay là xem xét phần mềm phân tích nhật ký. Trừ khi bạn có kế hoạch để viết của riêng bạn, có thể bạn sẽ muốn khai thác một gói phân tích log hiện tại như Analog. Nếu đúng như vậy, có thể bạn sẽ muốn tạo một bản ghi đầu ra tương tự với các định dạng mà nó chấp nhận. Nó sẽ cho phép bạn tạo ra các biểu đồ và đồ thị đẹp mắt với nỗ lực tối thiểu!

Answer 6

Theo tôi, cách tiếp cận tốt nhất là sử dụng các thư viện ghi nhật ký hiện có chẳng hạn như log4j (or it's variations for other languages). Nó cho phép bạn kiểm soát cách thư của bạn được định dạng và bạn có thể thay đổi nó mà không bao giờ chạm vào mã của bạn. Nó tuân theo các phương pháp hay nhất, mạnh mẽ và được hàng triệu người dùng sử dụng. Tất nhiên, bạn có thể viết cho bạn khung đăng nhập riêng, nhưng đó sẽ là điều rất kỳ quặc để làm, trừ khi bạn cần một cái gì đó rất cụ thể. Trong bất kỳ trường hợp nào, hãy truy cập tài liệu của họ và xem cách các câu lệnh đăng nhập được trình bày ở đó.

Check-out log4py - Python chuyển phiên bản của log4j, tôi nghĩ rằng có một số triển khai cho Python ngoài kia ..

Answer 7

thư viện khai thác gỗ của Python là thread-an toàn cho chủ đề quá trình duy nhất.