Руководство по системному администрированию#

Введение#

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

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

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

Обозначения, сокращения, термины и определения приведены в перечне Термины и определения.

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

Важно

В LNSE c конфигурацией развертывания в окружении продукта Platform V Frontend Std (#FS) эксплуатация функциональности динамического создания и удаления версий структуры справочников не предполагается и должна быть отключена: параметры ufs.dictionary.dynamic.create.enable и ufs.dictionary.dynamic.delete.enable должны быть установлены в false.

Важно

В LNSE c конфигурацией развертывания в окружении продукта Platform V Frontend Std (#FS) эксплуатация функциональности обмена с CLOB/CBUL не предполагается и должна быть отключена: параметр lnse.cbul.exchange.enable должен быть установлен в false.

Примечание

Доступность редактирования справочников бизнес-администраторами регулируется параметром ufs.dictionary.manage.business.administrator.readOnly.
Доступность редактирования справочников системными администраторами регулируется параметром ufs.dictionary.manage.system.administrator.readOnly.

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

События системного журнала просматриваются через LOGA или через локальный лог контейнера LNSE в среде контейнеризации.

Для просмотра событий системного журнала LNSE:

  1. Перейдите в объединенный web-интерфейс продукта Platform V Monitor (OPM).

  2. Пройдите по пути Журналы → Оперативные журналы.

  3. В поле Источник выберите topic Kafka, в который публикуются события системного журнала LNSE. Имя topic можно определить через ConfigMap ufs-extensions.ulogger-config.unver в разделе [OUTPUT]–Topics.

  4. Настройте требуемые фильтры событий системного журнала.

Результат:

На экране web-интерфейса OPM отображены искомые события системного журнала LNSE.

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

  1. Авторизуйтесь в консоли среды контейнеризации.

  2. В главном меню перейдите в раздел Workloads → Pods, выберите namespace LNSE и далее выберите нужный pod.

  3. Перейдите на вкладку Logs, укажите нужный контейнер.

Результат:

В консоли отображены искомые события системного журнала LNSE.

Отслеживание событий мониторинга#

События мониторинга LNSE просматриваются через MONA.

Для просмотра событий мониторинга LNSE:

  1. Перейдите в объединенный web-интерфейс продукта Platform V Monitor (OPM).

  2. Пройдите по пути Dashboards → Manage → MONA-<наименование стенда>-Metrics.

  3. Выберите тенант.

  4. Выберите namespace.

  5. Выберите в списке приложений сервис LNSE.

  6. При необходимости выберите конкретную метрику.

Результат:

  1. Отобразился список метрик LNSE.

  2. При выборе конкретной метрики отобразилось значение этой метрики LNSE.

Работа в АРМ Администратора LNSE#

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

В сценарии администрирования LNSE с использованием АРМ входят следующие:

  • управление структурой справочников;

  • управление версиями данных и данными внутренних справочников;

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

  • управление синхронизацией внутренних справочников;

  • управление маршрутизацией справочников;

  • управление разрешениями для доступа к справочникам;

  • управление служебными задачами.

Резервное копирование данных#

Примечание

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

LNSE поддерживает партиционное хранение версий данных справочников. При включенном партиционировании каждая версия данных справочника создается в отдельной секции (partition). При создании резервной копии таблиц БД LNSE с использованием утилиты pg_dump необходимо дополнительно выгрузить системный каталог pg_autopartition в файл. Для последующей корректной загрузки данных в каталог pg_catalog.pg_autopartition необходимо наличие таблиц БД LNSE в каталоге pg_class, так как поле rel каталога pg_autopartition должно содержать oid каждой таблицы.

Создание резервной копии#

Для создания резервной копии данных выполните следующие действия:

  1. Сделайте резервную копию БД LNSE с использованием штатных средств инфраструктуры развертывания LNSE.

  2. Вручную выгрузите системный каталог pg_autopartition в файл:

COPY (
  SELECT
    n.nspname,
    c.relname,
    a.modulus,
    a.seq,
    a.offsets,
    a.periods,
    a.childspec
  FROM       pg_catalog.pg_autopartition a
  INNER JOIN pg_catalog.pg_class         c ON a.rel = c.oid
  INNER JOIN pg_catalog.pg_namespace     n ON c.relnamespace = n.oid
) TO '/tmp/ap_catalog.sql' WITH (FORMAT csv);

\! echo "\." >> /tmp/ap_catalog.sql

Результат:

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

Восстановление данных из резервной копии#

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

  1. Создайте временную таблицу и импортируйте из файла tmp/ap_catalog.sql выгруженную ранее конфигурацию автопартиционирования:

CREATE TEMPORARY TABLE temp_autopartition(
    nspname   TEXT,
    relname   TEXT,
    modulus   INTEGER,
    seq       INTEGER,
    offsets   TEXT,
    periods   TEXT,
    childspec TEXT
);
 
COPY temp_autopartition FROM '/tmp/ap_catalog.sql' WITH (FORMAT csv);

  1. Импортируйте данные из временной таблицы в каталог pg_catalog.pg_autopartition и удалите временную таблицу:

INSERT INTO pg_catalog.pg_autopartition(rel,modulus,seq,offsets,periods,childspec) (
    SELECT
        c.oid,
        t.modulus,
        t.seq,
        t.offsets,
        t.periods,
        t.childspec
    FROM temp_autopartition t
    LEFT JOIN pg_catalog.pg_namespace n ON n.nspname = t.nspname
    LEFT JOIN pg_catalog.pg_class     c ON c.relname = t.relname AND c.relnamespace = n.oid
);
 
DROP TABLE temp_autopartition;

  1. Проверьте корректность данных сравнением результатов запросов в исходной и целевой БД:

select * from pg_autopartition;
select oid, relname from pg_class where oid in (select rel from pg_autopartition);

Настройка параметров в CFGA#

  1. Перейдите в web-интерфейс компонента CFGA.

  2. В разделе Фильтры по параметрам:

    1. Выберите ключ конфигурации:

      • DATA-DICTIONARY-SERVICE;

      • DATA-DICTIONARY-LOAD;

      • DATA-DICTIONARY-MANAGE.

    2. Нажмите кнопку Поиск.

  3. В полученном списке параметров LNSE выберите требуемый параметр и нажмите кнопку Редактировать.

  4. Отредактируйте и сохраните новое значение параметра.

Результат:

В web-интерфейсе CFGA появились новые значения отредактированных параметров.

Контроль наличия подключения к Kafka#

В LNSE реализован периодический контроль (healthcheck) подключения к Kafka. Если в рамках проверки не удается отправить сообщение в topic Kafka, то функциональностью LNSE предусматривается пересоздание producers, отправляющих сообщения в Kafka. Если сообщение отправлено, но прочитать его не удается, то LNSE пересоздает сonsumers, получающие сообщения из Kafka.

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

  1. Перейдите в UI сервиса CFGA.

  2. Выберите тенант.

  3. Выберите один или несколько ключей конфигурации LNSE для настройки параметров

    • DATA-DICTIONARY-SERVICE;

    • DATA-DICTIONARY-LOAD;

    • DATA-DICTIONARY-MANAGE.

  4. Установите периодичность проверки подключения к Kafka в параметре ufs.dictionary.scheduled.task.kafka.healthcheck.time.

Результат:

Периодичность контроля подключения к Kafka настроена.

Graceful shutdown#

Справка

Graceful shutdown — предсказуемое окончание работы приложений, когда все запущенные процессы корректно завершают работу без потери данных или негативного пользовательского опыта.

Для поддержки graceful shutdown в прикладных приложениях LNSE и шлюзах Egress и Ingress в манифестах \data-dictionary-*\dc.yaml, \istio\deployments\ingress\ingress-dc.yaml, \istio\deployments\egress\egress-dc.yaml определен параметр terminationGracePeriodSeconds, устанавливающий время принудительного завершения всех процессов pod после начала его остановки.

При определении terminationGracePeriodSeconds используются параметры, значения которых устанавливаются в конфигурационных файлах LNSE data-dictionary-*.conf, dictionary.istio.all.conf:

Файл дистрибутива LNSE

Параметр дистрибутива LNSE

Описание параметра

data-dictionary-service.conf

dictionary.ose.deployment.spec.template.spec.terminationGracePeriodSeconds

terminationGracePeriod для приложения data-dictionary-service, в секундах. Рекомендованное значение — {{ lookup('custom_vars', 'global.ufs.terminationGracePeriodSeconds') }}

data-dictionary-load.conf

dictionary.ose.deployment.spec.template.spec.terminationGracePeriodSeconds

terminationGracePeriod для приложения data-dictionary-load, в секундах. Рекомендованное значение — {{ lookup('custom_vars', 'global.ufs.terminationGracePeriodSeconds') }}

data-dictionary-manage.conf

dictionary.ose.deployment.spec.template.spec.terminationGracePeriodSeconds

terminationGracePeriod для приложения data-dictionary-manage. Рекомендованное значение — {{ lookup('custom_vars', 'global.ufs.terminationGracePeriodSeconds') }}

dictionary.istio.all.conf

lnse.ose.istio.egress.deployment.spec.template.spec.terminationGracePeriodSeconds

terminationGracePeriod для шлюза Egress, в секундах. Рекомендованное значение — ${global.ufs.terminationGracePeriodSeconds}

dictionary.istio.all.conf

lnse.ose.istio.ingress.deployment.spec.template.spec.terminationGracePeriodSeconds

terminationGracePeriod для шлюза Ingress, в секундах. Рекомендованное значение — ${global.ufs.terminationGracePeriodSeconds}

dictionary.all.conf

lnse.shutdown.timeout

shutdownTimeout для сервиса LNSE. Рекомендованное значение — {{ lookup('custom_vars', 'global.ufs.terminationGracePeriodSeconds') }}
Пример части dc.yaml data-dictionary-service
spec:
  ...
  template:
    ...
    spec:
      terminationGracePeriodSeconds: {{ lookup('custom_vars', 'dictionary.ose.deployment.spec.template.spec.terminationGracePeriodSeconds') }}
Пример части dc-egress.yaml
spec:
  ...
  template:
    ...
    spec:
      terminationGracePeriodSeconds: {{lookup('custom_vars','lnse.ose.istio.egress.deployment.spec.template.spec.terminationGracePeriodSeconds')}}

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

В LNSE реализован механизм логирования с использованием внешнего компонента журналирования, например, LOGA. Допускается использование LOGE. Интеграция с LOGE опциональна и используется на усмотрение пользователя компонента LNSE.

Для интеграции LNSE с компонентом журналирования используется клиентский модуль LOGM и sidecar-приложение fluent-bit-sidecar.

В зависимости от настроек LOGM отфильтровывает или публикует события, фиксируемые прикладными приложениями LNSE, в локальные лог-файлы или удаленный компонент журналирования, используя topic Kafka. LOGM подключается в JAVA-приложение LNSE как maven-зависимость.

Fluent-bit-sidecar вычитывает события из лог-файлов, формируемых LOGM, sidecar-приложениями, шлюзами ingress gateway и egress gateway, и передает их в один или несколько удаленных компонентов журналирования для дальнейшей обработки, используя topic Kafka.

Примечание

Fluent-bit-sidecar не входит в поставку LNSE. Добавление файлов настроек и манифестов, необходимых для развертывания в namespace LNSE fluent-bit-sidecar, обеспечивает расширение (extension).

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

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

  • SYSTEM — системные события;

  • USER — действия пользователей в АРМ Администратора LNSE;

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

События журнала SYSTEM записываются на разных уровнях логирования (ERROR, WARN, INFO, DEBUG, TRACE) в зависимости от события. Запись событий функционирования системы на уровне DEBUG и TRACE не рекомендуется включать в промышленной эксплуатации.

События журналов USER и INTEGRATION не приоритизируются.

Уровень логирования прикладных приложений LNSE средствами LOGM настраивается во внешнем компоненте журналирования:

Параметр

Описание

logger.local.level

Регулирует уровень логирования для локального канала

logger.remote.level

Регулирует уровень логирования для удаленного канала

logger.name.level

Настраивает уровень логирования в разрезе класса/пакета, влияет как на удаленный, так и на локальный канал записи

Примечание

Отправка средствами LOGM событий в удаленный компонент журналирования по умолчанию не используется.

По умолчанию события журналирования регистрируются с уровнем ERROR или INFO.

Уровень логирования sidecar-приложений, шлюзов ingress gateway и egress gateway устанавливается в файлах дистрибутива конфигурации развертывания LNSE:

Параметр

Описание

lnse.ose.deployment.spec.template.metadata.annotations.vault.hashicorp.com.log-level

Регулирует уровень логирования для sidecar vault-agent

lnse.ose.deployment.spec.template.metadata.annotations.vault.hashicorp.com.log-destination-loge-log-level

lnse.ose.deployment.spec.template.metadata.annotations.vault.hashicorp.com.log-destination-stdout-log-level

lnse.ose.istio.envoy.logging-level

Регулирует уровень логирования для Ingress Gateway, Egress Gateway

lnse.ose.istio.pilot-agent.logging-level

ott-sidecar-ufs.ose.istio.logging-level

Регулирует уровень логирования для ott-sidecar

Указанные параметры переопределяются с помощью переменных, значения которых устанавливаются в файлах репозитория Common:

Параметр

Описание

global.platform.annotations.hashicorp.log-destination-loge-log-level

Регулирует уровень логирования для sidecar vault-agent

global.platform.istio.envoy.logging-level

Регулирует уровень логирования для Ingress Gateway, Egress Gateway

global.platform.istio.ott.logging-level

Регулирует уровень логирования для ott-sidecar

Расположение журнала событий настраивается во внешнем компоненте журналирования. Подробности настройки приведены в документации к LOGА/LOGE.

Лог-файл прикладных приложений LNSE размещается в каталоге, заданном в параметре logger.local.filePath. По умолчанию используется каталог logs.

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

Класс

Сообщение

Комментарий

DictionaryReadiness

HealthCheck error

Ошибка вызова HealthCheck

AuditProviderRestImpl

Ошибка валидации события аудита

Ошибка аудита

AuditProviderRestImpl

Ошибка превышения квоты аудита

Ошибка аудита

AuditProviderRestImpl

Ошибка транспорта/сервера

Ошибка аудита

AuditProviderRestImpl

Неизвестная ошибка

Ошибка аудита

AuditItemsTaskProcessor

Отложенная задача „{}“ завершилась ошибкой

Ошибка аудита

DictionaryApplication

Error

Ошибка старта приложения

DictionaryConverter

Broken fields for dictionary {dictionary_code}

Ошибка загрузки данных справочника

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

Ошибка при обработке запроса данных справочника

SchedulerController

Некорректный формат времени(„{}“) для задачи „{}

Ошибка при обработке асинхронных заданий

InitEndpoint

Error

Ошибка при обработке запроса на загрузку справочника

ActivationTaskProcessor

Отложенная задача „{}“ завершилась ошибкой

Ошибка при отложенной активации справочника

Примечание

В случае недоступности удаленного компонента журналирования LNSE продолжает свою работу штатно. Недоступность логируется в локальный журнал.

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

Контроль событий мониторинга осуществляется при помощи внешнего компонента мониторинга, например, MONA. Допускается использование MONE. Интеграция с MONE опциональна и используется на усмотрение пользователя LNSE.

Для интеграции с MONE используется клиентский модуль MONM, который публикует события и метрики мониторинга, используя topic Kafka. Параметры интеграции с MONE задаются в конфигурационном файле \conf\config\parameters\dictionary.all.conf дистрибутива LNSE.

Для интеграции с MONA используется клиентский модуль MONM и клиентские приложения MONA:

  • Unimon-agent — для сбора метрик;

  • Unimon-sender — для отправки метрик в хранилище.

MONM агрегирует зафиксированные LNSE события в метрики мониторинга в формате, используемом в MONA, и реализует программный интерфейс для сбора метрик. В процессе передачи метрик биллинга MONM не участвует.

Сбор метрик и публикацию их в хранилище обеспечивают клиентские приложения MONA. Рекомендуется размещать их в namespace каждого из интегрированных с MONA компонентов. При отправке метрик в хранилище клиентские приложения MONA используют topic Kafka.

Примечание

Клиентские приложения MONA не входят в поставку LNSE. Добавление файлов настроек и манифестов, необходимых для развертывания в namespace LNSE pods с клиентскими приложениями MONA обеспечивает расширение (extension).

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

Основные метрики мониторинга LNSE:

Название метрики

Точка мониторинга

Тип метрики

Название сервиса

Описание точки вызова

UFS_DICTIONARY_PM_4_0_GET_ROWS_SUCC

Успешное получение строк справочника

Событие

data-dictionary-service

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-service/rest/pm/ver.4.0/getRows с корректными значениями параметров

UFS_DICTIONARY_PM_GET_ROWS_RESULT_SIZE

Количество возвращаемых строк справочника

Метрика

data-dictionary-service

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-service/rest/pm/ver.4.0/getRows с корректными значениями параметров

UFS_DICTIONARY_PM_4_0_GET_ROWS_FAIL

Неуспешное получение строк справочника

Событие

data-dictionary-service

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-service/rest/pm/ver.4.0/getRows с некорректными значениями параметров, например, с указанием в теле запроса кода несуществующего справочника и/или кода подсистемы, для которой запрещен доступ к справочнику (при условии, что параметр ufs.dictionary.permission.check.enable установлен в true)

UFS_DICTIONARY_PM_4_0_GET_ROWS_TIME

Время выполнения запроса при получении строк справочника

Метрика

data-dictionary-service

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-service/rest/pm/ver.4.0/getRows

UFS_DICTIONARY_PM_4_0_GET_ROW_SUCC

Успешное получение строки справочника

Событие

data-dictionary-service

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-service/rest/pm/ver.4.0/getRow с корректными значениями параметров

UFS_DICTIONARY_PM_4_0_GET_ROW_FAIL

Неуспешное получение строки справочника

Событие

data-dictionary-service

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-service/rest/pm/ver.4.0/getRow с некорректными значениями параметров, например, с указанием в теле запроса кода несуществующего справочника и/или кода подсистемы, для которой запрещен доступ к справочнику (при условии, что параметр ufs.dictionary.permission.check.enable установлен в true)

UFS_DICTIONARY_PM_4_0_GET_ROW_TIME

Время выполнения запроса при получении строки справочника

Метрика

data-dictionary-service

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-service/rest/pm/ver.4.0/getRow

UFS_DICTIONARY_PM_4_0_GET_COUNT_SUCC

Успешное получение количества строк справочника

Событие

data-dictionary-service

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-service/rest/pm/ver.4.0/getCount с корректными значениями параметров

UFS_DICTIONARY_PM_4_0_GET_COUNT_FAIL

Неуспешное получение количества строк справочника

Событие

data-dictionary-service

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-service/rest/pm/ver.4.0/getCount с некорректными значениями параметров, например, с указанием в теле запроса кода несуществующего справочника и/или кода подсистемы, для которой запрещен доступ к справочнику (при условии, что параметр ufs.dictionary.permission.check.enable установлен в true)

UFS_DICTIONARY_PM_4_0_GET_COUNT_TIME

Время выполнения запроса при получении количества строк справочника

Метрика

data-dictionary-service

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-service/rest/pm/ver.4.0/getCount

UFS_DICTIONARY_PM_4_0_GET_MAX_PAGE_SIZE_SUCC

Успешное получение максимального размера страницы

Событие

data-dictionary-service

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-service/rest/pm/ver.4.0/getMaxPageSize с корректными значениями параметров

UFS_DICTIONARY_PM_4_0_GET_MAX_PAGE_SIZE_FAIL

Неуспешное получение максимального размера страницы

Событие

data-dictionary-service

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-service/rest/pm/ver.4.0/getMaxPageSize с некорректными значениями параметров, например, с указанием в теле запроса кода несуществующего справочника

UFS_DICTIONARY_PM_4_0_GET_MAX_PAGE_SIZE_TIME

Время выполнения запроса при получении максимального размера страницы

Метрика

data-dictionary-service

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-service/rest/pm/ver.4.0/getMaxPageSize

UFS_DICTIONARY_PM_4_0_GET_METADATA

Успешное получение метаданных справочника

Событие

data-dictionary-service

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-service/rest/pm/ver.4.0/getMetadata с корректными значениями параметров

UFS_DICTIONARY_PM_4_0_GET_METADATA_FAIL

Неуспешное получение метаданных справочника

Событие

data-dictionary-service

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-service/rest/pm/ver.4.0/getMetadata с некорректными значениями параметров, например, с указанием в теле запроса кода несуществующего справочника

UFS_DICTIONARY_PM_4_0_GET_METADATA_TIME

Время выполнения запроса при получении метаданных справочника

Метрика

data-dictionary-service

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-service/rest/pm/ver.4.0/getMetadata

UFS_DICTIONARY_PM_4_0_PERMISSION_FAIL

Запрещен доступ к справочнику на чтение

Событие

data-dictionary-service

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-service/rest/pm/ver.4.0/getRows; http(s)://host:port/data-dictionary-service/rest/pm/ver.4.0/getRow; http(s)://host:port/data-dictionary-service/rest/pm/ver.4.0/getCount с указанием в теле запроса кода подсистемы, для которой запрещен доступ к справочнику (при условии, что параметр ufs.dictionary.permission.check.enable установлен в true)

UFS_DICTIONARY_SERVICE_V9_GET_ROWS_SUCCESS

Успешное получение элементов (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary}/rows с корректными значениями параметров

UFS_DICTIONARY_SERVICE_V9_GET_ROWS_FAIL

Неуспешное получение элементов (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary}/rows с некорректными значениями параметров

UFS_DICTIONARY_SERVICE_V9_GET_ROWS_TIME

Время выполнения при получении элементов (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary}/rows

UFS_DICTIONARY_SERVICE_V9_GET_ROWS_FILTERED_SUCCESS

Успешное получение элементов с фильтром (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary}/rows:filter с корректными значениями параметров

UFS_DICTIONARY_SERVICE_V9_GET_ROWS_FILTERED_FAIL

Неуспешное получение элементов с фильтром (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary}/rows:filter с некорректными значениями параметров

UFS_DICTIONARY_SERVICE_V9_GET_ROWS_FILTERED_TIME

Время выполнения при получении элементов с фильтром (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary}/rows:filter

UFS_DICTIONARY_SERVICE_V9_GET_COUNT_SUCCESS

Успешное получение количества элементов (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary}/rows:count с корректными значениями параметров

UFS_DICTIONARY_SERVICE_V9_GET_COUNT_FAIL

Неуспешное получение количества элементов (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary}/rows:count с некорректными значениями параметров

UFS_DICTIONARY_SERVICE_V9_GET_COUNT_TIME

Время выполнения при получении количества элементов (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary}/rows:count

UFS_DICTIONARY_SERVICE_V9_GET_COUNT_FILTERED_SUCCESS

Успешное получение количества элементов с фильтром (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary}/rows:count с корректными значениями параметров

UFS_DICTIONARY_SERVICE_V9_GET_COUNT_FILTERED_FAIL

Неуспешное получение количества элементов с фильтром (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary}/rows:count с некорректными значениями параметров

UFS_DICTIONARY_SERVICE_V9_GET_COUNT_FILTERED_TIME

Время выполнения при получении количества элементов с фильтром (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary}/rows:count

UFS_DICTIONARY_SERVICE_V9_GET_METADATA_SUCCESS

Успешное получение метаданных (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary} с корректными значениями параметров

UFS_DICTIONARY_SERVICE_V9_GET_METADATA_FAIL

Неуспешное получение метаданных (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary} с некорректными значениями параметров

UFS_DICTIONARY_SERVICE_V9_GET_METADATA_TIME

Время выполнения при получении метаданных (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary}

UFS_DICTIONARY_SERVICE_V9_GET_ROWS_BY_KEYS_SUCCESS

Успешное получение элементов по ключам (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary}/rows:byKeys с корректными значениями параметров

UFS_DICTIONARY_SERVICE_V9_GET_ROWS_BY_KEYS_FAIL

Неуспешное получение элементов по ключам (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary}/rows:byKeys с некорректными значениями параметров

UFS_DICTIONARY_SERVICE_V9_GET_ROWS_BY_KEYS_TIME

Время выполнения при получении элементов по ключам (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary}/rows:byKeys

UFS_DICTIONARY_SERVICE_V9_GET_ROW_BY_KEY_SUCCESS

Успешное получение элемента по ключу (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary}/row/{keyValue} с корректными значениями параметров

UFS_DICTIONARY_SERVICE_V9_GET_ROW_BY_KEY_FAIL

Неуспешное получение элемента по ключу (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary}/row/{keyValue} с некорректными значениями параметров

UFS_DICTIONARY_SERVICE_V9_GET_ROW_BY_KEY_TIME

Время выполнения при получении элемента по ключу (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary}/row/{keyValue}

UFS_DICTIONARY_SERVICE_V9_GET_ROWS_RESULT_SIZE

Количество возвращаемых элементов (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary}/rows

UFS_DICTIONARY_SERVICE_V9_GET_ROWS_BY_KEY_RESULT_SIZE

Количество возвращаемых элементов для запроса по ключу (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary}/rows:byKeys

UFS_DICTIONARY_SERVICE_V9_PERMISSION_FAIL

Запрещен доступ к справочнику на чтение (V9)

Событие

data-dictionary-service

Успешный HTTP-запрос http(s)://host:port/data-dictionary-service/v9/rn/{resourceName}/dictionary/{dictionary}/* с указанием в заголовке запроса кода подсистемы, для которой запрещен доступ к справочнику (при условии, что параметр ufs.dictionary.permission.check.enable установлен в true)

UFS_DICTIONARY_LOAD_V8_CREATE_STRUCTURE_SUCC

Успешное создание структуры (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/structureVersions с корректными значениями параметров

UFS_DICTIONARY_LOAD_V8_CREATE_STRUCTURE_FAIL

Неуспешное создание структуры (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/structureVersions с некорректными значениями параметров

UFS_DICTIONARY_LOAD_V8_DELETE_STRUCTURE_SUCC

Успешное удаление структуры (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос DELETE http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}/structureVersion/{structure} с корректными значениями параметров

UFS_DICTIONARY_LOAD_V8_DELETE_STRUCTURE_FAIL

Неуспешное удаление структуры (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос DELETE http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}/structureVersion/{structure} с некорректными значениями параметров

UFS_DICTIONARY_LOAD_V8_ACTIVATE_STRUCTURE_SUCC

Успешная активация структуры (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/structureVersions:activate с корректными значениями параметров

UFS_DICTIONARY_LOAD_V8_ACTIVATE_STRUCTURE_FAIL

Неуспешная активация структуры (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/structureVersions:activate с некорректными значениями параметров

UFS_DICTIONARY_LOAD_V8_EXIST_STRUCTURE_SUCC

Успешная проверка на существование структуры (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}/structureVersion/{structure}

UFS_DICTIONARY_LOAD_V8_EXIST_STRUCTURE_FAIL

Неуспешная проверка на существование структуры (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}/structureVersion/{structure}

UFS_DICTIONARY_LOAD_V8_CREATE_VERSION_SUCC

Успешное создание версии (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}/structureVersion/{structure}/dataVersion

UFS_DICTIONARY_LOAD_V8_CREATE_VERSION_FAIL

Неуспешное создание версии (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}/structureVersion/{structure}/dataVersion

UFS_DICTIONARY_LOAD_V8_DELETE_VERSION_SUCC

Успешное удаление версии (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос DELETE http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}/structureVersion/{structure}/dataVersion/{version}

UFS_DICTIONARY_LOAD_V8_DELETE_VERSION_FAIL

Неуспешное удаление версии (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос DELETE http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}/structureVersion/{structure}/dataVersion/{version}

UFS_DICTIONARY_LOAD_V8_ADD_ITEM_LIST_SUCC

Успешное сохранение элементов (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}/structureVersion/{structure}/dataVersion/{version}/items

UFS_DICTIONARY_LOAD_V8_ADD_ITEM_LIST_FAIL

Неуспешное сохранение элементов (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}/structureVersion/{structure}/dataVersion/{version}/items

UFS_DICTIONARY_LOAD_V8_MERGE_ITEMS_SUCC

Успешное слияние элементов (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос PUT http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}/structureVersion/{structure}/dataVersion/{version}/items

UFS_DICTIONARY_LOAD_V8_MERGE_ITEMS_FAIL

Неуспешное слияние элементов (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос PUT http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}/structureVersion/{structure}/dataVersion/{version}/items

UFS_DICTIONARY_LOAD_V8_ACTIVATE_VERSION_SUCC

Успешная активация версии (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dataVersions:activate

UFS_DICTIONARY_LOAD_V8_ACTIVATE_VERSION_FAIL

Неуспешная активация версии (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dataVersions:activate

UFS_DICTIONARY_LOAD_V8_STATUS_VERSION_SUCC

Успешное получение статуса версии (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}/structureVersion/{structure}/dataVersion/{version}

UFS_DICTIONARY_LOAD_V8_STATUS_VERSION_FAIL

Неуспешное получение статуса версии (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}/structureVersion/{structure}/dataVersion/{version}

UFS_DICTIONARY_LOAD_V8_FIND_ITEMS_SUCC

Успешный поиск элементов (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}/structureVersion/{structure}/dataVersion/{version}/items:find

UFS_DICTIONARY_LOAD_V8_FIND_ITEMS_FAIL

Неуспешный поиск элементов (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}/structureVersion/{structure}/dataVersion/{version}/items:find

UFS_DICTIONARY_LOAD_V8_COUNT_ITEMS_SUCC

Успешное получение количества элементов (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}/structureVersion/{structure}/dataVersion/{version}/items:count

UFS_DICTIONARY_LOAD_V8_COUNT_ITEMS_FAIL

Неуспешное получение количества элементов (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}/structureVersion/{structure}/dataVersion/{version}/items:count

UFS_DICTIONARY_LOAD_V8_DICTIONARY_METADATA_SUCC

Успешное получение метаданных справочника (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}

UFS_DICTIONARY_LOAD_V8_DICTIONARY_METADATA_FAIL

Неуспешное получение метаданных справочника (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}

UFS_DICTIONARY_LOAD_V8_DICTIONARY_STRUCTURES_SUCC

Успешное получение списка структур (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}/structures

UFS_DICTIONARY_LOAD_V8_DICTIONARY_STRUCTURES_FAIL

Неуспешное получение списка структур (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}/structures

UFS_DICTIONARY_LOAD_V8_DICTIONARY_DELETE_SUCC

Успешное удаление справочника (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос DELETE http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}

UFS_DICTIONARY_LOAD_V8_DICTIONARY_DELETE_FAIL

Неуспешное удаление справочника (V8)

Событие

data-dictionary-load

Успешный HTTP-запрос DELETE http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}

UFS_DICTIONARY_LOAD_V8_PERMISSION_FAIL

Запрещен доступ к справочнику на редактирование

Событие

data-dictionary-load

Успешный HTTP-запрос http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/* с указанием в заголовке запроса кода подсистемы, для которой запрещен доступ к справочнику (при условии, что параметр ufs.dictionary.permission.check.enable установлен в true)

UFS_DICTIONARY_LOAD_V8_DICTIONARY_VERSIONS_SUCC

Успешное получение списка версий

Событие

data-dictionary-load

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}/structureVersion/{structure}/versions с корректными значениями параметров

UFS_DICTIONARY_LOAD_V8_DICTIONARY_VERSIONS_FAIL

Неуспешное получение списка версий

Событие

data-dictionary-load

Успешный HTTP-запрос GET http(s)://host:port/data-dictionary-load/v8/rn/{resourceName}/dictionary/{dictionary}/structureVersion/{structure}/versions с некорректными значениями параметров

UFS_DICTIONARY_LOAD_2_0_ACTIVATE_STRUCTURE_SUCC

Успешная активация структуры

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/structure/activate с корректными значениями параметров

UFS_DICTIONARY_LOAD_2_0_ACTIVATE_STRUCTURE_FAIL

Ошибка активации структуры

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/structure/activate с некорректными значениями параметров

UFS_DICTIONARY_LOAD_2_0_DELETE_DICTIONARY_SUCC

Успешное удаление справочника

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/dictionary/delete с корректными значениями параметров

UFS_DICTIONARY_LOAD_2_0_DELETE_DICTIONARY_FAIL

Не удалось удалить справочник

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/dictionary/delete с некорректными значениями параметров

UFS_DICTIONARY_LOAD_2_0_CREATE_VERSION_SUCC

Успешное создание версии данных справочника

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/version/save с корректными значениями параметров

UFS_DICTIONARY_LOAD_2_0_CREATE_VERSION_FAIL

Неуспешное создание версии данных справочника

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/version/save с некорректными значениями параметров, например, с указанием в теле запроса кода уже существующей версии данных справочника

UFS_DICTIONARY_LOAD_2_0_UPDATE_VERSION_SUCC

Успешное обновление версии данных справочника

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/version/save с корректными значениями параметров; в теле запроса, в том числе, должны быть указаны идентификатор и код существующей неактивной версии данных справочника

UFS_DICTIONARY_LOAD_2_0_UPDATE_VERSION_FAIL

Неуспешное обновление версии данных справочника

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/version/save с некорректными значениями параметров, например, без указания в теле запроса значения для параметра «Наименование версии данных»

UFS_DICTIONARY_LOAD_2_0_ADD_ITEM_LIST_SUCC

Успешное добавление строк в версию данных справочника

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/item/addList с корректными значениями параметров

UFS_DICTIONARY_LOAD_ADD_ITEM_LIST_SIZE

Количество добавленных строк в версию данных справочника

Метрика

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/item/addList с корректными значениями параметров

UFS_DICTIONARY_LOAD_2_0_ADD_ITEM_LIST_FAIL

Неуспешное добавление строк в версию данных справочника

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/item/addList с некорректными значениями параметров, например, с указанием в теле запроса кода уже существующей строки версии данных справочника

UFS_DICTIONARY_LOAD_2_0_SAVE_ITEM_LIST_SUCC

Успешное сохранение строк версии данных справочника

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/item/saveList с корректными значениями параметров

UFS_DICTIONARY_LOAD_SAVE_ITEM_LIST_SIZE

Количество сохраненных строк версии данных справочника

Метрика

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/item/saveList с корректными значениями параметров

UFS_DICTIONARY_LOAD_2_0_SAVE_ITEM_LIST_FAIL

Неуспешное сохранение строк версии данных справочника

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/item/saveList с некорректными значениями параметров, например, без указания в теле запроса значения для параметра «Код версии данных»

UFS_DICTIONARY_LOAD_2_0_OVERWRITE_VERSION_SUCC

Успешная перезапись версии данных справочника

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/version/overwrite с корректными значениями параметров

UFS_DICTIONARY_LOAD_2_0_OVERWRITE_VERSION_FAIL

Неуспешная перезапись версии данных справочника

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/version/overwrite с некорректными значениями параметров, например, с указанием в теле запроса кода несуществующей версии данных справочника

UFS_DICTIONARY_LOAD_2_0_ACTIVATE_VERSION_SUCC

Успешная активация версий данных справочников

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/version/activate с корректными значениями параметров

UFS_DICTIONARY_LOAD_ACTIVATE_VERSION_SIZE

Количество активированных версий данных справочников

Метрика

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/version/activate с корректными значениями параметров

UFS_DICTIONARY_LOAD_2_0_ACTIVATE_VERSION_FAIL

Неуспешная активация версий данных справочников

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/version/activate с некорректными значениями параметров, например, с указанием в теле запроса кода несуществующей версии данных справочника

UFS_DICTIONARY_LOAD_2_0_ACTIVATION_STATUS_SUCC

Успешное получение статуса активации версии

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/activation/status с корректными значениями параметров

UFS_DICTIONARY_LOAD_2_0_ACTIVATION_STATUS_FAIL

Не удалось получить статус активации версии

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/activation/status с некорректными значениями параметров

UFS_DICTIONARY_LOAD_2_0_PERMISSION_FAIL

Запрещен доступ к справочнику на редактирование

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/version/save; http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/item/addList; http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/item/saveList; http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/version/overwrite; http(s)://host:port/data-dictionary-load/rest/load/ver.2.0/version/activate; с указанием в теле запроса кода подсистемы, для которой запрещен доступ к справочнику (при условии, что параметр ufs.dictionary.permission.check.enable установлен в true)

UFS_DICTIONARY_INIT_SAVE_SUCC

Успешный импорт данных

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/init/saveVersion с корректными значениями параметров

UFS_DICTIONARY_INIT_SAVE_FAIL

Неуспешный импорт данных

Событие

data-dictionary-load

Успешный HTTP-запрос POST http(s)://host:port/data-dictionary-load/rest/init/saveVersion с некорректными значениями параметров

UFS_DICTIONARY_JDBC_GET_CONNECTION_FAIL

Ошибка получения соединения с базой данных

Событие

Все

Возникновение ошибки при обращении приложений компонента LNSE к БД

UFS_DICTIONARY_EXTENDED_AUDIT_FAIL

Ошибка расширенного аудита

Событие

data-dictionary-load

Возникновение ошибки при публикации события аудита успешной первичной активации средствами АРМ Администратора LNSE версии данных локального справочника, для которого при регистрации установлен признак расширенного аудита. При активации ранее активированной версии данных метрика не отбрасывается. При этом количество попыток аудита активации версии задается в параметре ufs.dictionary.scheduled.task.extendedAudit.attempt.count, периодичность — в параметреufs.dictionary.scheduled.task.extendedAudit.retry.time

UFS_DICTIONARY_KAFKA_HEALTHCHECK_SUCCESS

Успешная проверка подключения к Kafka

Событие

Все

Успешная периодическая проверка подключения к Kafka. Периодичность проверки задается в параметре ufs.dictionary.scheduled.task.kafka.healthcheck.time

UFS_DICTIONARY_KAFKA_HEALTHCHECK_FAIL

Неуспешная проверка подключения к Kafka

Событие

Все

Неуспешная периодическая проверка подключения к Kafka

UFS_DICTIONARY_NEW_SECRET

Получены новые секреты

Событие

data-dictionary-service, data-dictionary-load, data-dictionary-manage

Обновление секрета

UFS_DICTIONARY_BAD_SECRET

Полученные секреты не валидны

Событие

data-dictionary-service, data-dictionary-load, data-dictionary-manage

Обновление секрета

UFS_DICTIONARY_SECRET_APPLY

Старт применения секретов

Событие

data-dictionary-service, data-dictionary-load, data-dictionary-manage

Обновление секрета

UFS_DICTIONARY_SECRET_APPLY_SUCC

Успешное применение секретов

Событие

data-dictionary-service, data-dictionary-load, data-dictionary-manage

Обновление секрета

UFS_DICTIONARY_SECRET_APPLY_FAIL

Неуспешное применение секрета

Событие

data-dictionary-service, data-dictionary-load, data-dictionary-manage

Обновление секрета

UFS_DICTIONARY_SECRET_REINITIALIZATION_TIME

Длительность реинициализации подключения с новым секретом (в миллисекундах)

Метрика

data-dictionary-service, data-dictionary-load, data-dictionary-manage

Обновление секрета

UFS_DICTIONARY_SECRET_TOTAL_UPDATE_TIME

Общее время применения секрета — от момента обнаружения изменений до окончания реинициализации всех подключений (в миллисекундах)

Метрика

data-dictionary-service, data-dictionary-load, data-dictionary-manage

Обновление секрета

UFS_DICTIONARY_SEND_REPLICATED_VERSION

Передача версии справочника при синхронизации

Событие

data-dictionary-load, data-dictionary-manage

Межблочная синхронизация

UFS_DICTIONARY_GET_REPLICATED_VERSION

Получение версии справочника при синхронизации

Событие

data-dictionary-load

Межблочная синхронизация

UFS_DICTIONARY_COUNT_REPLICATED_VERSION_WITH_LAG

Количество версий, по которым превышено время на выполнение синхронизации

Метрика

data-dictionary-load

Межблочная синхронизация

UFS_DICTIONARY_SEND_PERMISSIONS_IN_INTER_TOPIC

Отправка разрешений по межблочному транспорту

Событие

data-dictionary-load, data-dictionary-manage

Межблочная синхронизация

UFS_DICTIONARY_GET_PERMISSIONS_FROM_INTER_TOPIC

Получение разрешений по межблочному транспорту

Событие

data-dictionary-load

Межблочная синхронизация

UFS_DICTIONARY_SEND_REPLICATED_PERMISSIONS

Передача разрешений при синхронизации

Событие

data-dictionary-load, data-dictionary-manage

Межблочная синхронизация

UFS_DICTIONARY_GET_REPLICATED_PERMISSIONS

Получение разрешений при синхронизации

Событие

data-dictionary-load

Межблочная синхронизация

UFS_DICTIONARY_COUNT_REPLICATED_PERMISSIONS_WITH_LAG

Количество справочников, по которым превышено время на выполнение синхронизации разрешений

Метрика

data-dictionary-load

Межблочная синхронизация

UFS_DICTIONARY_AUTOREPLICATION_START

Старт автоматической синхронизации

Событие

data-dictionary-manage

Межблочная синхронизация

UFS_DICTIONARY_AUTOREPLICATION_STOP

Остановка автоматической синхронизации

Событие

data-dictionary-manage

Межблочная синхронизация

Метрики пула соединений к БД HikariCP:

Название метрики

Описание

hikaricp_connection_acquired_nanos

Общее время в наносекундах, затраченное на процесс получения соединения из пула HikariCP

hikaricp_active_connections

Текущее количество активных соединений в пуле HikariCP

hikaricp_connection_creation_millis

Время в миллисекундах, затраченное на создание нового соединения в пуле HikariCP

hikaricp_idle_connections

Текущее количество неактивных (ожидающих использования) соединений в пуле HikariCP

hikaricp_max_connections

Максимально допустимое количество соединений в пуле HikariCP, устанавливаемое настройками или конфигурацией

hikaricp_min_connections

Минимальное количество соединений, которые должны быть поддержаны в пуле HikariCP в любое время

hikaricp_pending_threads

Количество потоков, которые ожидают доступа к соединениям в пуле HikariCP

hikaricp_connection_timeout_total

Общее количество времени, в течение которого соединения в пуле HikariCP были недоступны из-за превышения времени ожидания

hikaricp_connection_usage_millis

Общее количество времени в миллисекундах, в течение которого соединения в пуле HikariCP были использованы

Метрики клиентской библиотеки компонента LNSE:

Название метрики

Точка мониторинга

Тип метрики

GET_ROWS_REST_OUT

Вызов REST-сервиса „Получение списка строк из справочника“

Событие

GET_ROWS_REST_SUCCESS

Успешный вызов REST-сервиса „Получение списка строк из справочника“

Событие

GET_ROWS_REST_FAIL

Неуспешный вызов REST-сервиса „Получение списка строк из справочника“

Событие

GET_ROWS_REST_TIMEOUT

Возникновение ошибки тайм-аута при вызове REST-сервиса „Получение списка строк из справочника“

Событие

GET_ROWS_REST_DURATION

Длительность вызова REST-сервиса „Получение списка строк из справочника“

Метрика

GET_ROWS_BUSINESS_SUCCESS

Успешное выполнение запроса „Получение списка строк из справочника“

Событие

GET_ROWS_BUSINESS_FAIL

Неуспешное выполнение запроса „Получение списка строк из справочника“

Событие

GET_ROWS_RESULT_SIZE

Количество возвращаемых элементов по запросу „Получение списка строк из справочника“

Метрика

GET_ROW_REST_OUT

Вызов REST-сервиса „Получение строки справочника“

Событие

GET_ROW_REST_SUCCESS

Успешный вызов REST-сервиса „Получение строки справочника“

Событие

GET_ROW_REST_FAIL

Неуспешный вызов REST-сервиса „Получение строки справочника“

Событие

GET_ROW_REST_TIMEOUT

Возникновение ошибки тайм-аута при вызове REST-сервиса „Получение строки справочника“

Событие

GET_ROW_REST_DURATION

Длительность вызова REST-сервиса „Получение строки справочника“

Метрика

GET_ROW_BUSINESS_SUCCESS

Успешное выполнение запроса „Получение строки справочника“

Событие

GET_ROW_BUSINESS_FAIL

Неуспешное выполнение запроса „Получение строки справочника“

Событие

GET_COUNT_REST_OUT

Вызов REST-сервиса „Получение количества строк справочника“

Событие

GET_COUNT_REST_SUCCESS

Успешный вызов REST-сервиса „Получение количества строк справочника“

Событие

GET_COUNT_REST_FAIL

Неуспешный вызов REST-сервиса „Получение количества строк справочника“

Событие

GET_COUNT_REST_TIMEOUT

Возникновение ошибки тайм-аута при вызове REST-сервиса „Получение количества строк справочника“

Событие

GET_COUNT_REST_DURATION

Длительность вызова REST-сервиса „Получение количества строк справочника“

Метрика

GET_COUNT_BUSINESS_SUCCESS

Успешное выполнение запроса „Получение количества строк справочника“

Событие

GET_COUNT_BUSINESS_FAIL

Неуспешное выполнение запроса „Получение количества строк справочника“

Событие

GET_MAX_PAGE_SIZE_REST_OUT

Вызов REST-сервиса „Получение максимального размера страницы“

Событие

GET_MAX_PAGE_SIZE_REST_SUCCESS

Успешный вызов REST-сервиса „Получение максимального размера страницы“

Событие

GET_MAX_PAGE_SIZE_REST_FAIL

Неуспешный вызов REST-сервиса „Получение максимального размера страницы“

Событие

GET_MAX_PAGE_SIZE_REST_TIMEOUT

Возникновение ошибки тайм-аута при вызове REST-сервиса „Получение максимального размера страницы“

Событие

GET_MAX_PAGE_SIZE_REST_DURATION

Длительность вызова REST-сервиса „Получение максимального размера страницы“

Метрика

GET_MAX_PAGE_SIZE_BUSINESS_SUCCESS

Успешное выполнение запроса „Получение максимального размера страницы“

Событие

GET_MAX_PAGE_SIZE_BUSINESS_FAIL

Неуспешное выполнение запроса „Получение максимального размера страницы“

Событие

SSL_UPDATE_SUCCESS

Успешное выполнение обновления SSL-контекста

Событие

SSL_UPDATE_FAIL

Неуспешное выполнение обновления SSL-контекста

Событие

Метрики биллинга потребителей LNSE:

Название метрики

Точка мониторинга

Тип метрики

Название сервиса

lnse_read_request_count_total

Количество запросов к API чтения в разрезе тенанта и справочника

counter

data-dictionary-service

lnse_load_request_count_total

Количество запросов к API загрузки в разрезе тенанта и справочника

counter

data-dictionary-load

lnse_dictionary_active_ver_size

Суммарный объем данных в активных версиях справочников тенанта

gauge

data-dictionary-load

lnse_dictionary_total_size

Суммарный объем данных в справочниках тенанта

gauge

data-dictionary-load

lnse_dictionary_total_quantity

Количество справочников тенанта

gauge

data-dictionary-load

Важно

Сбор метрик биллинга потребителей с помощью MONE невозможен.

Примечание

Если в одном запросе к API загрузки указано несколько справочников, метрика lnse_load_request_count_total будет зафиксирована для каждого из справочников отдельно.

Настройки#

Настройки микросервисов, входящих в состав LNSE, задаются в отдельных YAML-файлах, которые размещаются в каталоге ConfigMaps каждого из pods LNSE. Название файлов с настройками формируется по шаблону, заданному в конфигурационных файлах:

  • data-dictionary-load.conf;

  • data-dictionary-manage.conf;

  • data-dictionary-service.conf.

При наличии интеграции с компонентом CFGA настройки меняются средствами CFGA.

Подсказка

Если LNSE не интегрирован с компонентом, обеспечивающим управление параметрами, то для изменения настроек внесите соответствующие изменения в YAML-файл и перезапустите pods.

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

Параметр

Краткое описание

Тип

По умолчанию

Название сервиса

ufs.dictionary.max.page.size

Максимальное количество выдаваемых строк справочника. Значение 0 позволяет проектам получать любое количество строк

LONG

0

data-dictionary-service

ufs.dictionary.max.limit.check.enabled

Включение проверки ufs.dictionary.max.limit на стороне сервиса

BOOLEAN

false

data-dictionary-service

ufs.dictionary.max.limit

Максимальный лимит получаемых данных в сервисе на запросах getRows. Ограничение накладывается если параметр ufs.dictionary.max.limit.check.enabled установлен в true

LONG

300

data-dictionary-service

ufs.dictionary.default.tenant

Тенант для совместимости с разными версиями API

STRING

DICT

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.dictionary.upload.path

Путь к временным файлам для загрузки

STRING

/tmp/

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.dictionary.rest.apps.request.timeout

Тайм-аут для HTTP-запроса на REST-app, мс

LONG

120000

data-dictionary-service, data-dictionary-manage

ufs.dictionary.rest.apps.request.timeout

Тайм-аут для HTTP-запроса на REST-app, мс

LONG

360000

data-dictionary-load

ufs.dictionary.rest.pipeline.request.timeout

Тайм-аут для HTTP-запроса на REST для pipeline, мс

LONG

480000

data-dictionary-load

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 LoadAPI

BOOLEAN

true

data-dictionary-load

ufs.dictionary.load.rest.enable

Параметр включения REST LoadAPI

BOOLEAN

true

data-dictionary-load

ufs.dictionary.manage.default.export.part.size

Количество строк в одной части при экспорте

LONG

100000

data-dictionary-manage

ufs.dictionary.manage.business.administrator.readOnly

Включение режима „только чтение“ для бизнес-администратора

BOOLEAN

true

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.profiler.duration.limit

Порог срабатывания для вывода в лог-файл, мс

LONG

2000

data-dictionary-service

ufs.dictionary.profiler.duration.limit

Порог срабатывания для вывода в лог-файл, мс

LONG

20000

data-dictionary-load

ufs.dictionary.profiler.enable

Включение профилирования вызовов

BOOLEAN

true

data-dictionary-load, data-dictionary-service

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.task.external.time

Расписание проверки разовых заданий, CRON/мс

STRING

300000

data-dictionary-load

ufs.dictionary.structure.max.count

Максимальное количество структур для справочника

LONG

5

data-dictionary-load, data-dictionary-manage

ufs.dictionary.structure.compatibility.check.enable

Включение валидации импортируемой структуры справочника

BOOLEAN

true

data-dictionary-load, data-dictionary-manage

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

Время следующей попытки аудита активации версии, CRON/мс

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

Время следующей попытки аудита активации версии, CRON/мс

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.kafka.healthcheck.time

Расписание вызова healthcheck для Kafka

STRING

600000

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.dictionary.scheduled.task.update.profiler.settings

Расписание обновления настроек профилировщика запросов, CRON/мс

STRING

300000

data-dictionary-load, data-dictionary-service

ufs.dictionary.zip.max.size

Максимальный размер ZIP-файла для импорта структуры или наполнение справочника, Мб

LONG

30

data-dictionary-load

ufs.dictionary.pipeline.import.unknown.command.error

Обработка неидентифицируемых команд

BOOLEAN

true

data-dictionary-load

ufs.dictionary.sync.get.item.put.size

Максимальный размер пачки при поиске элемента по dataId

LONG

256

data-dictionary-load

ufs.dictionary.service.meta.cache.enabled

Включение кеширования метаданных справочников в модуле Service

BOOLEAN

true

data-dictionary-service

ufs.dictionary.permission.cache.enabled

Включение кеширования разрешений

BOOLEAN

true

data-dictionary-load, data-dictionary-service

ufs.dictionary.internal.enable

Включение работы с внутренними справочниками

STRING

true

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.dictionary.logback.root.level

Уровень ROOT-логгера для logback

STRING

WARN

data-dictionary-load, data-dictionary-service, data-dictionary-manage

hotreload.timeLowerBound

Задержка перед ротацией секретов, минимальное значение, с

LONG

5

data-dictionary-load, data-dictionary-service, data-dictionary-manage

hotreload.timeUpperBound

Задержка перед ротацией секретов, максимальное значение, С

LONG

150

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.dictionary.secret.rotation.log.remember

Количество ротаций секретов для запоминания

LONG

3

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.dictionary.secret.wait.update

Время ожидания полного обновления файлов с секретами, мс

LONG

2000

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.dictionary.state.output

Назначение вывода lnse-state-collector (DEBUG, INFO, STDOUT, OFF)

STRING

debug

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.dictionary.state.timeout

Тайм-аут между выводом lnse-state-collector в лог/консоль, с

LONG

90

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.dictionary.compatibility.convert.empty.strings

Включение/выключение принудительного приведения „“ к null в загружаемых данных

BOOLEAN

true

data-dictionary-load, data-dictionary-manage

ufs.dictionary.compatibility.number.strip.trailing.zeros

Включение/выключение принудительного приведения чисел вида 1.00 к 1 при чтении данных

BOOLEAN

false

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.dictionary.zone

Текущая зона

STRING

{{ BLOCK_ID }}

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.dictionary.zones

Перечень зон/блоков

STRING

Не заполняется

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.dictionary.billing.enabled

Включение/выключение механизм биллинга

BOOLEAN

false

data-dictionary-load, data-dictionary-service, data-dictionary-manage

lnse.create.partition.fake.item.enable

Включение/выключение механизм создания партиции через fake-item

BOOLEAN

true

data-dictionary-load, data-dictionary-manage

ufs.dictionary.block.selector.enable

Включение API lnse-manage для получения списка блоков

BOOLEAN

false

data-dictionary-manage

readiness.retry.periodSeconds

Частота попыток подключения к ресурсу в случае его недоступности, например, БД или сервис аудита

LONG

10

data-dictionary-manage

healthcheck.offline

Включение процесса саморегистрации в компоненте healthcheck

BOOLEAN

false

data-dictionary-load, data-dictionary-service, data-dictionary-manage

healthcheck.cascadeprotection.isDisabled

Отключение механизма защиты от каскадных отказов

BOOLEAN

false

data-dictionary-load, data-dictionary-service, data-dictionary-manage

platform.rest.healthcheck.timeout

Тайм-аут для HTTP-запроса healthcheck, мс

LONG

10000

data-dictionary-load, data-dictionary-service, data-dictionary-manage

platform.client.ip.header

Название HTTP-заголовка, в котором содержится IP-адрес клиента

STRING

X-Forwarded-For

data-dictionary-load, data-dictionary-service, data-dictionary-manage

platform.http.timeout

Тайм-аут HTTP-запроса

LONG

10000

data-dictionary-load, data-dictionary-service, data-dictionary-manage

lnse.publication.date.check.enable

Включение проверки даты публикации при активации версии

BOOLEAN

false

data-dictionary-load, data-dictionary-manage

ufs.dictionary.scheduled.task.update.gauge.metric.billing.time

Время пересчета размера справочника для биллинга, мс

LONG

86400000

data-dictionary-load

ufs.dictionary.scheduled.task.check.replicator.time

Расписание проверки статусов синхронизации (cron/мс)

STRING

300000

data-dictionary-load

ufs.dictionary.scheduled.task.replication.status.ttl

TTL записей журнала межблочной синхронизации (мс)

LONG

600000

data-dictionary-load

ufs.dictionary.replication.mode

Режим синхронизации (OFF, AUTO)

STRING

data-dictionary-load

ufs.dictionary.replication.mode

Режим синхронизации (OFF, MANUAL, AUTO, ALL)

STRING

data-dictionary-manage

ufs.dictionary.replication.timeout

Максимальное время ожидания выполнения синхронизации до принудительного завершения (мс)

LONG

600000

data-dictionary-load

ufs.dictionary.replication.allow.status

Перечень STDE статусов блоков для запуска вытоматической синхронизации

STRING

Не заполняется

data-dictionary-load, data-dictionary-manage

ufs.dictionary.version.replication.lag

Порог отставания синхронизации версий данных справочников (мс). Параметр поддерживает возможность указать значение в разрезе справочников

LONG

300000

data-dictionary-load

ufs.dictionary.permission.replication.lag

Порог отставания синхронизации разрешений

LONG

300000

data-dictionary-load

ufs.dictionary.version.hash.max.items.count

Максимальное количество записей в версии, для которой рассчитывается хеш данных

LONG

100000

data-dictionary-load, data-dictionary-manage

ufs.dictionary.scheduled.external.task.version.hash.attempt.count

Количество попыток расчета хеша версии данных

LONG

3

data-dictionary-load

ufs.dictionary.scheduled.external.task.version.hash.retry.time

Время следующей попытки расчета хеша версии данных (мс)

LONG

60000

data-dictionary-load

Параметры настройки интеграции с CFGA:

Параметр

Краткое описание

Тип

По умолчанию

Название сервиса

ufsparams.agent.baseUrl.openshift

URL API CFGE для Kubernetes/DropApp

STRING

{{ lookup('custom_vars', 'global.ose.params.baseUrl.stringToBind') }}paramsv2/

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufsparams.agent.baseUrl

URL API CFGE для WAS

STRING

{{ lookup('custom_vars', 'global.params.baseUrl.stringToBind') }}paramsv2/

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.tenant.code

Код тенанта компонента

STRING

{{ lookup('custom_vars', 'TENANT_CODE') }}

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufsparams.agent.delay

Интервал между проверками обновления конфигурации

LONG

10000

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufsparams.agent.max.file.size

Максимальный размер файла конфигурации

LONG

104857600

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufsparams.agent.min.file.size

Минимальный размер файла конфигурации

LONG

50

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufsparams.agent.ignore.file.pattern

Шаблон, по которому агент не будет отслеживать файл для обновления из БД

STRING

glob:**sup2_common.json

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufsparams.agent.httpclient.circuitBreaker.enable

Признак работы механизма circuit breaker. Если указано false, то HTTP-вызов проходит без декорирования механизмом circuit breaker

BOOLEAN

false

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufsparams.agent.httpclient.circuitBreaker.failureRate.threshold

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

LONG

50

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufsparams.agent.httpclient.circuitBreaker.openState.duration

Время ожидания перед переходом от режима работы OPEN к HALF_OPEN

LONG

60000

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufsparams.agent.httpclient.circuitBreaker.halfOpen.requestBuffer

Размер буфера запросов в режиме HALF_OPEN. После заполнения буфера высчитывается процент отказов или процент медленных запросов для принятия решения о повторном прерывании потока (переход в режим OPEN) или о переходе в обычный режим работы потока запросов (переход в режим CLOSED)

LONG

0

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufsparams.agent.httpclient.circuitBreaker.minimumCalls.size

Минимальное количество вызовов, которое требуется в режиме CLOSED, прежде чем CircuitBreaker сможет вычислить частоту ошибок

LONG

10

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufsparams.agent.startup.synchronization.timeout

Интервал между запросом агента к сервису доставки конфигурации за проверкой изменения конфигурации при инициализации КМ

LONG

3000

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufsparams.module.monitoring.enabled

Включение отправки метрики мониторинга при запросе параметра в CFGE (true — метрики отправляются, false — метрики не отправляются)

BOOLEAN

false

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufsparams.module.max.total.connections

Максимальное число соединений в пуле

LONG

50

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufsparams.module.max.per.route

Максимальное число соединений на URL. Рекомендуется устанавливать равным числу соединений в пуле

LONG

50

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufsparams.module.timeout

Тайм-аут соединения

LONG

15000

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufsparams.module.connection.timeout

Тайм-аут на установку соединения

LONG

2000

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufsparams.module.header.server.ip

Имя HTTP-заголовка для передачи IP-адреса клиента

STRING

ufs-client-ip

data-dictionary-load, data-dictionary-service, data-dictionary-manage

Параметры настройки интеграции с STDE:

Параметр

Краткое описание

Тип

По умолчанию

Название сервиса

ufs.baseurl.stand_in

URL API STDE

STRING

!${global.ose.platform.ufs.baseurl.standin}, !${global.platform.ufs.baseurl.standin}

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.baseurl.REPLICATOR

URL API ufs-si-replicator-bh (реализует сервисы прикладной репликации данных; сервисы управление движком обратной репликации)

STRING

!${global.ose.platform.ufs.baseurl.standin}, !${global.platform.ufs.baseurl.standin}

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.standin.db.suffix

Суффикс схемы БД текущего блока

STRING

${efs.block.dbSuffix}

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.standin.core.cache.enabled

Признак использования локального кеша в клиентском модуле STDE

BOOLEAN

true

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.standin.core.cache.ttl

TTL для локального кеша в клиентском модуле STDE

LONG

60000

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.standin.core.cache.dead.ttl

DeadTTL для локального кеша в клиентском модуле STDE

LONG

3600000

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.standin.use.mocks_7.2

Флаг использования mocks

BOOLEAN

false

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.standin.mocks_7.2

Значения mocks

STRING

не заполняется

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.standin.rest.client.max.total.connections

Конфигурация пула соединений. Указывается максимальное число соединений

LONG

10

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.standin.rest.client.max.per.route

Максимальное число соединений на маршрут

LONG

10

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.standin.rest.client.connection.timeout

Тайм-аут подключения к API STDE

LONG

500

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.standin.rest.client.read.timeout

Тайм-аут чтения из endpoint API STDE

LONG

3000

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.standin.rest.client.header.server.ip

Элемент для конфигурации передачи IP-сервера в заголовке

STRING

ufs-client-ip

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.standin.is.use.operation.uid

Признак поиска в getReplicationStatus по operationUid

BOOLEAN

false

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.standin.node.path

STRING

{{ NODE_PATH }}

data-dictionary-load, data-dictionary-service, data-dictionary-manage

integration.adapter.PLTFRMV.SrvBlockModeChangeConsumer.001.checkResponseSchema

Включение валидации ответа

BOOLEAN

true

data-dictionary-load, data-dictionary-service, data-dictionary-manage

integration.adapter.PLTFRMV.SrvBlockModeChangeConsumer.001.checkRequestSchema

Включение валидации запроса

BOOLEAN

true

data-dictionary-load, data-dictionary-service, data-dictionary-manage

integration.module.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.excludeAdapter

Включение/отключение адаптера ИМ UFS_INNER

BOOLEAN

{{ 'false' if SEGMENT_ID is defined and 'private' == SEGMENT_ID/lower else 'true'}}

data-dictionary-load, data-dictionary-service, data-dictionary-manage

integration.module.PLTFRMV.SrvBlockModeChangeConsumer.001.excludeAdapter

Включение/отключение адаптера ИМ PLTFRMV

BOOLEAN

{{ 'true' if SEGMENT_ID is defined and 'private' == SEGMENT_ID/lower else 'false' }}

data-dictionary-load, data-dictionary-service, data-dictionary-manage

integration.module.PLTFRMV.SrvBlockModeChangeConsumer.001.kafkaTopicName

Название topic

STRING

UFS_STANDIN.EXTERNAL.SRVBLOCKMODECHANGEASYNC

data-dictionary-load, data-dictionary-service, data-dictionary-manage

integration.module.PLTFRMV.SrvBlockModeChangeConsumer.001.transportType

Тип транспорта ИМ

STRING

kafka

data-dictionary-load, data-dictionary-service, data-dictionary-manage

integration.module.PLTFRMV.SrvBlockModeChangeConsumer.001.kafkaConsumerFactory

Фабрика-потребитель для ИМ

STRING

kafka/external_factory/consumer_factory_1

data-dictionary-load, data-dictionary-service, data-dictionary-manage

integration.module.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.topicConnectionFactory

Connection Factory Round-Robin для topic

STRING

jms/factory/INNER_TOPIC_ROUND_ROBIN

data-dictionary-load, data-dictionary-service, data-dictionary-manage

integration.adapter.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.checkRequestSchema

Включение валидации запроса

BOOLEAN

true

data-dictionary-load, data-dictionary-service, data-dictionary-manage

integration.adapter.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.checkResponseSchema

Включение валидации ответа

BOOLEAN

true

data-dictionary-load, data-dictionary-service, data-dictionary-manage

integration.module.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.topicName

Название topic

STRING

${ufs.standin.flag.${global.mq.interUnitConnectionFactory}/{{ NODE_PATH }}}/%s/%s/%s

data-dictionary-load, data-dictionary-service, data-dictionary-manage

integration.module.UFS_INNER.srvblockmodechangeasync.001.CLIENT.transportType

Тип транспорта ИМ для передачи уведомлений (внутриблочный механизм)

STRING

kafka

data-dictionary-load, data-dictionary-service, data-dictionary-manage

integration.module.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.kafkaConsumerFactory

Фабрика-потребитель для ИМ

STRING

kafka/inner_factory/consumer_factory

data-dictionary-load, data-dictionary-service, data-dictionary-manage

integration.module.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.kafkaProducerFactory

Фабрика отправки сообщений для ИМ

STRING

kafka/inner_factory/producer_factory

data-dictionary-load, data-dictionary-service, data-dictionary-manage

integration.module.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.kafkaTopicName

Название topic

STRING

{{ INNER_ZONE }}.UFS_STANDIN.INNER.SRVBLOCKMODECHANGEASYNC

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.standin.subscribe.adapter.message

Используемые средства для получения сообщений о смене режима блока

STRING

inner,external

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.standin.is.use.ufs.force.node

Признак обязательной установки заголовка UFS_FORCE_NODE

BOOLEAN

false

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.httpclient.circuitBreaker.enable.STAND_IN

Признак работы механизма circuit breaker

BOOLEAN

true

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.httpclient.circuitBreaker.failureRate.threshold.percent.STAND_IN

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

LONG

50

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.httpclient.circuitBreaker.closed.requestBuffer.size.requestCount.STAND_IN

Размер буфера запросов в обычном режиме потока запросов — CLOSED. После заполнения буфера высчитывается процент отказов для принятия решения о прерывании потока запросов и перехода в режим OPEN

LONG

120

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.httpclient.circuitBreaker.halfOpen.requestBuffer.size.requestCount.STAND_IN

Размер буфера запросов в режиме HALF_OPEN. После заполнения буфера высчитывается процент отказов для принятия решения о повторном прерывании потока — переходе в режим OPEN — или о переходе в обычный режим работы потока запросов — CLOSED. Настройка объединяется с ringBufferSizeInClosedState и недоступна потребителям для изменений. По умолчанию значение настройки „0“, и в этом случае реальный размер буфера запрос в режиме HALF_OPEN равен размеру буфера запросов в режиме CLOSED

LONG

0

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.httpclient.circuitBreaker.open.duration.milliseconds.STAND_IN

Время ожидания перед переходом от режима работы OPEN к HALF_OPEN

LONG

60000

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.httpclient.circuitBreaker.smoothStart.rate.upperLimit.requestsPerSecond.STAND_IN

Предел ограничения скорости запросов, при достижении которого задача плавного старта завершается

LONG

2

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.httpclient.circuitBreaker.smoothStart.rate.startLimit.percent.STAND_IN

Ограничение скорости запросов в момент запуска задачи плавного старта. Указывается в процентах от предела ограничения скорости запросов

LONG

50

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.httpclient.circuitBreaker.smoothStart.rate.limitChange.step.percent.STAND_IN

Шаг изменения ограничения скорости запросов, в процессе работы задачи плавного старта. Указывается в процентах от предела ограничения скорости запросов

LONG

5

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.httpclient.circuitBreaker.record.exceptions.STAND_IN

Список исключений которые считаются ошибкой и влияют на механизм circuit breaker

STRING

Значение не указывается

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.httpclient.circuitBreaker.record.httpException.codes.STAND_IN

Список HTTP-кодов для исключений, которые считаются ошибкой для механизма circuit breaker

STRING

Значение не указывается

data-dictionary-load, data-dictionary-service, data-dictionary-manage

Параметры настройки интеграции с компонентами AUTH, AUTZ, СУДИР:

Параметр

Краткое описание

Тип

По умолчанию

Название сервиса

aim.auth.token.cookie.name

Название cookie токена аутентификации

STRING

UFS-TOKEN

data-dictionary-manage

ufs.auth.routing.refresh.thread.pool.size

Размер пула потоков для обновления токена маршрутизации

LONG

3

data-dictionary-manage

ufs.auth.routing.refresh.duration.milliseconds

Ожидаемое время выполнения задачи по обновлению токена маршрутизации

LONG

3000

data-dictionary-manage

ufs.security.jwt.aud.list

Список разрешенных значений для AUD в JWT-токене

STRING

—

data-dictionary-manage

ufs.security.employee.identifier.sudir.header

Название заголовка HTTP-запроса с идентификатором сотрудника от СУДИР

STRING

iv-user

data-dictionary-manage

ufs.security.employee.identifier.session.attribute

Название мета-атрибута сессии с идентификатором сотрудника

STRING

employeeLogin

data-dictionary-manage

ufs.security.employee.identifier.verification.enabled

Признак проверки идентификатора сотрудника

BOOLEAN

false

data-dictionary-manage

platform.auth.filter.nonclients.allowed

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

BOOLEAN

FALSE

data-dictionary-manage

platform.auth.filter.nonclients.client.type

Название мета-атрибута сессии с идентификатором типа клиента для неклиентов

STRING

clientType

data-dictionary-manage

platform.auth.filter.nonclients.client.type.noclient

Значение типа клиента для неклиентов

STRING

guest

data-dictionary-manage

ufs.baseUrl.AUTHORIZATION

Путь до сервиса авторизации

STRING

${global.platform.ufs.baseurl.security}, ${global.ose.platform.ufs.baseurl.security}

data-dictionary-manage

ufs.security.module.connect.timeout

Конфигурации тайм-аута на соединение с AUTZ, мс

LONG

500

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.security.module.max.total.connections

Максимальное число соединений в пуле

LONG

10

data-dictionary-load, data-dictionary-service, data-dictionary-manage

ufs.security.module.timeout

Тайм-аут AUTZ, мс

LONG

3000

data-dictionary-load, data-dictionary-service, data-dictionary-manage

Параметры настройки интеграции с SUSD:

Параметр

Краткое описание

Тип

По умолчанию

Название сервиса

ufs.baseurl.susd

Базовый URL для доступа к серверной части ССД

STRING

Not used

data-dictionary-manage

ufs.httpclient.connections.max.total.susd

Максимальное количество соединений от КМ ССД к серверной части ССД

LONG

150

data-dictionary-manage

ufs.httpclient.connections.max.per-route.susd

Максимальное количество соединений от КМ ССД к серверной части ССД на узел

LONG

150

data-dictionary-manage

ufs.httpclient.time-out.request.milliseconds.susd

Таймаут запросов от КМ ССД к серверной части ССД (в миллисекундах

LONG

3000

data-dictionary-manage

ufs.httpclient.time-out.connection.milliseconds.susd

Таймаут на соединение от КМ ССД к серверной части ССД (в миллисекундах)

LONG

500

data-dictionary-manage

ufs.httpclient.headers.name.server-ip.susd

Конфигурация передачи IP-адреса сервера в заголовке от КМ ССД к серверной части ССД

STRING

ufs-client-ip

data-dictionary-manage

ufs.httpclient.circuit-breaker.enable.susd

Признак работы механизма circuit breaker

BOOLEAN

false

data-dictionary-manage

ufs.httpclient.circuit-breaker.failure-rate.threshold.percent.susd

Максимальный процент ошибок в потоке запросов, после превышения которого circuit breaker перейдет в режим OPEN, и поток запросов будет прерван

LONG

50

data-dictionary-manage

ufs.httpclient.circuit-breaker.state.closed.request-buffer.size.request-count.susd

Размер буфера запросов для режима CLOSED, после заполнения которого рассчитывается процент ошибок в потоке запросов

LONG

120

data-dictionary-manage

ufs.httpclient.circuit-breaker.state.half-open.request-buffer.size.request-count.susd

Размер буфера запросов для режима HALF_OPEN, после заполнения которого рассчитывается процент ошибок в потоке запросов

LONG

0

data-dictionary-manage

ufs.httpclient.circuit-breaker.state.open.duration.milliseconds.susd

Длительность режима OPEN механизма circuit breaker, в течение действия которого поток запросов прерван (в миллисекундах)

LONG

60000

data-dictionary-manage

ufs.httpclient.circuit-breaker.record.exceptions.susd

Список исключений, которые считаются ошибкой и влияют на механизм circuit breaker

STRING

Значение не указывается

data-dictionary-manage

ufs.httpclient.circuit-breaker.record.httpException.codes.susd

Список HTTP-кодов для исключений, которые считаются ошибкой для механизма circuit breaker

STRING

Значение не указывается

data-dictionary-manage

ufs.httpclient.circuit-breaker.smooth-start.rate-limit.upper.requests-per-second.susd

Предел ограничения скорости запросов, при достижении которого задача плавного старта завершается

LONG

2

data-dictionary-manage

ufs.httpclient.circuit-breaker.smooth-start.rate-limit.start.percent.susd

Ограничение скорости запросов в момент запуска задачи плавного старта. Указывается в процентах от предела ограничения скорости запросов

LONG

50

data-dictionary-manage

ufs.httpclient.circuit-breaker.smooth-start.rate-limit.change-step.percent.susd

Шаг изменения ограничения скорости запросов в процессе работы задачи плавного старта. Указывается в процентах от предела ограничения скорости запросов

LONG

5

data-dictionary-manage

ufs.httpclient.bulkhead.enable.susd

Признак работы механизма bulkHead

BOOLEAN

true

data-dictionary-manage

ufs.httpclient.bulkhead.max-attempts.susd

Максимальное количество попыток повтора применения функциональности bulkHead

LONG

30

data-dictionary-manage

ufs.httpclient.bulkhead.max-concurrent-calls.susd

Максимальное количество конкурентных вызовов методов-обработчиков в параллельных потоках

LONG

150

data-dictionary-manage

ufs.httpclient.bulkhead.wait-duration.susd

Время ожидания для bulkHead при достижении максимального количества конкурентных вызовов (в миллисекундах)

LONG

100

data-dictionary-manage

ufs.baseurl.susd.healthcheck

Базовый URL для доступа для запросов healthcheck к серверной части ССД

STRING

Not used

data-dictionary-manage

ufs.httpclient.connections.max.total.susd.healthcheck

Максимальное количество соединений для запросов healthcheck от КМ ССД к серверной части ССД

LONG

3

data-dictionary-manage

ufs.httpclient.connections.max.per-route.susd.healthcheck

Максимальное количество соединений для запросов healthcheck от КМ ССД к серверной части ССД на узел

LONG

3

data-dictionary-manage

ufs.httpclient.time-out.request.milliseconds.susd.healthcheck

Таймаут запросов healthcheck от КМ ССД к серверной части ССД (в миллисекундах)

LONG

3000

data-dictionary-manage

ufs.httpclient.time-out.connection.milliseconds.susd.healthcheck

Таймаут на соединение для запросов healthcheck от КМ ССД к серверной части ССД (в миллисекундах)

LONG

500

data-dictionary-manage

ufs.httpclient.headers.name.server-ip.susd.healthcheck

Конфигурация передачи IP-адреса сервера в заголовке от КМ ССД к серверной части ССД

STRING

ufs-client-ip

data-dictionary-manage

ufs.httpclient.circuit-breaker.enable.susd.healthcheck

Признак работы механизма circuit breaker

BOOLEAN

false

data-dictionary-manage

ufs.httpclient.circuit-breaker.failure-rate.threshold.percent.susd.healthcheck

Максимальный процент ошибок в потоке запросов, после превышения которого circuit breaker перейдет в режим OPEN, и поток запросов будет прерван

LONG

50

data-dictionary-manage

ufs.httpclient.circuit-breaker.state.closed.request-buffer.size.request-count.susd.healthcheck

Размер буфера запросов для режима CLOSED, после заполнения которого рассчитывается процент ошибок в потоке запросов

LONG

120

data-dictionary-manage

ufs.httpclient.circuit-breaker.state.half-open.request-buffer.size.request-count.susd.healthcheck

Размер буфера запросов для режима HALF_OPEN, после заполнения которого рассчитывается процент ошибок в потоке запросов

LONG

0

data-dictionary-manage

ufs.httpclient.circuit-breaker.state.open.duration.milliseconds.susd.healthcheck

Длительность режима OPEN механизма circuit breaker, в течение действия которого поток запросов прерван (в миллисекундах)

LONG

60000

data-dictionary-manage

ufs.httpclient.circuit-breaker.record.exceptions.susd.healthcheck

Список исключений, которые считаются ошибкой и влияют на механизм circuit breaker

STRING

Значение не указывается

data-dictionary-manage

ufs.httpclient.circuit-breaker.record.httpException.codes.susd.healthcheck

Список HTTP-кодов для исключений, которые считаются ошибкой для механизма circuit breaker

STRING

Значение не указывается

data-dictionary-manage

ufs.httpclient.circuit-breaker.smooth-start.rate-limit.upper.requests-per-second.susd.healthcheck

Предел ограничения скорости запросов, при достижении которого задача плавного старта завершается

LONG

2

data-dictionary-manage

ufs.httpclient.circuit-breaker.smooth-start.rate-limit.start.percent.susd.healthcheck

Ограничение скорости запросов в момент запуска задачи плавного старта. Указывается в процентах от предела ограничения скорости запросов

LONG

50

data-dictionary-manage

ufs.httpclient.circuit-breaker.smooth-start.rate-limit.change-step.percent.susd.healthcheck

Шаг изменения ограничения скорости запросов в процессе работы задачи плавного старта. Указывается в процентах от предела ограничения скорости запросов

LONG

5

data-dictionary-manage

ufs.httpclient.bulkhead.enable.susd.healthcheck

Признак работы механизма bulkHead

BOOLEAN

true

data-dictionary-manage

ufs.httpclient.bulkhead.max-attempts.susd.healthcheck

Максимальное количество попыток повтора применения функциональности bulkHead

LONG

30

data-dictionary-manage

ufs.httpclient.bulkhead.max-concurrent-calls.susd.healthcheck

Максимальное количество конкурентных вызовов методов-обработчиков в параллельных потоках

LONG

150

data-dictionary-manage

ufs.httpclient.bulkhead.wait-duration.susd.healthcheck

Время ожидания для bulkHead при достижении максимального количества конкурентных вызовов (в миллисекундах)

LONG

100

data-dictionary-manage

susd.cluster.baseurl

URL для доступа клиентского модуля ССД к серверной части ССД

STRING

{{ lookup('custom_vars', 'global.ose.platform.ufs.baseurl.sds.master') }}

data-dictionary-manage

susd.cluster.context.path

Context path серверной части ССД

STRING

ufs-session-master$$$sandbox_suffix$$$/rest

data-dictionary-manage

susd.client.header.names.to.proxy

Список заголовков через запятую, которые КМ ССД берёт из текущих бизнес запросов в запросы к кластеру

STRING

UFS-GO-NODE$$$iag_routing_header$$$

data-dictionary-manage

susd.client.target.node.header.name

Имя header-а запроса для его отправки в требуемый контур (nodeCode)

STRING

UFS-GO-NODE

data-dictionary-manage

susd.client.target.node.header.tmp.forced.value

Временное принудительное значение для header-а запроса, направляющего его в требуемый контур (nodeCode). „-“ - это отсутствие значения

STRING

«-»

data-dictionary-manage

susd.client.target.node.random.selection.header.name

Имя header-а запроса для случайного выбора требуемого контура (nodeCode, пока значение не получено из кластера)

STRING

UFS-REPLICA-KEY

data-dictionary-manage

susd.client.preferred.node.header.name

Имя header-а запроса для его отправки в предпочитаемый контур (nodeCode, пока значение не получено из кластера)

STRING

UFS-PREFERRED-NODE

data-dictionary-manage

ufs.sds.monitoring.async.send.metrics

Включение асинхронной отправки метрик в мониторинг

BOOLEAN

true

data-dictionary-manage

ufs.sds.monitoring.async.queue.max.size

Максимальный размер очереди асинхронной отправки метрик

LONG

100000

data-dictionary-manage

ufs.sds.monitoring.metrics.sending.periodicity

Периодичность отправки в Мониторинг метрик ССД (мсек)

LONG

10000

data-dictionary-manage

susd.client.local.sections.forbidden

Признак того, запрещено ли использовать local-секции КМ-у ССД

BOOLEAN

false

data-dictionary-manage

sds.httpclient.time-out.read.milliseconds.susd

Тайм-аут чтения данных в запросах от КМ SUSD к серверной части SUSD (мс)

LONG

2500

data-dictionary-manage

sds.httpclient.time-out.connection.milliseconds.susd

Тайм-аут установки соединения от КМ SUSD к серверной части SUSD (мс)

LONG

500

data-dictionary-manage

sds.httpclient.connections.max.total.susd

Максимальное количество соединений от КМ SUSD к серверной части SUSD

LONG

150

data-dictionary-manage

sds.httpclient.connections.max.per-route.susd

Максимальное количество соединений от КМ SUSD к серверной части SUSD на узел

LONG

150

data-dictionary-manage

sds.httpclient.headers.name.server-ip.susd

Имя IP-адреса сервера в заголовке от КМ SUSD к серверной части SUSD

STRING

ufs-client-ip

data-dictionary-manage

sds.httpclient.time-out.read.milliseconds.susd.healthcheck

Тайм-аут чтения данных в запросах healthcheck от КМ SUSD к серверной части SUSD (мс)

LONG

2500

data-dictionary-manage

sds.httpclient.time-out.connection.milliseconds.susd.healthcheck

Тайм-аут установки соединения для запросов healthcheck от КМ SUSD к серверной части SUSD (мс)

LONG

500

data-dictionary-manage

sds.httpclient.connections.max.total.susd.healthcheck

Максимальное количество соединений для запросов healthcheck от КМ SUSD к серверной части SUSD

LONG

3

data-dictionary-manage

sds.httpclient.connections.max.per-route.susd.healthcheck

Максимальное количество соединений для запросов healthcheck от КМ SUSD к серверной части SUSD на узел

LONG

3

data-dictionary-manage

sds.httpclient.headers.name.server-ip.susd.healthcheck

Имя IP-адреса сервера в заголовке от КМ SUSD к серверной части SUSD для запросов healthcheck

STRING

ufs-client-ip

data-dictionary-manage

Параметры настройки интеграции с AUDT/AUDE:

Параметр

Краткое описание

Тип

По умолчанию

Название сервиса

audit.ufs.client_module.context.error_total_size_threshold

Пороговое значение для общего размера сообщений уровня WARN в TPS

STRING

0

data-dictionary-load, data-dictionary-service, data-dictionary-manage

audit.ufs.client_module.context.error_count_threshold

Пороговое значение для количества сообщений уровня ERROR в TPS

STRING

0

data-dictionary-load, data-dictionary-service, data-dictionary-manage

audit.ufs.client_module.context.warn_count_threshold

Пороговое значение для количества сообщений уровня WARN в TPS

STRING

0

data-dictionary-load, data-dictionary-service, data-dictionary-manage

audit.ufs.client_module.context.warn_total_size_threshold

Пороговое значение для общего размера сообщений уровня WARN в TPS

STRING

0

data-dictionary-load, data-dictionary-service, data-dictionary-manage

audit.ufs.client_module.context.quota_escalation_period

Время эскалации с уровня WARN до уровня ERROR в секундах

STRING

0

data-dictionary-load, data-dictionary-service, data-dictionary-manage

audit.ufs.client_module.context.max_async_send_tasks

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

STRING

1000

data-dictionary-load, data-dictionary-service, data-dictionary-manage

Параметры для настройки интеграции с CLOB/CBUL:

Важно

В LNSE c конфигурацией развертывания в окружении продукта Platform V Frontend Standard (#FS) эксплуатация функциональности обмена с CLOB/CBUL не предполагается и должна быть отключена.

Параметр

Краткое описание

Тип

По умолчанию

Название сервиса

lnse.cbul.exchange.enable

Возможность обмена информацией с CLOB/CBUL

BOOLEAN

false

data-dictionary-load, data-dictionary-manage

pv.node.type

Тип блока, принимает одно из трех допустимых значений: PRIMARY, SANDBOX, CTL

STRING

Не заполняется

data-dictionary-load, data-dictionary-service, data-dictionary-manage

lnse.sync.cbul.suffix

Тип CLOB/CBUL блока (GREENFIELD/MAIN)

STRING

MAIN

data-dictionary-load, data-dictionary-manage

lnse.sync.cbul.mode

Режим взаимодействия с CLOB/CBUL. Возможные значения: MASTER, SLAVE, OFF

STRING

OFF

data-dictionary-load, data-dictionary-manage

lnse.sync.cbul.permission.mode

Режим обмена разрешениями с CLOB/CBUL. Возможные значения: MASTER, SLAVE, OFF

STRING

OFF

data-dictionary-load, data-dictionary-manage

lnse.sync.standin.enable

Учитывать ли Stand-In статус при взаимодействии с CLOB/CBUL

BOOLEAN

false

data-dictionary-load, data-dictionary-manage

ufs.baseurl.cbul.service

Базовый URL для CLOB/CBUL

STRING

Не заполняется

data-dictionary-load, data-dictionary-manage

lnse.sync.cbul.subsystem

Группа доступности прикладного компонента, используется для идентификации. Должна совпадать с компонентом в запросе

STRING

DICTIONARY

data-dictionary-load, data-dictionary-manage

lnse.sync.cbul.group

Код подсистемы прикладного компонента, используется для логирования

STRING

DICTIONARY

data-dictionary-load, data-dictionary-manage

ufs.httpclient.time-out.request.milliseconds.cbul.service

Тайм-аут на запрос, мс

LONG

360000

data-dictionary-load, data-dictionary-manage

ufs.dictionary.scheduled.task.CheckCBULActiveDataSet.time

Периодичность сверки активных версий данных справочников в CLOB/CBUL c БД, CRON/мс

LONG

60000

data-dictionary-load

ufs.dictionary.scheduled.task.CheckEmptyDictionaries.time

Периодичность поиска справочников без версий данных в БД, CRON/мс

LONG

900000

data-dictionary-load

ufs.dictionary.scheduled.import.from.CBUL.task.time

Расписание проверки задач загрузки данных из СBUL, CRON/мс

STRING

300000

data-dictionary-load

ufs.dictionary.scheduled.task.import.from.CBUL.attempt.count

Количество попыток выполнения задачи загрузки данных из СBUL

LONG

10

data-dictionary-load

ufs.dictionary.scheduled.task.import.from.CBUL.retry.time

Время следующей попытки выполнения задачи загрузки данных из СBUL, мс

LONG

60000

data-dictionary-load

ufs.dictionary.scheduled.task.import.from.CBUL.max.work.timeout

Максимальное время, после которого выполнение задачи загрузки данных из СBUL будет прекращено, мс

LONG

300000

data-dictionary-load

ufs.dictionary.scheduled.export.to.CBUL.task.time

Периодичность проверки задач на выгрузку данных в СBUL

STRING

300000

data-dictionary-load

ufs.dictionary.scheduled.task.export.to.CBUL.attempt.count

Количество попыток выполнения задачи на выгрузку данных в СBUL

LONG

10

data-dictionary-load

ufs.dictionary.scheduled.task.export.to.CBUL.retry.time

Время следующей попытки выполнения задачи выгрузки данных в СBUL, мс

LONG

60000

data-dictionary-load

ufs.dictionary.scheduled.task.export.to.CBUL.max.work.timeout

Максимальное время, после которого выполнение задачи на выгрузку данных в СBUL будет прекращено, мс

LONG

300000

data-dictionary-load

ufs.dictionary.number.of.threads.for.cbul.tasks

Количество потоков обработки задач обмена с CLOB/CBUL

LONG

5

data-dictionary-load

ufs.dictionary.number.of.threads.for.export.cbul.tasks

Количество потоков для задач на экспорт в CLOB/CBUL

LONG

5

data-dictionary-load

ufs.dictionary.number.of.threads.for.import.cbul.tasks

Количество потоков для задач на импорт из CLOB/CBUL

LONG

5

data-dictionary-load

lnse.sync.cbul.retry.attempts

Количество попыток отправки запросов к CLOB/CBUL в рамках одной операции

LONG

3

data-dictionary-load, data-dictionary-manage

lnse.sync.cbul.batchsize

Размер пачки, которая будет отправлена в CLOB/CBUL, КБ

LONG

100

data-dictionary-load

lnse.sync.cbul.export.batch.factor

Количество пачек, которые запрашиваются при экспорте в CLOB/CBUL

LONG

20

data-dictionary-load

lnse.sync.cbul.import.batch.factor

Количество пачек, которые запрашиваются при импорте из CLOB/CBUL

LONG

5

data-dictionary-load

lnse.sync.number.sent.batch.between.check.status

Количество отправленных пачек между проверками статуса задачи в БД

LONG

10

data-dictionary-load

lnse.sync.cbul.version.count

Максимальное количество версий справочника, хранимых в CLOB/CBUL

LONG

20

data-dictionary-load

ufs.dictionary.scheduled.taskCheckCBULVersionsNmb.time

Периодичность поиска справочников, у которых количество версий превышает допустимое, CRON/мс

LONG

1020000

data-dictionary-load

ufs.dictionary.scheduled.task.drop.version.in.CBUL.time

Периодичность проверки задач на удаление версии данных в CLOB/CBUL, CRON/мс

STRING

300000

data-dictionary-load

ufs.dictionary.scheduled.task.drop.version.in.CBUL.attempt.count

Количество попыток выполнения задачи на удаление версии данных в CLOB/CBUL

LONG

10

data-dictionary-load

ufs.dictionary.scheduled.task.drop.version.in.CBUL.retry.time

Время следующей попытки выполнения задачи на удаление версии данных в CLOB/CBUL

LONG

60000

data-dictionary-load

ufs.dictionary.scheduled.task.drop.version.in.CBUL.max.work.timeout

Максимальное время, после которого выполнение задачи на удаление версии данных в CLOB/CBUL будет прекращено, мс

LONG

300000

data-dictionary-load

ufs.dictionary.scheduled.task.system.inner.CBUL.time

Периодичность проверки системных вложенных задач на обмен с CLOB/CBUL, CRON/мс

STRING

300000

data-dictionary-load

ufs.dictionary.scheduled.task.system.inner.CBUL.attempt.count

Количество попыток выполнения системной вложенной задачи

LONG

10

data-dictionary-load

ufs.dictionary.scheduled.task.system.inner.CBUL.retry.time

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

LONG

10

data-dictionary-load

ufs.dictionary.scheduled.task.system.inner.CBUL.max.work.timeout

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

LONG

300000

data-dictionary-load

ufs.dictionary.check.root.task.CBUL.retry.time

Время следующей попытки проверки корневой задачи в СBUL, мс

LONG

60000

data-dictionary-load

ufs.dictionary.scheduled.task.CheckCBULPermission.time

Периодичность проверки разрешений в CLOB/CBUL для их загрузки в БД, CRON/мс

LONG

630000

data-dictionary-load

ufs.dictionary.scheduled.task.PeriodicCBULTaskCleanup.time

Периодичность удаления старых CBUL задач, CRON/мс

LONG

1000000

data-dictionary-load

ufs.dictionary.scheduled.import.permissions.from.CBUL.task.time

Расписание импорта разрешений из СBUL, CRON/мс

STRING

60000

data-dictionary-load

ufs.dictionary.scheduled.export.permissions.to.CBUL.task.time

Расписание экспорта разрешений в CBUL, CRON/мс

STRING

60000

data-dictionary-load

Параметры клиентской библиотеки, необходимые для прикладных проектов:

Параметр

Краткое описание

По умолчанию

Тип

ufs.baseurl.dictionary.service

URL REST-API LNSE без rootContext

${global.ose.platform.ufs.baseurl.dictionaries}

STRING

ufs.dictionary.max.page.size

Максимальное количество выдаваемых строк справочника. Значение 0 позволяет проектам получать любое количество строк

100

LONG

ufsdictionary.module.dictionary.logging.enabled

Включение логирования запросов и ответов в разрезе справочника

true

BOOLEAN

ufsdictionary.module.cache.ttl

Время жизни кеша платформенного модуля, мс

1800000

LONG

ufsdictionary.module.cache.dead.ttl

TTL долгого кеша платформенного модуля, мс

3600000

LONG

ufsdictionary.module.cache.dead.resettable

Разрешение сброса долгого кеша платформенного модуля через topic

true

BOOLEAN

ufsdictionary.module.cache.select.maxsize

Максимальное количество записей в кеше select

0

LONG

ufs.dictionary.kafka.resetCache.topicName

Topic Kafka для сброса кеша

lnse-reset-dictionary-cache.001.{{ INNER_ZONE }}

STRING

ufs.httpclient.connections.max.total.dictionary.service

REST-клиент. Конфигурация пула соединений. Указывается максимальное число соединений

10

LONG

ufs.httpclient.connections.max.per-route.dictionary.service

REST-клиент. Указание максимального числа соединений на маршрут

10

LONG

ufs.httpclient.time-out.request.milliseconds.dictionary.service

REST-клиент. Конфигурация тайм-аута запросов (connect+read), мс

3000

LONG

ufs.httpclient.time-out.connection.milliseconds.dictionary.service

REST-клиент. Конфигурация тайм-аута на соединение, мс

500

LONG

ufs.httpclient.headers.name.server-ip.dictionary.service

REST-клиент. Конфигурация передачи IP сервера в заголовок

ufs-client-ip

STRING

ufs.httpclient.circuitBreaker.enable.dictionary.service

REST-клиент. Признак работы механизма circuit breaker

true

BOOLEAN

integration.adapter.UFS_INNER.SrvDictionaryResetCache.001.checkRequestSchema

Интеграционный адаптер. Включение валидации запроса

false

BOOLEAN

integration.adapter.UFS_INNER.SrvDictionaryResetCache.001.checkResponseSchema

Интеграционный адаптер. Включение валидации ответа

false

BOOLEAN

integration.module.UFS_INNER.SrvDictionaryResetCache.001.transportType

Интеграционный модуль. Тип транспорта

KAFKA

STRING

integration.module.UFS_INNER.SrvDictionaryResetCache.001.quota

Интеграционный модуль. Квота вызова сервиса

0

LONG

integration.module.UFS_INNER.SrvDictionaryResetCache.001.quotedTime

Интеграционный модуль. Временной интервал действия квоты вызова сервиса

0

LONG

integration.module.UFS_INNER.SrvDictionaryResetCache.001.kafkaConsumerFactory

Интеграционный модуль. Connection Factory ROUND-ROBIN для consumer

${dictionary.kafka.inner.topic.connection.consumer.factory}

STRING

integration.module.UFS_INNER.SrvDictionaryResetCache.001.kafkaProducerFactory

Интеграционный модуль. Connection Factory ROUND-ROBIN для producer

${dictionary.kafka.inner.topic.connection.producer.factory}

STRING

integration.module.UFS_INNER.SrvDictionaryResetCache.001.kafkaTopicName

Интеграционный модуль. Наименование topic Kafka

{{ INNER_ZONE }}.SrvDictionaryResetCache.001

STRING

Использование программного компонента#

Режим DryRun#

Режим DryRun активируется на стороне InitAPI в случае, если в запросе с данными содержится HTTP-заголовок, формируемый CDJE: X-Dry-Run: True.

При получении данных с заголовком X-Dry-Run: True InitAPI не вносит изменений в данные справочников. Вместо этого InitAPI формирует ответ со статусом 202.

Примеры HTTP-запросов InitAPI#

Примеры использования InitAPI:

Пример для режима Dry-Dun
// Пример запроса создания и наполнения данными версии данных справочника

  // Path:
    http(s)://host:port/data-dictionary-load/rest/init/saveVersion
  // Method:
    POST
  // Header:
    content-Type: application/json
    X-Dry-Run: true
  // Request body:
{
    "dictionaryCode" : "<код справочника>",                        -- # SAMPLE20
    "versionCode": "<код версии справочника>",
    "versionName": "<наименование версии справочника>",
    "initDataVersion": <номер версии начальных данных>,
    "copyActive": false,
    "items": [
       {
            "attrs": {
                "attrDate": "<дата>",
                "attrDateTime": "<дата+время>",
                "attrString": "Тестовая строка 1",
                "description": "<Описание тестовой строки>",
                "value": "<Значение текстового атрибута>",
                "attrDecimal": "<Значение числового атрибута>",
                "code": "SAMPLE_CODE1",
                "attrInteger": "<Значение целочисленного числового атрибута>"
                    }
       }
    ]
} 


// Структура успешного ответа
{
    "success": true,
    "body": {
        "success": true,
        "messages": [
            "Включен режим dry-run",
            "Начало импорта справочника",
            "Код справочника '<код справочника>', версия '<код версии справочника>'|'<наименование версии справочника>', номер версии начальных данных '<номер версии начальных данных>'",
            "Для тенанта 'DEFAULT_TENANT' определен экземпляр 'DEFAULT_INSTANCE'",
            "Номер версии начальных данных в БД '<номер версии начальных данных>'",
            "Удалена версия справочника '<код справочника>', код версии '<код версии справочника>'",
            "Версия сохранена успешно",
            "<количество элементов> элементов сохранено успешно",
            "Версия активирована",
            "Номер версии начальных данных успешно изменен",
            "Загрузка завершена"
                 ]
            }
}
Пример запроса создания и наполнения данными версии данных справочника
// Пример запроса создания и наполнения данными версии данных справочника

  // Path:
    http(s)://host:port/data-dictionary-load/rest/init/saveVersion
  // Method:
    POST
  // Header:
    content-Type: application/json
  // Request body:
{
    "versionName": "<наименование версии данных>",
    "initDataVersion": <порядковый номер версии данных>,
    "dictionaryCode" : "<код справочника>",                        -- # SAMPLE51
    "copyActive" : false,
    "items" : [ {
        "attrs" : {
            "<имя атрибута 1>" : "<значение атрибута 1>",
            "<имя атрибута 2>" : "<значение атрибута 2>",
            "<имя атрибута 3>" : "<значение атрибута 3>",
            "<имя атрибута 4>" : "<значение атрибута 4>",
            "<имя атрибута 5>" : "<значение атрибута 5>",
            "<имя атрибута 6>" : "<значение атрибута 6>",
            "<имя атрибута 7>" : "<значение атрибута 7>",
            "<имя атрибута 8>" : "<значение атрибута 8>"
        } },
    {
        "attrs" : {
            "<имя атрибута 1>" : "<значение атрибута 1>",
            "<имя атрибута 2>" : "<значение атрибута 2>",
            "<имя атрибута 3>" : "<значение атрибута 3>",
            "<имя атрибута 4>" : "<значение атрибута 4>",
            "<имя атрибута 5>" : "<значение атрибута 5>",
            "<имя атрибута 7>" : "<значение атрибута 7>"
        } } ]
}

// Структура успешного ответа

{
  "success": true,
  "body": {
    "success": true,
    "messages": [
      "Начало импорта справочника",
      "Код справочника '<код справочника>', версия '<код версии данных>'|'<наименование версии данных>', номер версии начальных данных '<порядковый номер версии данных>'",
      "Для тенанта 'DEFAULT_TENANT' определен экземпляр 'DEFAULT_INSTANCE'",
      "Номер версии начальных данных в БД '<порядковый номер предыдущей версии данных>'",
      "Удалена версия справочника '<код справочника>', код версии '<код вытесненной версии данных>'",
      "Версия сохранена успешно",
      "<количество загруженных эелементов> элементов сохранено успешно",
      "Версия активирована",
      "Номер версии начальных данных успешно изменен",
      "Загрузка завершена"
    ]
  }
}
Пример запроса импорта разрешений
// Пример запроса импорта разрешений

  // Path:
    http(s)://host:port/data-dictionary-load/rest/init/saveVersion
  // Method:
    POST
  // Header:
    content-Type: application/json
  // Request body:
    {
      "type": "permission",  
	  "subsystem": "<код подсистемы>",
      "permissions": [
          {
            "dictionaryCode": "<код справочника 1>",
            "permission": "<тип разрешения для справочника 1>"
          },
          {
            "dictionaryCode": "<код справочника 2>",
            "permission": "<тип разрешения для справочника 2>"
          }
      ]
    }

// Структура успешного ответа

{
    "success": true,
    "body": {
        "success": true,
        "messages": [
            "Начало добавления разрешений для подсистемы '<код подсистемы>'",
            "Добавление разрешений с типом '<тип разрешния>' для справочников [<коды справочников>]",
            "Добавление разрешений с типом '<тип разрешния>' для справочников [<коды справочников>]",
            "Загрузка в CBUL разрешений: '{<тип разрешения>=[<коды справочников>], <тип разрешения>=[<коды справочников>]}'",
            "Загрузка завершена"
        ]
    }
}

Примечание

Для обеспечения обратной совместимости в конфигурационном файле для внутреннего HTTP-шлюза добавлены настройки маршрутизации запросов к сервису data-dictionary-init (входил в состав компонента LNSE версии 04.X00.00 (20.1) и ниже) на сервис data-dictionary-load. Поэтому в path запросов InitAPI вместо data-dictionary-load допустимо указывать data-dictionary-init.

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

Часто встречающихся проблем в части администрирования нет.