Для управления ведением журнала IBM® FileNet Workplace XT использует продукт Apache log4j. При ведении журнала информация об операциях приложения передается на консоль или записывается в файлы. Сотрудники службы поддержки и разработчики используют информацию в записях журнала для анализа того, как функционирует приложение, а также для диагностики и устранения ошибок. Журнал ведется только для диагностических целей и не обеспечивает ни защиту, ни запись информации для аудита.
Продукт log4j устанавливается при установке Workplace XT. По умолчанию, ведение журнала при установке не включается.
Чтобы включить или выключить ведение журнала:
Сконфигурируйте параметры ведения журнала
В примере файла log4j.properties содержится набор опций по умолчанию, заданных в виде пар ключевое_слово=значение. Чтобы изменить значения по умолчанию, откройте файл log4j.properties при помощи текстового редактора, внесите нужные изменения, и сохраните файл. Параметры ведения журнала можно сконфигурировать в любой момент после установки. Изменения, внесенные вами в файл конфигурации ведения журнала, распознаются автоматически; перезапускать приложение или сервер приложений не требуется.
В следующих разделах представлена информация о некоторых опциях конфигурации журнала, которые вы увидите в этом файле. Более подробную информацию об опциях ведения журнала смотрите на веб-сайте Apache (http://apache.org) в разделе Logging Project (Проект функции ведения журнала), и на веб-сайте, посвященном функциям ведения журналов Apache (http://logging.apache.org/log4j/).
Средство записи в журнал
Функция ведения журнала записывает требования внесения записей в журнал в функции присоединения. Корневая функция ведения журнала описана в первом ключевом слове файла log4j.properties. Корневая функция ведения журнала находится на высшем уровне иерархии функций ведения журнала и задает глобальные параметры по умолчанию; все дочерние функции ведения журнала, для которых не заданы опции явным образом, наследуют параметры от корневой функции ведения журнала.
Функция присоединения
Вы можете указать, куда следует направлять данные, сконфигурировав функцию присоединения. Возможные типы пунктов назначения - файл или консоль; выходную информацию можно перенаправить в журнал событий Windows, переадресовать на удаленный сервер log4j и т.д. (Информацию о всех возможных пунктах назначения и форматирования смотрите в документации по Apache log4j.) У одной функции ведения журнала может быть более одной функции присоединения. Например, выходная информация может одновременно направляться на консоль и записываться в файл. Увеличение числа пунктов назначения может отрицательно сказаться на производительности работы системы.
В Workplace XT, по умолчанию, сконфигурированы две функции присоединения. Одна функция присоединения записывает данные в формате IBM Common Base Event (CBE), который используется утилитами IBM Support Assistant для обработки журнала, а другая функция записывает данные в более понятном пользователю формате. Последнюю из них можно изменить, уменьшив объем выходной информации, или можно ее полностью выключить.
Уровень
Заданный вами уровень ведения журнала определяет тип и объем собираемой информации. Существует прямая корреляция между объемом собранной информации и снижением производительности в системе.
Журнал приложения Workplace XT поддерживает стандартные уровни записи в журнал (INFO, WARN, ERROR и FATAL - ИНФОРМ, ПРЕДУПР, ОШИБКА и НИСПРАВ, соответственно), а также уровни ALL и OFF (ВСЕ и ВЫКЛ, соответственно). В приведенной ниже таблице кратко описаны стандартные уровни; более подробную информацию об уровнях смотрите в документации Apache log4j.
Уровень | Описание |
---|---|
ИНФОРМ | Указывает, что следует записывать информационные сообщения, описывающие ход работы приложения, на неетализированном уровне. |
ПРЕДУПР | Указывает, что следует записывать сообщения о потенциально опасных ситуациях. |
ОШИБКА | Указывает, что следует записывать исключительные ситуации, сгенерированные в приложении. |
НЕИСПРАВ | Указывает, что следует записывать в журнал только самые серьезные события, которые, предположительно, приведут к неудачному завершению работы приложения. |
Заданный вами уровень определяет объем собираемой информации. Существует прямая корреляция между объемом собранной информации и снижением производительности в системе.
Формат выходного файла
При конфигурировании функции присоединения можно ввести ключевое слово, чтобы задать формат для записи данных. Можно выбрать PatternLayout и ConversionPattern. PatternLayout задает определенный шаблон записей журнала, а ConversionPattern задает шаблон элементов, передаваемых функции присоединения. Рассмотрим следующий пример:
log4j.appender.ErrorOutputFile=org.apache.log4j.RollingFileAppender log4j.appender.ErrorOutputFile.layout=org.apache.log4j.PatternLayout log4j.appender.ErrorOutputFile.layout.ConversionPattern=%d [%t] - %-5p %m\r\n
Будет получена следующая сформатированная запись журнала:
2007-05-31 17:36:12:801 [cwrap] - Document/Checkin ConnectionWrapper.send send.before
Более подробную информацию об опциях форматирования смотрите в документации по Apache log4j.
Анализ выходной информации
Сотрудники службы поддержки могут, изучая записи в файле журнала, анализировать работу приложения и диагностировать ошибки, возникающие в приложении. Использование утилит IBM Support Assistant (ISA) позволяет автоматизировать фазу анализа. Утилиты ISA обрабатывают записи CBE в выходной информации журнала от log4j.
Также можно использовать утилиты типа Apache Chainsaw (это программа просмотра журнала с графическим пользовательским интерфейсом), чтобы самостоятельно анализировать записи журнала не являющиеся записями CBE.