Журнал регистрации 1С

1. Журнал регистрации предназначен для хранения событий, возникающих в процессе работы пользователей с информационной базой. При администрировании эту информацию часто необходимо анализировать в различных разрезах для того, чтобы например, узнать какие события происходили в определенный момент времени, какие действия выполнял тот или иной пользователь.

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

2.1. Строковый идентификатор типа события. Как правило, список типов событий в конфигурации может быть сколь угодно большим, поэтому типы событий рекомендуется группировать по функциональному признаку: «Название группы событий.Название события». Например, правильно записывать события с типами

«Поручения.Уведомление о новых задачах»
«Поручения.Уведомление о зависших задачах»

вместо двух «плоских» типов событий:

«Уведомление о новых задачах»
«Уведомление о зависших задачах»

Тип события предназначен для отбора однотипных записей из журнала регистрации, поэтому неправильно включать в него любую избыточную информацию – конкретные значения из информационной базы или внешних систем. Например, неправильно:

Не удалось отменить проведение документа <Реализация КП00-00002 от 11>
В информационной базе не найден сотрудник Найденова, банковская карта 3333

Правильно помещать метаданные в параметр Метаданные, а данные – в параметр Данные метода ЗаписьЖурналаРегистрации, и использовать более общие типы событий:

Проведение документов.Не удалось отменить проведение
Сотрудники.В информационной базе не найден сотрудник

Текст типа события – локализуем, при этом всегда задается основной язык конфигурации.

2.2. Уровень важности события. Критичные события, требующие повышенного внимания администратора (ошибки бизнес-логики, сбои в программе, и т.п.), записываются в журнал регистрации с уровнем важности «Ошибка». Потенциальные проблемы и не фатальные ошибки регистрируются как «Предупреждения». Для вывода информационных сообщений об успешном завершении той или иной операции используется уровень важности «Информация». Также возможно применять и более низкий уровень важности – «Примечание».

2.3. Комментарий. Содержит текстовую неструктурированную информацию о событии. В случае ошибок в этом поле содержится информация, необходимая для расследования причины проблемы. Не следует помещать в комментарий информацию сразу о нескольких событиях. Например, неправильно записывать одно событие с комментарием вида:

[01.01.2010 00:00:01] Начало инициализации обмена данными по настройке «Обмен данными выгрузка», номер строки настройки: 1
[01.01.2010 00:00:02] Окончание инициализации обмена данными (успешно)
[01.01.2010 00:00:03] Начало процесса обмена данными по настройке «Обмен данными выгрузка», номер строки настройки: 1
[01.01.2010 00:00:04] Начало записи изменений в файл обмена
[01.01.2010 00:00:05] Окончание записи изменений в файл обмена (успешно)
[01.01.2010 00:00:06] Окончание процесса обмена данными по настройке «Обмен данными выгрузка», номер строки настройки: 1
[01.01.2010 00:00:07] Выполнено, Выгрузка данных, Обработано 1 объектов

правильно записать столько событий, сколько их реально произошло.

Также не следует помещать в комментарии текстовые данные, размер которых заранее не известен и может быть сколько угодно большим. Например, содержимое файлов, ответов веб-сервисов и т.п. Следует ориентироваться на максимум 10 Кб.

Текст комментария – локализуем. Для записи в журнал регистрации информации о возникшем исключении следует использовать конструкцию:

ОбработкаОшибок.ПодробноеПредставлениеОшибки(ИнформацияОбОшибке())

Пример регистрации дополнительных событий в функциональной подсистеме «Мой механизм»:

Попытка 
 ЗаписьЖурналаРегистрации(НСтр("ru = 'Мой механизм.Действие с возможной ошибкой'", КодОсновногоЯзыка),
  УровеньЖурналаРегистрации.Информация, , ,
  НСтр("ru = 'Начато действие'"));
 ДействиеСВозможнойОшибкой(ОбъектДействия);
 ЗаписьЖурналаРегистрации(НСтр("ru = 'Мой механизм.Действие с возможной ошибкой'", КодОсновногоЯзыка),
  УровеньЖурналаРегистрации.Информация, , ,
  НСтр("ru = 'Завершено действие'");
Исключение
 ЗаписьЖурналаРегистрации(НСтр("ru = 'Мой механизм.Действие с возможной ошибкой'", КодОсновногоЯзыка),
  УровеньЖурналаРегистрации.Ошибка, , ,
  НСтр("ru = '"Во время выполнения действия произошла неизвестная ошибка.'") + Символы.ПС +
  ОбработкаОшибок.ПодробноеПредставлениеОшибки(ИнформацияОбОшибке());
 КонецПопытки;  
КонецПроцедуры

где переменная КодОсновногоЯзыка содержит код языка для хранения данных в информационной базе. Подробнее см. Автогенерированные данные в информационной базе: требования по локализации, п. 1.

3. Не следует использовать выборку из журнала регистрации в тех задачах, где критична высокая скорость выполнения выборки. Поскольку при больших объемах журнала регистрации скорость выборки падает пропорционально увеличению его объема.

Рекомендуется заводить отдельный регистр для протоколирования интересующих событий или обращаться к специализированным объектам платформы (например, МенеджерФоновыхЗаданий для выборки истории выполнения фоновых заданий).

Эту особенность нужно также учитывать при разработке отчетов по журналу регистрации.

Пользовательский режим

Открыть журнал регистрации можно по соответствующей команде раздела Администрирование — Обслуживание.

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

	— Ошибка;
	— Предупреждение;
	— Информация;
	— Информация по недоступным полям;
	— Примечание.

Каждое событие фиксируется в отдельной строке журнала.

В списке выводится:

Дата, время — помимо даты и времени проставляется значок, отображающий вид события;
Пользователь — полное имя пользователя;
Компьютер — сетевое имя компьютера;
Приложение — например, Тонкий клиент;
Сеанс — номер сеанса;
Событие — тип события;
Данные, Комментарий — указание объекта программы: указывается конкретный элемент списка, документ и т.п.; в комментарии — краткое описание события;
Метаданные — тип объекта программы и его наименование: список, вид документа и т.п.

Для того чтобы настроить количество, видимость и взаимное расположение колонок журнала регистрации, нажмите Еще — Изменить форму.

Сохранение журнала регистрации на компьютер

Нажмите Выгрузить в файл, укажите путь для сохранения журнала на компьютер. Журнал сохраняется в виде файла XML, просмотреть его можно, например, в программе MS Excel.

Обновление списка событий

Список событий не является динамическим списком. Для того чтобы увидеть события, которые попали в журнал регистрации после его открытия, нажмите Обновить текущий список или клавишу F5.

Количество событий

Журнал отображает фиксированное количество записей, которое указывается в поле Показывать (По умолчанию равно 200). Кроме предопределенных значений (200, 500, 1000 и 10000 событий) можно ввести произвольное количество событий, которое будет сохранено.

Отборы

С помощью отборов можно отфильтровать события в журнале регистрации.

В поле быстрого отбора Критичность выберите значения Ошибки или Предупреждения, для того чтобы увидеть определенные виды событий. По умолчанию в журнале показаны Все события.
Для быстрой установки периода просмотра событий журнала нажмите Интервал. Также к установке интервалов дат можно перейти с помощью двойного щелчка по содержимому колонки Дата, Время.
Выделите данные в одной из колонок журнала, нажмите Установить отбор по значению в текущей колонке. Будут отобраны события журнала, содержащие эти данные. Также можно найти эту команду в контекстном меню по правой кнопке мыши.
Для того чтобы отобрать события по одному или нескольким критериям, нажмите Установить отбор. Также можно пройти по ссылке в поле Отбор. Если заданы какие-либо отборы (в том числе и быстрые), ссылка принимает значение критериев отбора, если никаких отборов не установлено, то принимает значение Не установлен. Производится установка фильтров отбора:
- В поле Интервал выберите период, укажите Начало и Окончание периода;
- В списке Важность с помощью флажков выберите один или несколько видов событий(Ошибка, Предупреждение, Информация, Примечание), по которым нужно произвести отбор. По умолчанию установлены все флажки;
- В поле События выберите значения из списка с помощью флажков (по умолчанию установлены все флажки);
- В поле Пользователи выберите значения из списка с помощью флажков (в этом списке указываются только пользователи, отраженные в журнале регистрации. По умолчанию флажки сняты);
- В поле Приложения выберите значения из списка с помощью флажков (Конфигуратор, Тонкий клиент, Фоновое задание. По умолчанию флажки сняты);
- В поле Компьютеры выберите нужные значения из списка с помощью флажков (по умолчанию флажки сняты);
- В поле Сеансы перечислите через «;» нужные номера сеансов;
- В группе полей Данные можно выбрать для поиска один из видов отбора:
  - В поле Метаданные выберите нужные значения из списка (список упорядочен по типу данных) для отбора с помощью флажков: выберите нужное наименование списка, документа и т.д. например, «справочник Классификатор банков РФ»;
  - В поле Данные можно произвести выбор элементов для поиска из списков программы:
    - выберите Тип данных, например, «Банк»;
    - Из соответствующего списка программы, например, «Классификатора банков РФ», выберите конкретный объект программы, например, «Сбербанк»;
- в поле Представление данных наберите данные для поиска вручную или скопируйте из списка;
- В группе полей Транзакция выберите из списка с помощью флажков Статус транзакции (Нет транзакции, Зафиксирована, Не завершена, Отменена). По умолчанию установлены все флажки. Также возможен отбор по полю Идентификатор транзакции.
- В группе полей Прочее можно выбрать с помощью флажков для отбора Рабочие серверы, Основные IP-порты, Вспомогательные IP-порты, также можно провести отбор по полю Комментарий.
После указания полей для отбора нажмите ОК. После этого события будут отобраны и ссылка примет вид перечисления критериев отбора.
Отображаются записи, удовлетворяющие заданным критериям отбора в количестве, не большем, чем значение поля Показывать.
Для того чтобы отключить все отборы (в том числе и быстрые), нажмите Отключить отбор или выполните команду Еще — Отключить отбор. Эту команду также можно найти в контекстном меню по правой кнопке мыши.

Просмотр события

Для просмотра детальной информации о событии выделите его в списке, нажмите Открыть. Можно найти эту команду в контекстном меню по правой кнопке мыши.
Также можно просмотреть событие с помощью двойного щелчка мыши по нужной строке.

Просмотр объекта программы

Если с событием связан некоторый объект программы, то этот объект можно открыть для просмотра.

Выделите нужные данные в колонке Данные, Комментарий соответствующего события и нажмите Открыть данные для просмотра. Также можно найти эту команду в контекстном меню по правой кнопке мыши.
Открыть данные для просмотра можно также двойным щелчком мыши по содержимому колонки Данные, Комментарий.

Руководство администратора