Руководство по стилю сообщений журнала

Question

Я ищу руководство по стилю для регистрации сообщений:

Например:

• Что и когда
• Условные обозначения
• Стиль и форматирование
• читаемость

т.е. что делает хорошую / плохую строку сообщения журнала

Меня особенно интересует, что делает хорошую строку журнала - помимо ВРЕМЕНИ, СЕВЕРНОСТИ и КОМПОНЕНТА, так как я склонен использовать log4j, который дает мне эту информацию бесплатно.

Answer 1

Что бы вы ни решили, если это текстовый журнал, начинайте каждую строку с хорошей отметки времени, предпочтительно в формате ISO:

ГГГГ-ММ-ДДТЧЧ: ММ: СС.ммм

По всей вероятности, вы захотите использовать метку времени с кодом серьезности.

Некоторые хорошие рекомендации по ведению журнала можно найти здесь:

http://watchitlater.com/blog/2009/12/logging-guidelines/

и здесь

http://download.oracle.com/docs/cd/B32110_01/web.1013/b28952/logging.htm

Answer 2

Что касается конвенции, в течение нескольких лет я форматировал свои журналы как:

severity timestamp source message

, где severity - символы для:

(-) Info
(!) Warning
(*) Error

Например:

(-) 2010-10-13T18:53:42 foo: Starting up...
(!) 2010-10-13T18:54:11 foo: bar: Unable to lock file "quux", will try again in 4 seconds.
(-) 2010-10-13T18:56:13 foo: Loading plugin "baz"...
(*) 2010-10-13T18:57:39 foo: baz: Error 0xbaadbeef during RPC.
(-) 2010-10-13T18:58:04 foo: Shutting down...

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

Answer 3

Эффективное ведение журнала - это искусство, но есть несколько важных моментов, которые могут помочь:

• ID потока : корпоративные приложения часто выполняются в многопоточной среде,С помощью информации идентификатора потока вы можете отличить один запрос от другого.

• Идентификация вызывающего абонента : личность (или принципал) вызывающего абонента также является важной информацией.Поскольку разные пользователи имеют разные привилегии, их пути выполнения могут быть очень разными.Размещение идентификатора пользователя в сообщениях журнала может быть отличным подспорьем для защищенного приложения.

• Метка времени : Как правило, пользователи могут только приблизить время, когда возникла проблема.Без временной метки персоналу службы поддержки сложно определить проблему.

• Информация об исходном коде : сюда входят имя класса, имя метода и номер строки.

(Эти советы принятыиз этой статьи IBM о ведении журнала Java .)

Answer 4

Это действительно зависит от вашего приложения.Я могу черпать вдохновение из чего угодно в / var / log / *

Answer 5

10 заповедей ведения журнала - идеальное введение в мир ведения журнала.

Этот веб-сайт научит вас делать и не создавать собственные файлы журналов.