Руководство по системному администрированию компонента Сервис предоставления справочных данных (LNSE) в составе продукта Platform V Dictionaries (SDT)#

Введение#

Назначение документа#

Настоящий документ представляет руководство по системному администрированию компонента Сервис предоставления справочных данных (LNSE) продукта Platform V Dictionaries (SDT).

Основные понятия#

Основные термины и определения:

Термин	Определение
Компонент	Компонент Сервис предоставления справочных данных (LNSE) в составе продукта Platform V Dictionaries (SDT)
Платформа, Platform V	Набор продуктов Platform V, правообладателем которых является АО «СберТех». Перечень таких продуктов обозначен в документации на конкретный продукт
Продукт	Platform V Dictionaries (SDT), предназначенный для хранения мастер-данных, управления ими, а также распространения их конечным потребителям

Список аббревиатур и сокращений:

Аббревиатура/сокращение	Расшифровка
API	Application programming interface
HTTP	Hypertext Transfer Protocol
REST	Representational State Transfer
TTL	Time to live
НСИ	Нормативно-справочная информация

Сценарии администрирования#

Действия, выполняемые системным администратором при установке дистрибутива компонента LNSE, приведены в документе «Руководство по установке» в разделе «Установка».

Для обеспечения защищенного взаимодействия компонента LNSE по протоколу mTLS с иными компонентами Платформы в среде контейнеризации через Platform V Synapse Service Mesh (SSM) требуется обеспечить выпуск сертификата. Выбор средств для генерации сертификата осуществляет администратор стенда. Специфичных требований к средствам создания сертификатов не предъявляются.

Действия, выполняемые системным администратором при работе в административном интерфейсе компонента LNSE, приведены в документе «Руководство оператора» в разделе «Использование приложения оператором».

В сценарии администрирования компонента LNSE с использованием административного интерфейса входят следующие:

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

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

EFS_LOAD_NSI_BUSINESS_ADMIN — бизнес-администратор справочников — сотрудник бизнес-подразделения, управляющий внутренними справочниками;
EFS_APPLICATION_ADMIN — системный администратор справочников — сотрудник сопровождения, управляющий экземплярами справочников в рамках одного тенанта либо всеми экземплярами справочников;
EFS_LOAD_NSI_SUPPORT — системный администратор справочников платформенного сектора с правами только на чтение — сотрудник первой линии поддержки.

Резервное копирование данных компонента LNSE обеспечивается штатными средствами инфраструктуры, в которой разворачивается компонент LNSE, в соответствии с эксплуатационной документацией на аппаратные и программные средства, входящие в состав программно-технического комплекса, на котором размещается компонент LNSE.

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

Системному администратору рекомендуется регулярно отслеживать события системного журнала. Лог-файл компонента LNSE размешается в каталоге fluent-bit/etc/logs/log_%d{yyyy-MM-dd}_%i.json. Доступна возможность уменьшить степень важности логируемых событий, изменив значение параметра logger.local.level.

Системному администратору доступна возможность изменить настройки компонента LNSE. Перечень и рекомендованные значения настроек приведены в разделе «Настройки» настоящего документа. В случае указания некорректных значений параметров, те операции, для настройки которых была допущена неточность, будут завершаться с ошибками с описанием причины. При изменении настроек необходимо учитывать, что работа компонента LNSE тестировалась только при корректно настроенных параметрах.

События системного журнала#

В Компоненте реализован механизм логирования с использованием внешнего компонента журналирования. В качестве такого компонента рекомендуется использовать платформенный компонент Журналирование (LOGA) продукта Platform V Monitor (OPM).

Функциональность фиксации событий, порождаемых компонентом LNSE, обеспечивают внутренние инструменты LNSE.

В журналах событий содержится информация об ошибках, возникших в процессе работы приложения, отладочная информация, обращения к REST-сервису.

Журналы событий:

