Расширенное логирование запросов к источникам данных

Для добавления правила:

1. Убедитесь, что администратор обладает полномочием «Полные права» для варианта доступа «Доступ к разделу «Администрирование».

2. Нажмите кнопку «Добавить правило».

После выполнения действия будет открыто окно «Добавление дебаг правила логирования запросов к источникам данных»:

3. Задайте параметры:

• Правило активно. Установите флажок для активации правила и логирования запросов к источникам данных в подразделе «Системные логи»;

Важно. При активации правила увеличивается время обработки запроса и повышается потребление ресурсов сервера. Для снижения нагрузки на сервер учитывайте рекомендации.

• Срок активности правила. Укажите количество дней, часов и минут активности правила. По истечении указанного времени будет отключено правило и автоматически снят флажок «Правило активно». Отсчёт времени начинается с момента сохранения правила при его добавлении или редактировании. По умолчанию срок активности правила 10 минут. Максимальный срок активности правила 7 дней. Параметр является обязательным;

• Среда. Выберите в раскрывающемся списке среду, для которой будут логироваться запросы ко всем содержащимся в ней ресурсам. Среда доступна для выбора, если администратор обладает полномочием «Чтение дебаг логов», распространяющимся на все среды, конкретную среду или проект в среде. Для выбора доступна только одна среда. Параметр является обязательным.

Если предполагается расширенное логирование запросов ко всем ресурсам среды, то достаточно выбрать только среду в параметре «Среда» и не задавать параметры «Проект», «Источник данных», «Ресурсы»;

• Проект. Выберите в раскрывающемся списке проект, для которого будут логироваться запросы ко всем содержащимся в нём ресурсам. Проект доступен для выбора, если он содержится в среде, выбранной в параметре «Среда», и если администратор обладает полномочием «Чтение дебаг логов», распространяющимся на данный проект. Для выбора доступен только один проект.

Если предполагается расширенное логирование запросов ко всем ресурсам проекта, то достаточно выбрать среду в параметре «Среда», проект в параметре «Проект» и не задавать параметры «Источник данных», «Ресурсы»;

• Источник данных. Выберите в раскрывающемся списке источник данных, для которого будут логироваться запросы ко всем содержащимся в нём ресурсам. Источник данных доступен для выбора, если он содержится в проекте, выбранном в параметре «Проект». Для выбора доступен только один источник данных.

Если предполагается расширенное логирование запросов ко всем ресурсам источника данных, то достаточно выбрать среду в параметре «Среда», проект в параметре «Проект», источник данных в параметре «Источник данных» и не задавать параметр «Ресурсы»;

• Ресурсы. Выберите в раскрывающемся списке один или несколько ресурсов источника данных, запросы к которым будут логироваться. Ресурс доступен для выбора, если он содержится в источнике данных, выбранном в параметре «Источник данных»;

• Список пользователей API. Выберите в раскрывающемся списке одного или нескольких пользователей API, от которых будут логироваться запросы к ресурсам источника данных. Параметр является обязательным.

Примечание. Выбранные пользователи API могут использоваться в рамках одного правила, а также должны обладать правами доступа на запрос данных хотя бы одного ресурса, выбранного в параметре «Ресурсы». Если ресурсы не выбраны, то доступ должен быть хотя бы к одному ресурсу источника данных, выбранного в параметре «Источник данных», проекта, выбранного в параметре «Проект», или среды, выбранной в параметре «Среда».

4. Нажмите кнопку «Сохранить».

После выполнения действий правило будет добавлено в список правил. При установленном флажке «Правило активно» будет вестись расширенное логирование событий типа «Запрос RPC API», «Запрос Web-сервиса», «Запрос JSON ресурса» со статусом «Дебаг» в подразделе «Системные логи» с учётом заданных параметров правила.

Для редактирования правила:

1. Убедитесь, что администратор обладает полномочиями:

• «Полные права» для варианта доступа «Доступ к разделу «Администрирование»;

• «Чтение дебаг логов» для одного из вариантов доступа:

• Доступ к разделу «Среды». Доступно редактирование любого правила;

• Доступ к среде. Доступно редактирование правила, в котором задана соответствующая среда;

• Доступ к проекту. Доступно редактирование правила, в котором задан соответствующий проект или среда, содержащая данный проект.

2. Нажмите кнопку «Изменить», расположенную напротив правила.

После выполнения действия будет открыто окно «Редактирование дебаг правила логирования запросов к источникам данных»:

3. Измените параметры, заданные при добавлении правила.

4. Нажмите кнопку «Сохранить».

После выполнения действий правило будет отредактировано и обновлено в списке правил.

Для отключения всех правил:

1. Убедитесь, что администратор обладает полномочием «Полные права» для варианта доступа «Доступ к разделу «Администрирование».

2. Нажмите кнопку «Отключить все правила».

После выполнения действий будут отключены все правила и не будет вестись расширенное логирование событий типа «Запрос RPC API», «Запрос Web-сервиса», «Запрос JSON ресурса» со статусом «Дебаг» в подразделе «Системные логи». При отключении правил флажок «Правило активно» автоматически снимается для каждого правила.

Также правило автоматически отключается, если выполняется одно из условий:

• удалена среда, выбранная в параметре «Среда». При удалении среды все параметры правила сбрасываются;

• удалён проект, выбранный в параметре «Проект». При удалении проекта сбрасываются параметры «Проект», «Источник данных», «Ресурсы», «Пользователи API»;

• удалён источник данных, выбранный в параметре «Источник данных». При удалении источника данных сбрасываются параметры «Источник данных», «Ресурсы»;

• удалены ресурсы, выбранные в параметре «Ресурсы». При удалении всех ресурсов сбрасывается параметр «Ресурсы», при удалении одного или нескольких ресурсов обновляется список ресурсов;

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

Для удаления правила:

1. Убедитесь, что администратор обладает полномочиями:

• «Полные права» для варианта доступа «Доступ к разделу «Администрирование»;

• «Чтение дебаг логов» для одного из вариантов доступа:

• Доступ к разделу «Среды». Доступно удаление любого правила;

• Доступ к среде. Доступно удаление правила, в котором задана соответствующая среда;

• Доступ к проекту. Доступно удаление правила, в котором задан соответствующий проект или среда, содержащая данный проект.

2. Нажмите кнопку «Удалить», расположенную напротив правила.

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