Что писать в файл журнала?

Вот несколько предложений по содержанию:

• отметка времени
• сообщение
• тип сообщения журнала (например, ошибка, предупреждение, трассировка, отладка)
• идентификатор потока (чтобы вы могли понять файл журнала из многопоточного приложения)

Рекомендации по внедрению:

• Поместите мьютекс вокруг метода записи, чтобы вы могли быть уверены, что каждая запись потокобезопасна и имеет смысл.
• Отправлять по одному сообщению в файл журнала и каждый раз указывать тип сообщения журнала. Затем вы можете указать, какой тип ведения журнала будет выполняться при запуске программы.
• Не используйте буферизацию для файла или часто выполняйте сброс в случае сбоя программы.

Изменить: я только что заметил, что вопрос был помечен тегом Python, поэтому, пожалуйста, ознакомьтесь с ответом С. Лотта перед моим. Может хватить для ваших нужд.

Довольно приятно, и уже реализовано.

Прочтите это: http://docs.python.org/library/logging.html

Изменить

«легко разбирать, читать» - вообще противоречивые черты. Английский - легко читать, сложно разбираться. XML - легко анализировать, трудно читать. Не существует формата, который обеспечивает легкость чтения и анализа. Некоторые форматы журналов «не страшны для чтения и не невозможны для анализа».

Некоторые люди создают несколько обработчиков, чтобы один журнал имел несколько форматов: сводку для чтения и версию XML для автоматического анализа.

Поскольку вы пометили свой вопрос как python, я отсылаю вас к этому вопросу как Что ж. Что касается содержания, предложение Брайана хорошее. Однако не забудьте добавить имя программы, если вы используете общий журнал.

Важной особенностью файла журнала является возможность его совместимости. Постарайтесь предоставить всю свою информацию в одной строке с правильными строковыми идентификаторами, которые уникальны (также в системе счисления) для определенного условия. Что касается метки времени, используйте стандарт ISO-8601, который хорошо сортирует.

Хорошая идея - взглянуть на программное обеспечение для анализа журналов. Если вы не планируете писать свой собственный, вы, вероятно, захотите использовать существующий пакет анализа журналов, такой как Analog. Если это так, вы, вероятно, захотите сгенерировать вывод журнала, достаточно похожий на форматы, которые он принимает. Это позволит вам создавать красивые диаграммы и графики с минимальными усилиями!

На мой взгляд, лучший подход - использовать существующие библиотеки журналов, такие как log4j (или его варианты для других языков) . Это дает вам контроль над форматированием ваших сообщений, и вы можете изменить его, даже не касаясь своего кода. Он следует передовым практикам, надежен и используется миллионами пользователей. Конечно, вы можете написать свою собственную структуру ведения журнала, но это было бы очень странно, если вам не нужно что-то очень конкретное. В любом случае просмотрите их документацию и посмотрите, как там представлены операторы журнала.

Посмотрите log4py - версия log4j, перенесенная на Python, я думаю, что есть несколько реализаций для Python.

Библиотека ведения журналов Python является поточно-ориентированной для однопроцессных потоков.

timeStamp, то есть DateTime ГГГГ / ММ / ДД: ЧЧ: мм: сс: мс Идентификатор потока пользователя Название функции Сообщение / Сообщение об ошибке / Сообщение об успешном завершении / Отслеживание функции

Имейте это в формате XML, и вы можете легко написать для него синтаксический анализатор.

<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>