SYSTEM — системные события;
USER — действия пользователей в административном интерфейсе;
INTEGRATION — вызовы REST API компонента LNSE со стороны клиентских приложений или других компонентов Платформы, обращения к другим компонентам и внешними АС через асинхронное API (например, JMS).

Для журнала SYSTEM используются следующие приоритеты:

ERROR:
- любые ошибки вызова сервисов Платформы, кроме отправки метрик в компонент Прикладной мониторинг Unimon (MONA) продукта Platform V Monitor (OPM);
- любые ошибки интеграционных вызовов (call).
WARNING: ошибки отправки метрик в компонент Прикладной мониторинг Unimon (MONA) продукта Platform V Monitor (OPM).
INFO: сообщения о вызове и возврате из вызова интеграционного адаптера.
DEBUG:
- все входные и выходные параметры операций FG, CG, BS, DA сервисов;
- все входные и выходные параметры вызовов интеграционных адаптеров (DTO).

Фильтрация и публикация зарегистрированных событий осуществляется c использованием внешнего компонента журналирования.

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

локальный — сохранение в локальный лог-файл;
удаленный — отправка во внешний компонент.

При отсутствии интеграции журналируемые события записываются только в локальный лог-файл. Лог-файл компонента LNSE размещается в каталоге fluent-bit/etc/logs/log_%d{yyyy-MM-dd}_%i.json.

Основные события приоритета ERROR приведены в таблице:

Класс	Сообщение	Комментарий
DictionaryReadiness	HealthCheck error	Ошибка вызова HealthCheck
AuditProviderRestImpl	Ошибка валидации события аудита
AuditProviderRestImpl	Ошибка превышения квоты аудита
AuditProviderRestImpl	Ошибка транспорта/сервера
AuditProviderRestImpl	Неизвестная ошибка
AuditItemsTaskProcessor	Отложенная задача '{}' завершилась ошибкой
DictionaryApplication	Error	Ошибка старта приложения
DictionaryConverter	Broken fields for dictionary {}
MessageReceiverServiceImpl	Ошибка получения сообщения	Неудачная попытка получения сообщения о сбросе кэша
SyncStatusActuator	Не получилось обновить статусы объектов синхронизации	Неудачная попытка обновить статусы объектов, синхронизируемых со смежными блоками
NotifyMessageHandlerImpl	IntegrationException	Ошибка обработки запроса на синхронизацию объектов
SyncMessageHandlerImpl	IntegrationException	Ошибка обработки запроса на синхронизацию объектов
GetDistribDbVersionStep	Ошибка получения текущей версии дистрибутива БД
SyncDictionarySenderServiceImpl	Error replication for versionId '{}' to block '{}'	Ошибка репликации справочника на смежный блок
SyncVersionServiceImpl	Ошибка попытки репликации при активации версии	Ошибка репликации справочника на смежный блок
GetStatusStep	Synchronization error	Ошибка обработки запроса статуса версии справочника
ReplicatorTaskProcessor	Ошибка репликации {}, {}	Ошибка репликации справочника на смежный блок
ContextService	Не удалось добавить код справочника в контекст logger
LoadV8EndpointInterceptor	Error	Ошибка при обработке запроса на загрузку справочника
PeriodicExternalTask	Непредвиденная ошибка при выполнении периодической задачи {}
PeriodicExternalTask	Непредвиденная ошибка при установке времени исполнения периодической задачи {}
PeriodicExternalTask	Ошибка установки времени для периодической задачи {}
DbVersionsApiController	Ошибка получения версии дистрибутива БД
SynchronizationApiController	Synchronization status exception
EndpointInterceptor	Error	Ошибка при обработке запроса данных справочника
ServiceV8EndpointInterceptor	Error	Ошибка при обработке запроса данных справочника
ScheduledTaskServiceImpl	Задача заблокирована, отменить невозможно. id: {}
SchedulerController	Некорректный формат времени('{}') для задачи '{}
ProfilerData	PROFILER ERROR
InitEndpoint	Error	Ошибка при обработке запроса на загрузку справочника
ActivationTaskProcessor	Отложенная задача '{}' завершилась ошибкой	Ошибка при отложенной активации справочника

События мониторинга#

Контроль событий мониторинга осуществляется при помощи функциональности внешнего компонента мониторинга. В качестве такого компонента рекомендован платформенный компонент Прикладной мониторинг Unimon (MONA) продукта Platform V Monitor (OPM).

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

Название метрики	Точка мониторинга	Тип метрики	Название сервиса
`UFS_DICTIONARY_JDBC_GET_CONNECTION_FAIL`	Ошибка получения соединения с базой данных	Событие
`UFS_DICTIONARY_LOAD_2_0_ACTIVATION_STATUS_SUCC`	Успешное получение статуса активации версии	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_2_0_ACTIVATE_STRUCTURE_SUCC`	Успешная активация структуры	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_2_0_ACTIVATE_STRUCTURE_FAIL`	Ошибка активации структуры	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_2_0_ACTIVATION_STATUS_FAIL`	Не удалось получить статус активации версии	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_2_0_ACTIVATE_VERSION_FAIL`	Не удалось активировать версииверсию	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_2_0_ACTIVATE_VERSION_SUCC`	Успешная активация версии	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_2_0_ADD_ITEM_LIST_FAIL`	Не удалось добавить элементы	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_2_0_ADD_ITEM_LIST_SUCC`	Успешное добавление элементов	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_2_0_CREATE_VERSION_FAIL`	Не удалось создать версию	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_2_0_CREATE_VERSION_SUCC`	Успешное создание версии	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_2_0_OVERWRITE_VERSION_FAIL`	Не удалось перезаписать версию	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_2_0_OVERWRITE_VERSION_SUCC`	Успешная перезапись версии	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_2_0_SAVE_ITEM_LIST_FAIL`	Не удалось сохранить элементы	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_2_0_SAVE_ITEM_LIST_SUCC`	Успешное сохранение элементов	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_2_0_UPDATE_VERSION_FAIL`	Не удалось обновить версию	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_2_0_UPDATE_VERSION_SUCC`	Успешное обновление версии	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_2_0_PERMISSION_FAIL`	Ошибка. Запрещен доступ к справочнику на редактирование	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_2_0_DELETE_DICTIONARY_FAIL`	Не удалось удалить справочник	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_2_0_DELETE_DICTIONARY_SUCC`	Успешное удаление справочника	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_ACTIVATE_VERSION_SIZE`	Количество активированных версий	Метрика	data-dictionary-load
`UFS_DICTIONARY_LOAD_ADD_ITEM_LIST_SIZE`	Количество добавленных элементов	Метрика	data-dictionary-load
`UFS_DICTIONARY_LOAD_SAVE_ITEM_LIST_SIZE`	Количество сохраненных элементов	Метрика	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_CREATE_STRUCTURE_SUCC`	Успешное создание структуры(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_CREATE_STRUCTURE_FAIL`	Неуспешное создание структуры(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_DELETE_STRUCTURE_SUCC`	Успешное удаление структуры(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_DELETE_STRUCTURE_FAIL`	Неуспешное удаление структуры(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_ACTIVATE_STRUCTURE_SUCC`	Успешная активация структуры(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_ACTIVATE_STRUCTURE_FAIL`	Неуспешная активация структуры(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_EXIST_STRUCTURE_SUCC`	Успешная проверка на существование структуры(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_EXIST_STRUCTURE_FAIL`	Неуспешная проверка на существование структуры(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_CREATE_VERSION_SUCC`	Успешное создание версии(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_CREATE_VERSION_FAIL`	Неуспешное создание версии(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_DELETE_VERSION_SUCC`	Успешное удаление версии(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_DELETE_VERSION_FAIL`	Неуспешное удаление версии(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_ADD_ITEM_LIST_SUCC`	Успешное сохранение элементов(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_ADD_ITEM_LIST_FAIL`	Неуспешное сохранение элементов(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_MERGE_ITEMS_SUCC`	Успешное слияние элементов(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_MERGE_ITEMS_FAIL`	Неспешное слияние элементов(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_ACTIVATE_VERSION_SUCC`	Успешная активация версии(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_ACTIVATE_VERSION_FAIL`	Неуспешная активация версии(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_STATUS_VERSION_SUCC`	Успешное получение статуса версии(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_STATUS_VERSION_FAIL`	Неуспешное получение статуса версии(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_FIND_ITEMS_SUCC`	Успешный поиск элементов(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_FIND_ITEMS_FAIL`	Неуспешный поиск элементов(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_COUNT_ITEMS_SUCC`	Успешное получение элементов(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_COUNT_ITEMS_FAIL`	Неуспешное получение элементов(V8)	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_IMPORT_RUN_SUCC`	Успешный импорт архива	Событие	data-dictionary-load
`UFS_DICTIONARY_LOAD_V8_IMPORT_RUN_FAIL`	Неуспешный импорт архива	Событие	data-dictionary-load
`UFS_DICTIONARY_EXTENDED_AUDIT_FAIL`	Ошибка расширенного аудита	Событие	data-dictionary-load
`DICTIONARY_READ_REQUEST`	Обращение к определенному справочнику	Событие	data-dictionary-service
`UFS_DICTIONARY_PM_4_0_GET_COUNT_FAIL`	Не успешное получение количества элементов	Событие	data-dictionary-service
`UFS_DICTIONARY_PM_4_0_GET_COUNT_SUCC`	Успешное получение количества элементов	Событие	data-dictionary-service
`UFS_DICTIONARY_PM_4_0_GET_MAX_PAGE_SIZE_FAIL`	Не успешное получение максимального размера страницы	Событие	data-dictionary-service
`UFS_DICTIONARY_PM_4_0_GET_MAX_PAGE_SIZE_SUCC`	Успешное получение максимального размера страницы	Событие	data-dictionary-service
`UFS_DICTIONARY_PM_4_0_GET_ROW_FAIL`	Не успешное получение элемента	Событие	data-dictionary-service
`UFS_DICTIONARY_PM_4_0_GET_ROW_SUCC`	Успешное получение элемента	Событие	data-dictionary-service
`UFS_DICTIONARY_PM_4_0_GET_ROWS_FAIL`	Не успешное получение элементов	Событие	data-dictionary-service
`UFS_DICTIONARY_PM_4_0_GET_ROWS_SUCC`	Успешное получение элементов	Событие	data-dictionary-service
`UFS_DICTIONARY_PM_4_0_NOTIFY_SUCC`	Успешная отправка уведомления об ошибке бизнес-данных	Событие	data-dictionary-service
`UFS_DICTIONARY_PM_4_0_NOTIFY_FAIL`	Не успешная отправка уведомления об ошибке бизнес-данных	Событие	data-dictionary-service
`UFS_DICTIONARY_PM_4_0_PERMISSION_FAIL`	Ошибка. Запрещен доступ к справочнику на чтение	Событие	data-dictionary-service
`UFS_DICTIONARY_PM_GET_ROWS_RESULT_SIZE`	Количество возвращаемых элементов	Метрика	data-dictionary-service
`UFS_DICTIONARY_PM_4_0_GET_ROWS_TIME`	Время выполнения при получении элементов	Метрика	data-dictionary-service
`UFS_DICTIONARY_PM_4_0_GET_COUNT_TIME`	Время выполнения при получении количества элементов	Метрика	data-dictionary-service
`UFS_DICTIONARY_PM_4_0_GET_ROW_TIME`	Время выполнения при получении элемента	Метрика	data-dictionary-service
`UFS_DICTIONARY_PM_4_0_GET_MAX_PAGE_SIZE_TIME`	Время выполнения при получении максимального размера страницы	Метрика	data-dictionary-service
`UFS_DICTIONARY_PM_4_0_NOTIFY_TIME`	Время выполнения при обработке нотификации от клиента	Метрика	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_GET_ROWS_SUCCESS`	Успешное получение элементов (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_GET_ROWS_FAIL`	Не успешное получение элементов (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_GET_ROWS_TIME`	Время выполнения при получении элементов (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_GET_ROWS_FILTERED_SUCCESS`	Успешное получение элементов с фильтром (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_GET_ROWS_FILTERED_FAIL`	Не успешное получение элементов с фильтром (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_GET_ROWS_FILTERED_TIME`	Время выполнения при получении элементов с фильтром (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_GET_COUNT_SUCCESS`	Успешное получение количества элементов (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_GET_COUNT_FAIL`	Не успешное получение количества элементов (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_GET_COUNT_TIME`	Время выполнения при получении количества элементов (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_GET_COUNT_FILTERED_SUCCESS`	Успешное получение количества элементов с фильтром (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_GET_COUNT_FILTERED_FAIL`	Не успешное получение количества элементов с фильтром (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_GET_COUNT_FILTERED_TIME`	Время выполнения при получении количества элементов с фильтром (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_GET_METADATA_SUCCESS`	Успешное получение метаданных (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_GET_METADATA_FAIL`	Не успешное получение метаданных (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_GET_METADATA_TIME`	Время выполнения при получении метаданных (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_GET_ROWS_BY_KEYS_SUCCESS`	Успешное получение элементов по ключам (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_GET_ROWS_BY_KEYS_FAIL`	Не успешное получение элементов по ключам (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_GET_ROWS_BY_KEYS_TIME`	Время выполнения при получении элементов по ключам (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_GET_ROW_BY_KEY_SUCCESS`	Успешное получение элемента по ключу (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_GET_ROW_BY_KEY_FAIL`	Не успешное получение элемента по ключу (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_GET_ROW_BY_KEY_TIME`	Время выполнения при получении элемента по ключу (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_NOTIFY_SUCCESS`	Успешная отправка уведомления об ошибке бизнес-данных (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_NOTIFY_FAIL`	Не успешная отправка уведомления об ошибке бизнес-данных (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_NOTIFY_TIME`	Время выполнения при обработке уведомления об ошибке бизнес-данных (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_GET_ROWS_RESULT_SIZE`	Количество возвращаемых элементов (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_GET_ROWS_BY_KEY_RESULT_SIZE`	Количество возвращаемых элементов для запроса по ключу (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V8_PERMISSION_FAIL`	Ошибка. Запрещен доступ к справочнику на чтение (V8)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_GET_ROWS_SUCCESS`	Успешное получение элементов (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_GET_ROWS_FAIL`	Не успешное получение элементов (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_GET_ROWS_TIME`	Время выполнения при получении элементов (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_GET_ROWS_FILTERED_SUCCESS`	Успешное получение элементов с фильтром (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_GET_ROWS_FILTERED_FAIL`	Не успешное получение элементов с фильтром (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_GET_ROWS_FILTERED_TIME`	Время выполнения при получении элементов с фильтром (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_GET_COUNT_SUCCESS`	Успешное получение количества элементов (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_GET_COUNT_FAIL`	Не успешное получение количества элементов (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_GET_COUNT_TIME`	Время выполнения при получении количества элементов (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_GET_COUNT_FILTERED_SUCCESS`	Успешное получение количества элементов с фильтром (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_GET_COUNT_FILTERED_FAIL`	Не успешное получение количества элементов с фильтром (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_GET_COUNT_FILTERED_TIME`	Время выполнения при получении количества элементов с фильтром (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_GET_METADATA_SUCCESS`	Успешное получение метаданных (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_GET_METADATA_FAIL`	Не успешное получение метаданных (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_GET_METADATA_TIME`	Время выполнения при получении метаданных (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_GET_ROWS_BY_KEYS_SUCCESS`	Успешное получение элементов по ключам (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_GET_ROWS_BY_KEYS_FAIL`	Не успешное получение элементов по ключам (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_GET_ROWS_BY_KEYS_TIME`	Время выполнения при получении элементов по ключам (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_GET_ROW_BY_KEY_SUCCESS`	Успешное получение элемента по ключу (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_GET_ROW_BY_KEY_FAIL`	Не успешное получение элемента по ключу (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_GET_ROW_BY_KEY_TIME`	Время выполнения при получении элемента по ключу (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_NOTIFY_SUCCESS`	Успешная отправка уведомления об ошибке бизнес-данных (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_NOTIFY_FAIL`	Не успешная отправка уведомления об ошибке бизнес-данных (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_NOTIFY_TIME`	Время выполнения при обработке уведомления об ошибке бизнес-данных (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_GET_ROWS_RESULT_SIZE`	Количество возвращаемых элементов (V9)	Событие	data-dictionary-service
`UFS_DICTIONARY_SERVICE_V9_GET_ROWS_BY_KEY_RESULT_SIZE`	Количество возвращаемых элементов для запроса по ключу (V9)	Событие	data-dictionary-service

Настройки#

Настройки каждого из сервисов, входящих в состав компонента LNSE, задаются в отдельных yaml-файлах, которые размещаются в каталоге configmaps каждого из подов компонента LNSE. Название файлов с настройками формируется по шаблону, заданному в конфигурационных файлах data-dictionary-load.conf, data-dictionary-manage.conf, data-dictionary-service.conf (входят в состав дистрибутива компонента LNSE).

Если компонент LNSE не интегрирован с компонентом, обеспечивающим управление конфигурационными параметрами, то для изменения настроек необходимо внести соответствующие изменения yaml-файл. Для того, чтобы установленные пользователем значения параметров применились, требуется перезапуск пода.

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

Параметры для настройки компонента LNSE:

Параметр	Краткое описание	Тип	По умолчанию	Название сервиса
`ufs.dictionary.max.page.size`	Максимальное количество выдаваемых данных (строк) из справочника. Значение 0 позволяет проектам получать любое количество строк.	LONG	0	data-dictionary-service
`ufs.dictionary.upload.path`	Путь к временным файлам для загрузки	STRING	`/path/`	data-dictionary-load, data-dictionary-service, data-dictionary-manage
`ufs.dictionary.rest.apps.request.timeout`	Таймаут для HTTP запроса на rest-app’ы (в миллисекундах).	LONG	120000	data-dictionary-load, data-dictionary-service, data-dictionary-manage
`ufs.dictionary.rest.pipeline.request.timeout`	Таймаут для HTTP запроса на rest для пайплайна (в миллисекундах).	LONG	480000	data-dictionary-load
`ufs.baseurl.dictionary.service`	REST-клиент LNSE. URL до REST-API LNSE (без rootContext)	STRING	`http(s)://host:port`
`ufs.baseurl.dictionary.load`	Загрузчик LNSE. URL до REST-API LNSE (без rootContext)	STRING	`http(s)://host:port`
`ufs.dictionary.activation.to.version.save.batch.size`	Максимальный размер пачки при сохранении версий для активации	LONG	256	data-dictionary-load
`ufs.dictionary.activate.internal.enable`	Разрешение активации версий внутренних справочников	BOOLEAN	true	data-dictionary-load, data-dictionary-manage
`ufs.dictionary.activate.external.enable`	Разрешение активации версий внешних справочников	BOOLEAN	true	data-dictionary-load, data-dictionary-manage
`ufs.dictionary.audit.items.max.count`	Максимальный количество записей в активной или в активируемой версии справочника при котором возможна запись в аудит	LONG	1000	data-dictionary-load, data-dictionary-manage
`ufs.dictionary.audit.items.max.length`	Максимальный размер параметра аудита `ITEMS`	LONG	786432	data-dictionary-load, data-dictionary-manage
`ufs.dictionary.client.module.response.message.level`	Уровень логирования сообщений с bh на клиентских модулях	STRING	OFF	data-dictionary-load, data-dictionary-service
`ufs.dictionary.dynamic.create.enable`	Параметр включения динамического создания справочников	BOOLEAN	false	data-dictionary-load, data-dictionary-manage
`ufs.dictionary.dynamic.delete.enable`	Параметр включения динамического удаления справочников	BOOLEAN	false	data-dictionary-load, data-dictionary-manage
`ufs.dictionary.init.version.auto.activate.enable`	Включение авто-активации версии при загрузке через json	BOOLEAN	true	data-dictionary-load
`ufs.dictionary.item.save.batch.size`	Максимальный размер пачки при сохранении элемента справочника	LONG	256	data-dictionary-load, data-dictionary-manage
`ufs.dictionary.load.internal.activate.enable`	Разрешение активации версий внутренних справочников через REST API load	BOOLEAN	true	data-dictionary-load
`ufs.dictionary.load.rest.enable`	Параметр включения REST API load	BOOLEAN	true	data-dictionary-load
`ufs.dictionary.manage.default.export.part.size`	Количество строк в одной части при экспорте	LONG	100000	data-dictionary-manage
`ufs.dictionary.manage.business.administrator.readOnly`	Включение режима только чтение для бизнес-администратора	BOOLEAN	false	data-dictionary-manage
`ufs.dictionary.manage.system.administrator.readOnly`	Включение режима только чтение для системного администратора	BOOLEAN	true	data-dictionary-manage
`ufs.dictionary.permission.cache.ttl`	TTL кеша разрешений доступа к справочникам	LONG	300000	data-dictionary-load, data-dictionary-service
`ufs.dictionary.permission.cache.size`	Размер кеша разрешений доступа к справочникам	LONG	10240	data-dictionary-load, data-dictionary-service
`ufs.dictionary.permission.check.enable`	Включение проверки разрешений доступа при запросах к справочникам	BOOLEAN	true	data-dictionary-load, data-dictionary-service
`ufs.dictionary.pilot.activation.delay`	Величина, на которую будет отложена активация пилотных версий(миллисекунды)	LONG	1800000	data-dictionary-load
`ufs.dictionary.pilot.dictionaries`	Список пилотируемых справочников	STRING_LIST		data-dictionary-load, data-dictionary-manage
`ufs.dictionary.pilot.errors.limit`	Допустимый предел ошибок в пилотной версии	LONG	500	data-dictionary-load
`ufs.dictionary.profiler.duration.limit`	Порог срабатывания для вывода в лог (мс)	LONG	2000	data-dictionary-load, data-dictionary-service
`ufs.dictionary.profiler.enable`	Включение профилирования вызовов	BOOLEAN	true	data-dictionary-load, data-dictionary-service
`ufs.dictionary.pilot.zone`	Признак пилотной зоны	BOOLEAN	false	data-dictionary-load, data-dictionary-manage
`ufs.dictionary.replication.blocks`	Перечень блоков для репликации	STRING_LIST		data-dictionary-load, data-dictionary-manage
`ufs.dictionary.scheduled.cancel.max.work.timeout`	Время ожидания выполнения задачи до принудительного завершения (миллисекунды)	LONG	30000	data-dictionary-load
`ufs.dictionary.scheduled.external.task.activation.attempt.count`	Количество попыток отложенной активации	LONG	10	data-dictionary-load
`ufs.dictionary.scheduled.external.task.activation.retry.time`	Время следующей попытки отложенной активации (миллисекунды)	LONG	60000	data-dictionary-load
`ufs.dictionary.scheduled.external.task.max.work.timeout`	Максимальное время выполнения разовой задачи, после которого она будет считаться зависшей (миллисекунды)	LONG	300000	data-dictionary-load
`ufs.dictionary.scheduled.external.task.time`	Расписание проверки разовых заданий (cron/миллисекунды)	STRING	300000	data-dictionary-load
`ufs.dictionary.structure.max.count`	Максимальное количество структур для справочника	LONG	10	data-dictionary-load
`ufs.dictionary.structure.compatibility.check.enable`	Включение валидации импортируемой структуры справочника	BOOLEAN	true	data-dictionary-load
`ufs.dictionary.scheduled.task.pilot.errors.update.time`	Расписание обновления счетчиков ошибок в БД, для пилотных версий(миллисекунды)	STRING	300000	data-dictionary-service
`ufs.dictionary.scheduled.task.pilot.errors.check.time`	Расписание проверки превышения предела по количеству ошибок в пилотных версиях(миллисекунды)	STRING	600000	data-dictionary-load
`ufs.dictionary.scheduled.task.replicator.time`	Расписание репликации справочников (cron/миллисекунды)	STRING	3600000	data-dictionary-load
`ufs.dictionary.scheduled.task.sync.data.object.clear.time`	Расписание удаления устаревших данных об объектах синхронизации (cron/миллисекунды)	STRING	* * 3 * * ?	data-dictionary-load
`ufs.dictionary.scheduled.task.drop.table.attempt.count`	Количество попыток удаления таблиц	LONG	10	data-dictionary-load
`ufs.dictionary.scheduled.task.drop.table.retry.time`	Время следующей попытки аудита активации версии (мс)	LONG	86400000	data-dictionary-load
`ufs.dictionary.scheduled.task.drop.unused.partitions.time`	Расписание удаления неиспользуемых (cron/миллисекунды)	STRING	* * 3 * * ?	data-dictionary-load
`ufs.dictionary.scheduled.task.extendedAudit.attempt.count`	Количество попыток аудита активации версии	LONG	5	data-dictionary-load
`ufs.dictionary.scheduled.task.extendedAudit.retry.time`	Время следующей попытки аудита активации версии (мс)	LONG	300000	data-dictionary-load
`ufs.dictionary.scheduled.task.sync.data.object.status.time`	Расписание синхронизации статусов объектов (cron/миллисекунды)	STRING	0 3 * * * ?	data-dictionary-load
`ufs.dictionary.scheduled.task.update.meta.time`	Расписание обновления мета-данных справочников (cron/миллисекунды)	STRING	300000	data-dictionary-service
`ufs.dictionary.scheduled.task.update.profiler.settings`	Расписание обновления настроек профилировщика запросов(cron/миллисекунды)	STRING	300000	data-dictionary-load, data-dictionary-service
`ufs.dictionary.signature.version.check`	Нужна ли проверка подписи у запросов на наполнение	BOOLEAN	false	data-dictionary-load
`ufs.dictionary.signature.permission.check`	Нужна ли проверка подписи у запросов на изменение разрешений	BOOLEAN	true	data-dictionary-load
`ufs.dictionary.sync.get.item.put.size`	Максимальный размер пачки при поиске элемента по `dataId`	LONG	256	data-dictionary-load
`ufs.dictionary.zone.lists`	Перечень зон (используется в конфигурации получения информации о зонах через провайдер параметров)	STRING_LIST		data-dictionary-manage
`ufsdictionary.module.cache.select.maxsize`	Максимальное количество записей в кэше select	LONG	0	data-dictionary-manage
`ufsdictionary.module.dictionary.logging`	Включение логгирования запросов и ответов в разрезе справочника	BOOLEAN	true	data-dictionary-manage

Часто встречающиеся проблемы и пути их устранения#

Часто встречающиеся проблемы при установке дистрибутива компонента LNSE приведены в документе «Руководство по установке» в разделе «Часто встречающиеся проблемы и пути их устранения».

Часто встречающиеся проблемы при работе в административном интерфейсе приведены в документе «Руководство оператора» в разделе «Часто встречающиеся проблемы и пути их устранения».