Руководство по системному администрированию#
О документе#
Документ содержит описание системного администрирования компонента Сервис интеграции справочных данных (DDIS) и предназначен для специалиста (по тексту — Системного администратора), осуществляющего системное администрирование программного обеспечения.
Обозначения, сокращения, термины и определения приведены в документе Термины и определения.
Сценарии администрирования#
Для обеспечения защищенного взаимодействия компонента DDIS по протоколу mTLS с иными компонентами Платформы в среде контейнеризации через Platform V Synapse Service Mesh (SSM) требуется обеспечить выпуск сертификата. Специфичных требований к средствам создания сертификатов не предъявляются. Все входящие и исходящие соединения компонента DDIS проходят через Ingress/Egress proxy.
Файл с ролевой моделью включается в поставку и при развертывании прикладного проекта загружается в компонент AUTZ. Загрузка может быть осуществлена с помощью Pipeline, либо сотрудниками в АРМ компонента AUTZ в том случае если инструменты DevOps Pipeline не функционируют. Загруженные привилегии могут быть включены в существующие в AUTZ наборы привилегий, либо для них могут быть созданы новые наборы. Управление наборами привилегий осуществляется в АРМ компонента AUTZ. Набор привилегий назначается пользователю по условию включения данного пользователя в привязанную к набору привилегий группе пользователей.
После того как модель авторизации импортируется в промышленную среду, любые изменения в данную модель должны вноситься с использованием одного источника данных, которым является файл с моделью авторизации. В том случае, если после импорта модели авторизации администратор сопровождения компонента вносит изменения в модель авторизации по отдельной заявке (например, включает разрешение в новый канал), данные изменения должны быть отражены в исходном файле, который содержится в поставке. Если этого не произойдет, изменения, которые вносил администратор сопровождения компонента, будут аннулированы при последующем развертывании обновления приложения.
Доступ к АС должны иметь только те сотрудники, которым он необходим в соответствии с их должностными обязанностями. Доступ должен ограничиваться минимально необходимым объемом данных. Должны разделяться среды разработки, тестирования и эксплуатации, при этом, необходимо производить разделение обязанностей между разработчиками АС, тестирующим персоналом и сотрудниками, непосредственно эксплуатирующими уже введенные в промышленную эксплуатацию компонента DDIS.
Системному администратору доступна возможность изменения настроек компонента DDIS. Перечень и рекомендованные значения настроек приведены в разделе Параметры настоящего документа. При изменении настроек необходимо учитывать их влияние на механизмы безопасности компонента DDIS при настройке интеграции с AUTZ, Secret Management System.
Системному администратору рекомендуется регулярно отслеживать события мониторинга. Перечень событий мониторинга приведен в разделе «События мониторинга» настоящего документа. Просмотр системного журнала доступен в лог-файлах pods компонентов в среде контейнеризации Kubernetes/Platform V DropApp и в UI компонента LOGA при его включении. Мониторинг доступен в случае инсталляции с включением компонента MONA.
Резервное копирование данных компонента DDIS обеспечивается штатными средствами инфраструктуры, в которой разворачивается компонент DDIS, в соответствии с эксплуатационной документацией на аппаратные и программные средства, входящие в состав программно-технического комплекса, на котором размещается компонент DDIS.
Общий порядок регистрации пользователей#
Идентификация и аутентификация пользователей описана в документе Руководство по установке в разделе «Идентификация и аутентификация пользователя».
Перечень прав/ролей пользователей:
Роль (code) |
Права (permission) |
Комментарии |
|---|---|---|
Администратор (DDIS.Системный администратор) |
Просмотр и настройка Процессоров, просмотр и настройка Шлюзов, просмотр и настройка Маршрутов, просмотр и настройка Распространений |
Роль администратора в системе с правами на настройку |
Пользователь (DDIS.Администратор с правами только на чтение) |
Просмотр Процессоров, просмотр Шлюзов, просмотр Маршрутов, просмотр Распространений |
Роль, которой доступен только просмотр, без возможности выполнения действий |
Импорт конфигурации в DDIS#
Ниже описывается изменение конфигурации DDIS посредством импорта инструментами компонента Deploy tools (CDJE). Изменение конфигурации в DDIS включает в себя: управление проверками и значениями WL, выбор типа активации, управление префиксами (Код справочника, Код версии справочника, Атрибуты справочника), определение правил предобработки (rules) и проч. Подробное описание приведено в подразделе «Файл конфигурации» настоящего документа.
Общие сведения импорта конфигурации в DDIS
Конфигурация DDIS может быть изменена перепоставкой дистрибутива, через UI и посредством импорта компонента Deploy Tools (CDJE).
Для управления конфигурациями Публикатора LNSE в системе реализован API импорта посредством компонента Deploy Tools (CDJE).
DDIS включает в себя функциональность импорта mappings, белых списков и правил предобработки. Тем самым DDIS исключает использование компонента Справочники (NSIE) продукта LEGACY.ЕФС.Адаптеры загрузки НСИ (LDA). Конфигурация NSIE поставляется с дистрибутивом mappings (bps-ekpit-map-script) независимо от релизного цикла NSIE.
Для импорта конфигурации необходимо выполнить следующие шаги:
Подготовить файлы конфигурации для импорта в соответствии с описанием ниже.
Подготовить дистрибутив и разместить все файлы конфигурации в каталоге package/conf/data/ddis.
Выполнить deployment данного дистрибутива.
Убедиться что deployment выполнился без ошибок.
Файл конфигурации
Для каждого сервиса (Шлюза) Пользователь DDIS формирует конфигурации в виде JSON файла.
Структура файла конфигурации описывается схемой ddis-strict-schema.json.
Используемые поля:
Поле |
Тип |
Ограничения |
Описание |
Уникальность |
|---|---|---|---|---|
id |
String |
RW! |
Идентификатор |
Да |
name |
String |
RW! |
Наименование |
Да |
parentId |
String |
RW! |
Идентификатор верхнего уровня |
Нет |
user |
String |
RW! |
Редактор |
Нет |
active |
Boolean |
RW! |
Активная конфигурация |
Нет |
attributes |
Map[] |
RW! |
Список параметров |
Нет |
attributes/whiteListEnabledValue |
Boolean |
RW |
Включение (true) / выключение (false) проверки по списку разрешенных к загрузке справочников. Имеет приоритет перед WhiteListEnabledName. Если в Tuner задан WhiteListEnabledValue, то будет использовано это значение, а значение WhiteListEnabledName не будет применено |
Нет |
attributes/whiteListValue |
String |
RW |
Список разрешенных к загрузке справочников. Имеет приоритет перед WhiteListName. Если в Tuner задан WhiteListValue, то будет использовано это значение, а значение WhiteListName не будет применено |
Нет |
attributes/incrementEnableValue |
Boolean |
RW |
Включение (true) / выключение (false) функциональности загрузки инкремента. Имеет приоритет перед incrementEnableName. Если в Tuner задан incrementEnableValue, то будет использовано это значение, а значение incrementEnableName не будет применено |
Нет |
attributes/whiteListEnabledName |
String |
RW |
Имя параметра для включения / выключения проверки по списку разрешенных к загрузке справочников. Tuner возвращает имя параметра. Применятся только если в Tuner не задан WhiteListEnabledValue |
Нет |
attributes/whiteListName |
String |
RW |
Имя параметра, в котором содержится список разрешенных к загрузке справочников (WL). Tuner возвращает имя параметра. Применятся только если в Tuner не задан WhiteListValue |
Нет |
attributes/dictionaryPrefix |
String |
RW |
Префикс кода справочника в компоненте LNSE |
Нет |
attributes/attributePrefix |
String |
RW |
Префикс пользовательских атрибутов справочника LNSE |
Нет |
attributes/dataVersionPrefix |
String |
RW |
Префикс версии данных. Значение вида DDIS_<версия данных> |
Нет |
attributes/activationType |
String |
RW |
Тип активации. Возможные значения: SAMPLE — активация по факту загрузки, PACKAGE — пакетная активация, DELAYED — отложенная активация, DONT_ACTIVATE — загрузка без активации |
Нет |
attributes/caseConversion |
String |
RW |
Регистр имен атрибутов в LNSE. Возможные значения: LOWER — перевод в нижний регистр, ASIS — без преобразования регистра, UPPER — перевод в верхний регистр |
Нет |
attributes/dictionaryCaseConversion |
String |
RW |
Регистр кода справочника LNSE. Возможные значения: LOWER — перевод в нижний регистр, ASIS — без преобразования регистра, UPPER — перевод в верхний регистр. Преобразование регистра не распространяется на префикс справочника, заданного в параметре dictionaryPrefix. Код справочника = dictionaryPrefix + dictionaryCaseConversion (dictionary.name) |
Нет |
attributes/dynamic |
Boolean |
RW |
Управление динамической загрузкой. Включает и выключает функциональность динамического создания/изменения справочника. Возможные значения: true — динамическая загрузка включена, false — динамическая загрузка выключена |
Нет |
attributes/incrementEnableName |
String |
RW |
Управление инкрементальной загрузкой. Tuner возвращает имя параметра PACMAN. Параметр включает (true) и выключает (false) функциональность загрузки инкремента. Применятся только если в Tuner не задан incrementEnableValue |
Нет |
attributes/sign |
Boolean |
RW |
Управление проверкой ЭП. Параметр включает (true) и выключает (false) функциональность проверки ЭП |
Нет |
attributes/rowCountCheckEnabledValue |
Boolean |
RW |
Включение (true) / выключение (false) режима сверки количества отправленных и загруженных строк после загрузки всех строк справочника. Отсутствие параметра интерпретируется как false |
Нет |
attributes/rowCountDiagnosticEnabledValue |
Boolean |
RW |
Включение (true) / выключение (false) режима интервальной (диагностической) сверки количества отправленных и загруженных строк. Выполняется после загрузки определенного количества пачек данных. Отсутствие параметра интерпретируется как false |
Нет |
attributes/concurrentLoadLimit |
Int |
RW |
Количество разрешенных параллельных загрузок одного справочника. Отсутствие параметра, значение null, значение 0 интерпретируется отсутствием ограничений на параллельную загрузку справочников |
Нет |
rules |
Rule[] |
RW! |
Список правил |
Нет |
rules/group |
Init |
RW |
Номер группы правил. Целое натуральное число. Для каждой группы правил уровень конфигурации задается независимо. Группа с наименьшим номером имеет наибольший приоритет для выполнения. Правила группы с высоким приоритетом выполняются первыми. Возможные значения: от 1 до 100 |
Нет |
rules/dictionaryCode |
String |
RW |
Код справочника в компоненте LNSE. Обязателен для заполнения. Код справочника может быть задан явно в виде строки, либо c использованием специальных символов: «%» — любая строка из нуля или более символов, «?» — любой одиночный символ. Каждый одиночный символ требует экранирования. Пример из 8 символов: \?\?\?\?\?\?\?\? |
Нет |
rules/attribute |
String |
RW |
Имя атрибута или группа атрибутов справочника в компоненте LNSE, для которого выполняется преобразование. Имя атрибута может быть задан явно в виде строки, либо c использованием специальных символов: «%» — любая строка из нуля или более символов, «?» — любой одиночный символ. Каждый одиночный символ требует экранирования. Пример из 8 символов: \?\?\?\?\?\?\?\?. Важно! Если атрибут задан с использованием специальных символов и шаблону соответствует несколько атрибутов, то правила применяются ко всем значениям этих атрибутов. При этом результат обработки множества атрибутов будет записан в одно поле field через разделитель, заданный в поле delimeter. Следует с осторожностью применять специальные символы, т.к. результат обработки множества атрибутов может не соответствовать ожидаемому типу данных, либо превысить размерность конечного атрибута, заданного в поле field |
Нет |
rules/rule |
String |
RW |
Оператор или операторы правил, заданные через символ-разделитель «;». Перечень операторов следующий: trim() — удаление пробелов из начала и конца строки, long() — приведение к типу long, double() — приведение к типу double, substring (int, int) — подстрока, toLowerCase() — приведение к нижнему регистру, toUpperCase() — приведение к верхнему регистру, tonull() — присвоение значению null, numToTimestamp(), strToTimestamp(dateFormat, locale) — приведение к Timestamp, strBooltoNum() — приведение типа boolean к long (если value == «Y» то ответ 1, иначе 0), date(parameter1,parameter2) — приведение даты к заданному формату, где parameter1 — формат исходной строки для преобразования (string), parameter2 — целевой формат преобразования (string), пример: date(yyyy-MM-dd,yyyy.MM.dd), если второй параметра не задан, то по умолчанию выполняется приведение к ISO формату, результатом выполнения правила будет строка со значением даты в заданном формате, noTransform() — не делать преобразований (запись value в определенный правилом атрибут), hash(method) — расчет хеша строки, состоящей из значений атрибутов указанных в поле attribute и разделителя указанного в поле delimeter, где method — алгоритм расчета хеша: sha1Hex (используется по умолчанию hash(), sha256Hex, md5Hex). Важно! Оператор не должен быть чувствителен к регистру. Операторы одного правила выполняются последовательно слева направо. Для первого (крайнего левого) оператора исходным значением является значение (value) атрибута из файла выгрузки. Для последующих операторов исходное значение для преобразования будет результат работы левого (от него) оператора |
Нет |
rules/field |
String |
RW |
Имя атрибута в котором сохранится результат преобразований. Если в процессе загрузки в запросе передается атрибут которого нет в структуре справочника LNSE, то |
Нет |
rules/defaultValue |
String |
RW |
Значение по умолчанию. Значение по умолчанию устанавливается если атрибуты для применения правил не найдены, либо все их значения null |
Нет |
rules/priority |
Init |
RW |
Приоритет выполнения правила внутри группы. Для одного справочника (и даже одного атрибута) может быть задано несколько правил. Выполнение правил (внутри группы) должно производиться в соответствии с приоритетом. Чем меньше число, тем выше приоритет. Ноль — наивысший приоритет |
Нет |
rules/modificationDate |
DateTime |
RW |
Дата изменения |
Нет |
rules/enabled |
Boolean |
RW |
Активность правила |
Нет |
rules/description |
String |
RW |
Описание правила |
Нет |
rules/delimeter |
String |
RW |
Используется для разделения результатов обработки значений нескольких атрибутов в поле field (при использовании символа «%» в поле attributes) |
Нет |
creationDate |
Instant |
R |
Дата создания |
Нет |
modificationDate |
Instant |
R |
Дата изменения |
Нет |
Примечание
Примечание
*
R — Поле доступное для чтения.
W — Поле доступное для записи.
! — Поле, являющееся обязательным.
Иерархия внутри файла конфигурации
Конфигурация может быть задана для разных уровней: services -> sources -> clients -> domains -> dictionaries. Они наследуют друг друга и выстраивают дерево, где корень конфигурации — уровень services, а листья — dictionaries.
@startsalt
{
{T
+services |id=1|parentId=""
++sources |id=2|parentId=1
+++clients |id=3|parentId=2
++++domains |id=4|parentId=3
+++++dictionaries |id=5|parentId=4
}
}
@endsalt
Набор параметров конфигурации для всех уровней одинаков.
Конфигурация низкого уровня имеет приоритет над конфигурацией уровня выше.
Конфигурация заданная на уровне dictionaries позволяет реализовать особый режим загрузки для отдельного справочника.
Если в конфигурации задано значение для одного и того же параметра на уровнях dictionaries и sources, то значение, заданное, на уровне dictionaries будет иметь приоритет над конфигурацией уровня sources, но только для одного конкретного справочника, указанного на уровне dictionaries.
Например, для справочников определенного поставщика должен применяться определенный префикс. Он задается параметром на уровне source. При этом возможно для отдельного справочника задать уникальный префикс. Для этого необходимо в конфигурации на уровне dictionaries указать имя этого справочника и альтернативное значение префикса в параметре.
Для каждого сервиса (Шлюза) обязательно должна быть задана конфигурация уровня сервиса. Необязательно задавать конфигурацию для каждого уровня. Конфигурация уровней ниже создается при необходимости реализовать особые сценарии загрузки для групп или отдельных справочников.
Ограничения файла конфигурации
Файл конфигурации должен соответствовать схеме: ddis-tuner-schema.json.
В случае несоответствия схеме API импорта конфигурации будет возвращать список ошибок.
Проверка соответствия файла конфигурации на соответствие схеме управляется параметром PACMAN ddis.dd.tuner.schema.validate.toggle:
true — проверка выполняется;
false — проверка отключена (default).
Пример файла конфигурации Шлюза ТФС
Пример файла конфигурации Шлюза ТФС: ddis-gate-tfs.json.
Расположение файла конфигурации в дистрибутиве
Расположение файла конфигурации в дистрибутиве:
Путь файлов импорта конфигурации в DDIS: package/conf/data/ddis.
Имя файла импорта DDIS: ddis-<имя шлюза>.json.
Например, имя файла конфигурации для загрузки справочников от Шлюза ТФС: ddis-gate-tfs.json.
Формат дистрибутива
Формат дистрибутива: ZIP.
Имя playbook
Имя playbook: IMPORT_DDIS_PARAMS
Поведение при загрузке
Поведение при загрузке:
Во время запуска Jenkins pipeline CDJE в лог-файлах будет отображен процесс:
Шаблонизация, обогащение конфигурации.
Запуск импорта.
В случае появлений ошибки CDJE укажет где она и какого ее содержание.
Коды ответа:
HTTP код |
Результат импорта |
Тело ответа |
|---|---|---|
201 |
Данные успешно импортированы |
Нет |
400 |
Ошибка в формате данных |
В теле ответа приведено описание ошибки для отображения Администратору |
401 |
Не пройдена авторизация |
Нет |
422 |
Логическая ошибка в данных |
В теле ответа приведено описание ошибки для отображения Администратору |
Параметры#
Описание переменных дистрибутива внешнего провайдера секретов Vault#
Переменные окружения:
Переменная дистрибутива |
Описание переменной дистрибутива |
Значение по умолчанию |
|---|---|---|
ddis.vault.path.postgres.cert |
Параметр, задающий путь к сертификатам SSL |
/mnt/config/ssl/postgresql |
ddis.vault.path.postgres.root |
Параметр, задающий путь к корневому сертификату SSL |
/mnt/config/ssl/postgresql/ca |
ddis.vault.cert.name.root |
Параметр, задающий имя файла корневого сертификата |
root.crt |
dis.vault.cert.name.crt |
Параметр, задающий имя файла SSL сертификата |
tls.crt |
ddis.vault.cert.name.key |
Параметр, задающий имя файла SSL ключа |
tls.key |
Описание переменных дистрибутива подключения к БД
Переменные окружения:
Переменная дистрибутива |
Описание переменной дистрибутива |
Значение по умолчанию |
Зависимость от других параметров * |
|---|---|---|---|
ddis.postgres.argv.ssl.enable |
Параметр включения режима SSL для подключения к PostgreSQL |
true |
- |
ddis.postgres.argv.ssl.mode |
Параметр, задающий режим верификации подключения SSL к PostgreSQL |
verify-full |
- |
ddis.postgres.argv.ssl.crt |
Параметр, задающий путь к сертификату цепочки SSL |
- |
ddis.vault.path.postgres.cert |
ddis.postgres.argv.ssl.key |
Параметр, задающий путь к ключу цепочки SSL |
- |
|
ddis.postgres.argv.ssl.root |
Параметр, задающий путь к корневому сертификату SSL |
- |
ddis.vault.path.postgres.root |
ddis.postgres.argv |
Параметр, задающий строку аргументов для подключения к PostgreSQL |
- |
ddis.postgres.argv.ssl.enable |
ddis.postgres.url.base |
Параметр, задающий строку подключения URL к PostgreSQL без аргументов |
jdbc.ddis_postgres.url |
- |
ddis.postgres.url.argv |
Параметр, задающий строку подключения URL к PostgreSQL с аргументами |
- |
ddis.postgres.url.base |
Примечание
Примечание
*
Значения ряда параметров зависят от значения других параметров. Данная зависимость указана в колонке «Зависимость от других параметров».
Описание параметров сервиса Публикатор в LNSE (ddis-publish-lnse)#
Параметры сервиса:
Имя параметра (PACMAN) |
Описание параметра |
Признак списочного параметра |
Тип данных |
Переменная дистрибутива |
Значение переменной/значение по умолчанию |
Условие применения |
|---|---|---|---|---|---|---|
platform.client.ip.header |
Название HTTP заголовка, в котором содержится IP адрес клиента |
FALSE |
STRING |
- |
iv-remote-address |
Рестарт pod |
platform.http.timeout |
Тайм-аут HTTP запроса |
FALSE |
LONG |
- |
10000 |
Рестарт pod |
pv.node.type |
FALSE |
STRING |
- |
PRIMARY |
Рестарт pod |
|
ufs.tenant.code |
- |
FALSE |
STRING |
ufsparams_module_tenant_code |
„TENANT_CODE“ |
Рестарт pod |
ufsparams.module.monitoring.enabled |
Включение отправки метрики мониторинга при запросе параметра (true — метрики отправляются, false — метрики не отправляются) |
FALSE |
BOOLEAN |
ufsparams_module_monitoring_enabled |
false |
Рестарт pod |
ufsparams.agent.baseUrl.openshift |
Основной URL для IAG-mm (для OSE) |
FALSE |
STRING |
ufsparams_agent_baseUrl_insecure |
„global.ose.params.baseUrl.stringToBind“ |
Рестарт pod |
ufsparams.agent.baseUrl |
Основной URL для IAG-mm (для WAS) |
FALSE |
STRING |
ufsparams_agent_baseUrl_secure |
„global.params.baseUrl.stringToBind“ |
Рестарт pod |
ufsparams.agent.delay |
Интервал между проверками обновления конфигурации |
FALSE |
LONG |
ufsparams_agent_delay |
10000 |
Рестарт pod |
ufsparams.agent.max.file.size |
Максимальный размер файла конфигурации |
FALSE |
LONG |
ufsparams_agent_max_file_size |
104857600 |
Рестарт pod |
ufsparams.agent.min.file.size |
Минимальный размер файла конфигурации |
FALSE |
LONG |
ufsparams_agent_min_file_size |
50 |
Рестарт pod |
ufsparams.agent.ignore.file.pattern |
Паттерн, по которому Агент не будет отслеживать файл для обновления из БД |
FALSE |
STRING |
ufsparams_agent_ignore_file_pattern |
glob:**sup2_common.json |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.enable |
Признак работы механизма circuit breaker. Если указано false, то HTTP вызов происходит без декорирования механизмом circuit breaker |
FALSE |
BOOLEAN |
ufsparams_agent_httpclient_circuitBreaker_enable |
false |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.failureRate.threshold |
Процент отказов в потоке запросов. После превышения данного процента поток будет прерван (переход в режим OPEN) |
FALSE |
LONG |
ufsparams_agent_httpclient_circuitBreaker_failureRate_threshold |
50 |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.openState.duration |
Время ожидания перед переходом от режима работы OPEN к HALF_OPEN |
FALSE |
LONG |
ufsparams_agent_httpclient_circuitBreaker_openState_duration |
60000 |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.halfOpen.requestBuffer |
Размер буфера запросов в режиме HALF_OPEN. После заполнения буфера рассчитывается процент отказов или процент медленных запросов для принятия решения о повторном прерывании потока (переход в режим OPEN) или о переходе в обычный режим работы потока запросов (переход в режим CLOSED). По умолчанию значение для данной настройки «0» и в этом случае реальный размер буфера запросов в режиме HALF_OPEN равен размеру буфера запросов в режиме CLOSED |
FALSE |
LONG |
ufsparams_agent_httpclient_circuitBreaker_halfOpen_requestBuffer |
0 |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.minimumCalls.size |
Минимальное количество вызовов, которое требуется (в режиме CLOSED), прежде чем CircuitBreaker сможет вычислить частоту ошибок. По умолчанию значение для данной настройки «10» |
FALSE |
LONG |
ufsparams_agent_httpclient_circuitBreaker_minimumCalls_size |
10 |
Рестарт pod |
ufsparams.agent.startup.synchronization.timeout |
FALSE |
LONG |
ufsparams_agent_startup_synchronization_timeout |
3000 |
Рестарт pod |
|
ddis.hotreload.db.toggle |
Включение/выключение функциональности hotreload для секретов БД в обработчике события |
FALSE |
BOOLEAN |
- |
true |
Runtime, без рестарта pod |
ddis.dictionary.load.baseurl |
Загрузчик LNSE. URL к REST-API LNSE (без rootContext) |
FALSE |
STRING |
- |
${ddis.settings.lnse.url} |
Рестарт pod |
ddis.dictionary.process.timeout |
Значение, определяющее время последнего редактирования строки БД (в минутах) |
FALSE |
LONG |
60 |
Рестарт pod |
|
ddis.dictionary.watcher.toggle |
Включение/выключение проверки зависших процессов |
FALSE |
BOOLEAN |
- |
true |
Рестарт pod |
ddis.dictionary.cron.watcher.start |
Cron зависших процессов |
FALSE |
STRING |
- |
0 0/3 * * * ? |
Runtime, без рестарта pod |
ddis.dictionary.s3.partsize |
Размер части файла (в мегабайтах) для загрузки в хранилище |
FALSE |
LONG |
- |
10 |
Рестарт pod |
ddis.tfs.unsi.increment.enable |
Проверка инкрементального статуса |
FALSE |
BOOLEAN |
- |
false |
Рестарт pod |
ddis.dictionary.load.checker.cron |
Cron для модуля Checker |
FALSE |
STRING |
- |
0/10 * * * * ? |
Runtime, без рестарта pod |
ddis.dictionary.load.loader.cron |
Cron для модуля Loader |
FALSE |
STRING |
- |
0/10 * * * * ? |
Runtime, без рестарта pod |
ddis.dictionary.load.tuner.cron |
Cron для модуля Tuner |
FALSE |
STRING |
- |
0/10 * * * * ? |
Runtime, без рестарта pod |
ddis.dd.tuner.load.default.config.toggle |
Включение/выключение загрузки конфигураций по умолчанию |
FALSE |
BOOLEAN |
- |
false |
Runtime, без рестарта pod |
ddis.dd.tuner.schema.validate.toggle |
Включение/выключение валидации конфигураций по схеме |
FALSE |
BOOLEAN |
- |
true |
Runtime, без рестарта pod |
ddis.dd.tfs.unsi.increment.enable |
Управление загрузкой инкрементов |
FALSE |
BOOLEAN |
- |
false |
Runtime, без рестарта pod |
ddis.dd.tfs.arcgis.increment.enable |
Управление загрузкой инкрементов |
FALSE |
BOOLEAN |
- |
false |
Runtime, без рестарта pod |
ddis.dd.tfs.cas.increment.enable |
Управление загрузкой инкрементов |
FALSE |
BOOLEAN |
- |
false |
Runtime, без рестарта pod |
ddis.dd.tfs.kakb.increment.enable |
Управление загрузкой инкрементов |
FALSE |
BOOLEAN |
- |
false |
Runtime, без рестарта pod |
ddis.dd.tfs.pcap.increment.enable |
Управление загрузкой инкрементов |
FALSE |
BOOLEAN |
- |
false |
Runtime, без рестарта pod |
ddis.dd.tfs.pckib.increment.enable |
Управление загрузкой инкрементов |
FALSE |
BOOLEAN |
- |
false |
Runtime, без рестарта pod |
ddis.dd.tfs.empty.wl |
Список разрешенных к загрузке справочников (заглушка) |
TRUE |
STRING |
- |
EMPTY |
Рестарт pod |
ddis.dd.tfs.wl.enabled.false |
Управление проверкой по списку разрешенных к загрузке справочников: false — проверка выключена |
FALSE |
BOOLEAN |
- |
false |
Рестарт pod |
ddis.dd.tfs.wl.enabled.true |
Управление проверкой по списку разрешенных к загрузке справочников: true — проверка включена |
FALSE |
BOOLEAN |
- |
true |
Рестарт pod |
ddis.tuner.import.http.timeout |
Тайм-аут HTTP запроса на загрузку конфигураций |
FALSE |
LONG |
- |
90000 |
Рестарт pod |
hotreload.timeLowerBound |
Нижняя граница времени применения секрета (раньше этого времени применение секрета не начнется) |
FALSE |
LONG |
- |
5 |
Runtime, без рестарта pod |
hotreload.timeUpperBound |
Верхняя граница времени применения секрета (позже этого времени применение секрета не начнется) |
FALSE |
LONG |
- |
150 |
Runtime, без рестарта pod |
ddis.dictionary.load.retry.number |
Количество повторов отправки записей в LNSE |
FALSE |
LONG |
- |
2 |
Runtime, без рестарта pod |
ddis.dictionary.load.retry.delay |
Задержка между переотправкой записей в LNSE |
FALSE |
LONG |
- |
1000 |
Runtime, без рестарта pod |
ddis.hotreload.iag.toggle |
Включение/выключение hotreload для секретов авторизации на IAG |
FALSE |
BOOLEAN |
- |
false |
Runtime, без рестарта pod |
ddis.hotreload.filestorage.toggle |
Включение/выключение hotreload для секретов хранилища файлов |
FALSE |
BOOLEAN |
- |
true |
Runtime, без рестарта pod |
ddis.publish-lnse.iiauth.enable |
Включение/выключение добавления заголовка авторизации на IAG в запросы к LNSE |
FALSE |
BOOLEAN |
- |
false |
Runtime, без рестарта pod |
ufs.standin.node.path |
FALSE |
STRING |
- |
${ufs.standin.node.path} |
Рестарт pod |
|
ddis.dd.active.load.check.enabled |
Включение/выключение управления количеством активных загрузок справочника |
FALSE |
BOOLEAN |
- |
false |
Runtime, без рестарта pod |
ddis.dictionary.read.awaiting.time |
Время ожидания завершения чтения файла из хранилища (в миллисекундах) |
FALSE |
LONG |
- |
20000 |
Runtime, без рестарта pod |
ddis.dictionary.write.awaiting.time |
Время ожидания завершения записи файла в хранилище (в миллисекундах) |
FALSE |
LONG |
- |
30000 |
Runtime, без рестарта pod |
ddis.dd.tuner.checks.load.config.toggle |
Отключение проверок при загрузке конфигурации |
FALSE |
BOOLEAN |
- |
false |
Runtime, без рестарта pod |
ddis.dd.tuner.correction.config |
Разрешение автоматически исправлять конфигурацию |
FALSE |
BOOLEAN |
- |
false |
Runtime, без рестарта pod |
ddis.dictionary.check.record.count.toggle |
Включить сверку количества записей, добавляемых в новую версию и загруженных в эту версию |
FALSE |
BOOLEAN |
- |
false |
Runtime, без рестарта pod |
ddis.dictionary.interrupt.load.toggle |
Включение/выключение прерывания долгой активной операции загрузки распространения (load) по тайм-ауту |
FALSE |
BOOLEAN |
- |
false |
Runtime, без рестарта pod |
ddis.dictionary.watcher.hung.partsize |
Размер пачки процедуры поиска зависших распространений процедуры проверки по тайм-ауту |
FALSE |
LONG |
- |
10 |
Runtime, без рестарта pod |
Переменные окружения:
Переменная окружения |
Переменная дистрибутива |
Описание переменной окружения |
Единица измерения |
Значение по умолчанию |
|---|---|---|---|---|
INSTANCE_NAME |
- |
Имя quartz scheduler |
- |
DDIS_SRG |
TABLE_PREFIX |
- |
Префикс таблиц quartz |
- |
DDIS_QRTZ_ |
DATASOURCE_URL |
ddis.dictionary.env.datasource_url |
Адрес базы данных компонента формируется исходя из следующего набора параметров. |
- |
Обязательно к заполнению |
DATASOURCE_MINIMUM_IDLE |
ddis.dictionary.env.datasource.minIdle |
Минимальное количество простаивающих соединений к базе данных компонента |
- |
1 |
DATASOURCE_SCHEMA |
- |
Схема базы данных компонента |
- |
ddis_publish_lnse |
DATASOURCE_MAXIMUM_POOL_SIZE |
ddis.dictionary.env.datasource.maxPoolSize |
Максимальное количество соединений с базой данных компонента |
- |
16 |
ENDPOINTS_WEB_INCLUDE |
- |
Список включенных ресурсов Actuator, разделенных запятой |
- |
loggers,health,prometheus,info,env |
ENDPOINT_LOGGERS_ENABLED |
ddis.dictionary.env.endpoint.logger.enabled |
Включить адреса loggers Actuator — логгер актуатора |
- |
true |
SERVER_PORT |
ddis.dictionary.env.server_port |
Порт публичного интерфейса |
- |
8080 |
MANAGEMENT_SERVER_PORT |
ddis.dictionary.env.management_server_port |
Порт интерфейса управления |
- |
8083 |
GATES_FOLDERS_PATH |
- |
Директория с параметрами по умолчанию |
- |
/usr/app/resources |
RESOURCE_ID |
ddis.dictionary.env.resource_id |
Идентификатор ресурса |
- |
pprbnsi-ddis |
PARTITION |
ddis.dictionary.env.partition |
Идентификатор установки: sbrf, pvc, gov |
- |
sbrf |
REGION |
ddis.dictionary.env.region |
Регион установки |
- |
pprbnsi |
ACCOUNT |
ddis.dictionary.env.account |
Счет |
- |
pprbnsi |
MODULE_ID |
ddis.dictionary.env.module_id |
Идентификатор модуля |
- |
pprbnsi-ddis |
UNIMON_ID |
ddis.dictionary.env.unimon_id |
Идентификатор интеграции с сервисом UNIMON |
- |
- |
TUNER_CLEAR_ENABLE |
ddis.dictionary.tuner_clear_enabled |
Включить очистку архивных конфигураций |
- |
true |
TUNER_CLEAR_PERIOD |
ddis.dictionary.tuner_clear_period |
Период очистки архивных конфигураций |
- |
30 |
FILE_PREFIX |
ddis.dictionary.env.file_prefix |
Префикс файла |
- |
distribution-dictionary |
SERVICE_NAME |
- |
Имя сервиса |
- |
distribution-dictionary |
CORE_POOL_SIZE |
ddis.dictionary.env.core_pool_size |
Начальное количество потоков |
- |
1 |
MAX_POOL_SIZE |
ddis.dictionary.env.max_pool_size |
Максимальное количество потоков |
- |
10 |
QUEUE_CAPACITY |
ddis.dictionary.env.queue_capacity |
Размера массива с задачами на исполнение |
- |
20 |
CREATE_COMMIT_INTERVAL |
ddis.dictionary.env.create_commit_interval |
Количество item после которых делать commit |
- |
1 |
CREATE_READER_CHUNK |
ddis.dictionary.env.create_reader_chunk |
Размер чанка на reader |
- |
1 |
CREATE_PROCESSOR_CHUNK |
ddis.dictionary.env.create_processor_chunk |
Размер чанка на processor |
- |
1 |
LOAD_COMMIT_INTERVAL |
ddis.dictionary.env.load_commit_interval |
Количество item после которых делать commit |
- |
50 |
LOAD_READER_CHUNK |
ddis.dictionary.env.load_reader_chunk |
Размер чанка на load |
- |
250 |
LOAD_PROCESSOR_CHUNK |
ddis.dictionary.env.load_processor_chunk |
Размер чанка на processor |
- |
250 |
TASK_CORE_POOL_SIZE |
ddis.dictionary.env.task_core_pool_size |
Начальное количество потоков |
- |
4 |
TASK_MAX_POOL_SIZE |
ddis.dictionary.env.task_max_pool_size |
Максимальное количество потоков |
- |
20 |
TASK_QUEUE_CAPACITY |
ddis.dictionary.env.task_queue_capacity |
Размера массива с задачами на исполнение |
- |
40 |
MANAGEMENT_METRICS_TAGS_APPLICATION |
- |
Теги метрик управления приложением |
- |
ddis-publish-lnse |
CONSUMER_REQUEST_DEBUG |
ddis.dictionary.env.consumer.request.debug |
Включить логирование запросов к потребителю |
- |
false |
application.schedlock.defaultLockAtMostFor |
ddis.dictionary.env.application.schedlock.defaultLockAtMostFor |
Максимальное время блокировки планировщика шедлоком |
- |
30s |
application.schedlock.defaultLockAtLeastFor |
ddis.dictionary.env.application.schedlock.defaultLockAtLeastFor |
Минимальное время блокировки планировщика шедлоком |
- |
30s |
ddis.graceful-shutdown.enabled |
- |
Определяет необходимость использования плавной остановки |
- |
true |
Описание параметров Фасад (ddis-facade)#
Параметры сервиса:
Имя параметра (PACMAN) |
Описание параметра |
Признак списочного параметра |
Тип данных |
Переменная дистрибутива |
Значение переменной/значение по умолчанию |
Условие применения |
|---|---|---|---|---|---|---|
platform.client.ip.header |
Название HTT заголовка, в котором содержится IP адрес клиента |
FALSE |
STRING |
- |
iv-remote-address |
Рестарт pod |
platform.http.timeout |
Тайм-аут http запроса |
FALSE |
LONG |
- |
10000 |
Рестарт pod |
pv.node.type |
Тип блока, принимает одно из 3-х допустимых значений: PRIMARY, SANDBOX, CTL |
FALSE |
STRING |
NODE_TYPE |
PRIMARY |
Рестарт pod |
ddis.facade.iam.logout |
Ссылка на выход из системы |
FALSE |
STRING |
ddis.facade.iam.logout.conf |
„global.ufs.logout.url“, default=“/openid-connect-auth/logout“ |
Рестарт pod |
ddis.facade.cm.return |
Ссылка на возврат в СМ |
FALSE |
STRING |
ddis.facade.cm.return.conf |
Ссылка входа в IAM, до UI SM нужно указать вручную |
Рестарт pod |
ufs.baseurl.stand_in |
URL эндпоинта Stand-In |
FALSE |
STRING |
- |
${ufs.standin.rest.client.base.url} |
Рестарт pod |
ufs.baseurl.REPLICATOR |
URL эндпоинта ufs-si-replicator-bh |
FALSE |
STRING |
- |
${ufs.standin.rest.client.base.url} |
Рестарт pod |
ufs.standin.db.suffix |
Суффикс схемы текущего блока |
FALSE |
STRING |
- |
${ufs.standin.dbsuffix} |
Рестарт pod |
ufs.standin.use.mocks_7.2 |
Флаг использования моков |
FALSE |
BOOLEAN |
- |
false |
Рестарт pod |
ufs.standin.mocks_7.2 |
Значения моков |
FALSE |
STRING |
- |
- |
Рестарт pod |
ufs.standin.rest.client.max.total.connections |
Максимальное количество подключений к эндпоинту Stand-In |
FALSE |
LONG |
- |
10 |
Рестарт pod |
ufs.standin.rest.client.max.per.route |
Максимальное количество соединений на маршрут для эндпоинта Stand-In |
FALSE |
LONG |
- |
10 |
Рестарт pod |
ufs.standin.rest.client.read.timeout |
Тайм-аут чтения из эндпоинта Stand-In |
FALSE |
LONG |
- |
3000 |
Рестарт pod |
ufs.standin.rest.client.connection.timeout |
Тайм-аут подключения к эндпоинту Stand-In |
FALSE |
LONG |
- |
500 |
Рестарт pod |
ufs.standin.rest.client.header.server.ip |
Элемент для конфигурации передачи IP-сервера в header |
FALSE |
STRING |
${ufs.standin.rest.client.header.server.ip} |
Рестарт pod |
|
ufs.standin.core.cache.enabled |
FALSE |
BOOLEAN |
false |
Рестарт pod |
||
ufs.standin.core.cache.ttl |
Значение TTL для локального кеша в клиентском модуле ФП Stand-In ядра платформы |
FALSE |
LONG |
- |
60000 |
Рестарт pod |
ufs.standin.core.cache.dead.ttl |
Значение deadTTL для локального кеша в клиентском модуле ФП Stand-In ядра платформы |
FALSE |
LONG |
- |
3600000 |
Рестарт pod |
ufs.standin.is.use.operation.uid |
Признак поиска в getReplicationStatus по operationUid |
FALSE |
BOOLEAN |
- |
false |
Рестарт pod |
integration.adapter.PLTFRMV.SrvBlockModeChangeConsumer.001.checkResponseSchema |
Включение валидации ответа |
FALSE |
BOOLEAN |
- |
true |
Рестарт pod |
integration.adapter.PLTFRMV.SrvBlockModeChangeConsumer.001.checkRequestSchema |
Включение валидации запроса |
FALSE |
BOOLEAN |
- |
true |
Рестарт pod |
integration.module.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.excludeAdapter |
Рубильник, позволяющий отключать/включать адаптер-ИМ (INNER) |
FALSE |
BOOLEAN |
- |
${ufs.standin.inner.message.disabled} |
Рестарт pod |
integration.module.PLTFRMV.SrvBlockModeChangeConsumer.001.excludeAdapter |
Рубильник, позволяющий отключать/включать адаптер-ИМ (PLTFRMV) |
FALSE |
BOOLEAN |
- |
${ufs.standin.external.message.disabled} |
Рестарт pod |
integration.module.PLTFRMV.SrvBlockModeChangeConsumer.001.kafkaTopicName |
Название топика |
FALSE |
STRING |
- |
${ufs.standin.subscribe.kafka.external.topic.name} |
Рестарт pod |
integration.module.PLTFRMV.SrvBlockModeChangeConsumer.001.transportType |
Тип транспорта ИМ |
FALSE |
STRING |
- |
${ufs.standin.pltfrmv.transportType} |
Рестарт pod |
integration.module.PLTFRMV.SrvBlockModeChangeConsumer.001.kafkaConsumerFactory |
Фабрика потребитель для ИМ |
FALSE |
STRING |
- |
kafka/external_factory/consumer_factory_1 |
Рестарт pod |
integration.module.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.topicConnectionFactory |
Connection Factory Round-Robin для Topic |
FALSE |
STRING |
- |
jms/factory/INNER_TOPIC_ROUND_ROBIN |
Рестарт pod |
integration.adapter.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.checkRequestSchema |
Включение валидации запроса |
FALSE |
BOOLEAN |
- |
true |
Рестарт pod |
integration.adapter.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.checkResponseSchema |
Включение валидации ответа |
FALSE |
BOOLEAN |
- |
true |
Рестарт pod |
integration.module.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.topicName |
Название топика |
FALSE |
STRING |
- |
${ufs.standin.root_topic_name}/%s/%s/%s |
Рестарт pod |
integration.module.UFS_INNER.srvblockmodechangeasync.001.CLIENT.transportType |
Тип транспорта ИМ для передачи уведомлений (внутриблочный механизм) |
FALSE |
STRING |
- |
${ufs.standin.ufsinner.transportType} |
Рестарт pod |
integration.module.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.kafkaConsumerFactory |
Фабрика-потребитель для ИМ |
FALSE |
STRING |
- |
kafka/inner_factory/consumer_factory |
Рестарт pod |
integration.module.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.kafkaProducerFactory |
Фабрика отправки сообщений для ИМ |
FALSE |
STRING |
- |
kafka/inner_factory/producer_factory |
Рестарт pod |
integration.module.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.kafkaTopicName |
Название топика |
FALSE |
STRING |
- |
${ufs.standin.subscribe.kafka.inner.topic.name} |
Рестарт pod |
ufs.standin.subscribe.adapter.message |
Используемые средства для получения сообщений о смене режима блока |
FALSE |
STRING |
- |
${ufs.standin.subscribe.adapter.message.use} |
Рестарт pod |
ufs.standin.is.use.ufs.force.node |
Признак обязательной установки HEADER UFS_FORCE_NODE |
FALSE |
BOOLEAN |
- |
false |
Рестарт pod |
ufs.httpclient.circuitBreaker.enable.STAND_IN |
Признак работы механизма circuit breaker |
FALSE |
BOOLEAN |
- |
true |
Рестарт pod |
ufs.httpclient.circuitBreaker.failureRate.threshold.percent.STAND_IN |
Процент отказов в потоке запросов. После превышения данного процента поток будет прерван (переход в режим OPEN) |
FALSE |
LONG |
- |
50 |
Рестарт pod |
ufs.httpclient.circuitBreaker.closed.requestBuffer.size.requestCount.STAND_IN |
Размер буфера запросов в режиме CLOSED (обычный режим работы потока запросов). После заполнения буфера рассчитывается процент отказов для принятия решения о прерывании потока запросов (переход в режим OPEN) |
FALSE |
LONG |
- |
120 |
Рестарт pod |
ufs.httpclient.circuitBreaker.halfOpen.requestBuffer.size.requestCount.STAND_IN |
Размер буфера запросов в режиме HALF_OPEN. После заполнения буфера рассчитывается процент отказов для принятия решения о повторном прерывании потока (переход в режим OPEN) или о переходе в обычный режим работы потока запросов (переход в режим CLOSED). Настройка объединяется с ringBufferSizeInClosedState и не доступна потребителям для изменений. По умолчанию значение для данной настройки „0“ и в этом случае реальный размер буфера запросов в режиме HALF_OPEN равен размеру буфера запросов в режиме CLOSED |
FALSE |
LONG |
- |
0 |
Рестарт pod |
ufs.httpclient.circuitBreaker.open.duration.milliseconds.STAND_IN |
Время ожидания перед переходом от режима работы OPEN к HALF_OPEN |
FALSE |
LONG |
- |
60000 |
Рестарт pod |
ufs.httpclient.circuitBreaker.smoothStart.rate.upperLimit.requestsPerSecond.STAND_IN |
Предел ограничения скорости запросов, при достижении которого, задача плавного старта завершается |
FALSE |
LONG |
- |
2 |
Рестарт pod |
ufs.httpclient.circuitBreaker.smoothStart.rate.startLimit.percent.STAND_IN |
Ограничение скорости запросов в момент запуска задачи плавного старта. Указывается в процентах от предела ограничения скорости запросов |
FALSE |
LONG |
- |
50 |
Рестарт pod |
ufs.httpclient.circuitBreaker.smoothStart.rate.limitChange.step.percent.STAND_IN |
Шаг изменения ограничения скорости запросов, в процессе работы задачи плавного старта. Указывается в процентах от предела ограничения скорости запросов |
FALSE |
LONG |
- |
5 |
Рестарт pod |
ufs.httpclient.circuitBreaker.record.exceptions.STAND_IN |
Список исключений, которые считаются ошибкой и влияют на механизм circuit breaker |
FALSE |
STRING |
- |
- |
Рестарт pod |
ufs.httpclient.circuitBreaker.record.httpException.codes.STAND_IN |
Список HTTP кодов для исключений, которые считаются ошибкой для механизма circuit breaker |
FALSE |
STRING |
- |
- |
Рестарт pod |
ufs.tenant.code |
Код тенанта |
FALSE |
STRING |
ufsparams_module_tenant_code |
„TENANT_CODE“ |
Рестарт pod |
ufsparams.module.monitoring.enabled |
Включение отправки метрики мониторинга при запросе параметра в ФП СУП. (true — метрики отправляются, false — метрики не отправляются) |
FALSE |
BOOLEAN |
ufsparams_module_monitoring_enabled |
false |
Рестарт pod |
ufs.baseUrl.AUTHORIZATION |
Путь к сервису авторизации |
FALSE |
STRING |
${global.platform.ufs.baseurl.security} |
Рестарт pod |
|
aim.auth.token.cookie.name |
Название куки токена аутентификации для ФП АиМ (Аутентификация и маршрутизация) |
FALSE |
STRING |
UFS-TOKEN |
Рестарт pod |
|
ufs.security.employee.identifier.sudir.header |
Название заголовка HTTP запроса с идентификатором сотрудника от СУДИР |
FALSE |
STRING |
- |
iv-user |
Рестарт pod |
ufs.security.employee.identifier.session.attribute |
Название мета-атрибута сессии с идентификатором сотрудника |
FALSE |
STRING |
- |
employeeLogin |
Рестарт pod |
ufs.security.employee.identifier.verification.enabled |
Признак проверки идентификатора сотрудника |
FALSE |
BOOLEAN |
- |
false |
Рестарт pod |
ufs.auth.routing.refresh.thread.pool.size |
Размер пула потоков для обновления токена маршрутизации |
FALSE |
LONG |
- |
3 |
Рестарт pod |
ufs.auth.routing.refresh.duration.milliseconds |
Ожидаемое время выполнения задачи по обновлению токена маршрутизации |
FALSE |
LONG |
- |
3000 |
Рестарт pod |
platform.auth.filter.nonclients.allowed |
Признак разрешения работы с ФП для неклиентов |
FALSE |
BOOLEAN |
- |
FALSE |
Рестарт pod |
platform.auth.filter.nonclients.client.type |
Название мета-атрибута сессии с идентификатором типа клиента для неклиентов |
FALSE |
STRING |
clientType |
Рестарт pod |
|
platform.auth.filter.nonclients.client.type.noclient |
Значение типа клиента для неклиентов |
FALSE |
STRING |
- |
guest |
Рестарт pod |
ufs.security.jwt.aud.list |
Список разрешенных значений для aud в jwt токене |
TRUE |
STRING |
- |
https://efs.sbrf.ru |
Рестарт pod |
ufsparams.agent.baseUrl.openshift |
Основной URL для IAG-mm (для OSE) |
FALSE |
STRING |
ufsparams_agent_baseUrl_insecure |
„global.ose.params.baseUrl.stringToBind“ |
Рестарт pod |
ufsparams.agent.baseUrl |
Основной URL для IAG-mm (для WAS) |
FALSE |
STRING |
ufsparams_agent_baseUrl_secure |
„global.params.baseUrl.stringToBind“ |
Рестарт pod |
ufsparams.agent.delay |
Интервал между проверками обновления конфигурации |
FALSE |
LONG |
ufsparams_agent_delay |
10000 |
Рестарт pod |
ufsparams.agent.max.file.size |
Максимальный размер файла конфигурации |
FALSE |
LONG |
ufsparams_agent_max_file_size |
104857600 |
Рестарт pod |
ufsparams.agent.min.file.size |
Минимальный размер файла конфигурации |
FALSE |
LONG |
ufsparams_agent_min_file_size |
50 |
Рестарт pod |
ufsparams.agent.ignore.file.pattern |
Паттерн, по которому Агент не будет отслеживать файл для обновления из БД |
FALSE |
STRING |
ufsparams_agent_ignore_file_pattern |
glob:**sup2_common.json |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.enable |
Признак работы механизма circuit breaker. Если указано false, то http вызов происходит без декорирования механизмом circuit breaker |
FALSE |
BOOLEAN |
ufsparams_agent_httpclient_circuitBreaker_enable |
false |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.failureRate.threshold |
Процент отказов в потоке запросов. После превышения данного процента поток будет прерван (переход в режим OPEN) |
FALSE |
LONG |
ufsparams_agent_httpclient_circuitBreaker_failureRate_threshold |
50 |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.openState.duration |
Время ожидания перед переходом от режима работы OPEN к HALF_OPEN |
FALSE |
LONG |
ufsparams_agent_httpclient_circuitBreaker_openState_duration |
60000 |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.halfOpen.requestBuffer |
Размер буфера запросов в режиме HALF_OPEN. После заполнения буфера рассчитывается процент отказов или процент медленных запросов для принятия решения о повторном прерывании потока (переход в режим OPEN) или о переходе в обычный режим работы потока запросов (переход в режим CLOSED). По умолчанию значение для данной настройки «0» и в этом случае реальный размер буфера запросов в режиме HALF_OPEN равен размеру буфера запросов в режиме CLOSED |
FALSE |
LONG |
ufsparams_agent_httpclient_circuitBreaker_halfOpen_requestBuffer |
0 |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.minimumCalls.size |
Минимальное количество вызовов, которое требуется (в режиме CLOSED), прежде чем CircuitBreaker сможет вычислить частоту ошибок. По умолчанию значение для данной настройки «10» |
FALSE |
LONG |
ufsparams_agent_httpclient_circuitBreaker_minimumCalls_size |
10 |
Рестарт pod |
ufsparams.agent.startup.synchronization.timeout |
- |
FALSE |
LONG |
ufsparams_agent_startup_synchronization_timeout |
3000 |
Рестарт pod |
audit.ufs.client_module.context.error_total_size_threshold |
Параметры для квотирования — пороговое значение для общего размера сообщений уровня WARN в TPS |
FALSE |
STRING |
- |
0 |
Рестарт pod |
audit.ufs.client_module.context.error_count_threshold |
Параметры для квотирования — пороговое значение для количества сообщений уровня ERROR в TPS |
FALSE |
STRING |
— |
0 |
Рестарт pod |
audit.ufs.client_module.context.warn_count_threshold |
Параметры для квотирования — пороговое значение для количества сообщений уровня WARN в TPS |
FALSE |
STRING |
— |
0 |
Рестарт pod |
audit.ufs.client_module.context.warn_total_size_threshold |
Параметры для квотирования — пороговое значение для общего размера сообщений уровня WARN в TPS |
FALSE |
STRING |
- |
0 |
Рестарт pod |
audit.ufs.client_module.context.quota_escalation_period |
Параметры для квотирования — время эскалации с уровня WARN до уровня ERROR в секундах |
FALSE |
STRING |
- |
0 |
Рестарт pod |
audit.ufs.client_module.context.max_async_send_tasks |
Параметр, задающий максимальное количество асинхронно выполняемых задач отправки событий аудита, которое может одновременно существовать в приложении при отправке событий методом |
FALSE |
STRING |
- |
1000 |
Рестарт pod |
readiness.retry.periodSeconds |
Как часто приложение делает попытки отправки в аудит |
FALSE |
LONG |
- |
20 |
Рестарт pod |
ufs.standin.node.path |
- |
FALSE |
STRING |
- |
Рестарт pod |
Переменные окружения:
Переменная окружения |
Переменная дистрибутива |
Описание переменной окружения |
Единица измерения |
Значение по умолчанию |
|---|---|---|---|---|
SERVER_PORT |
ddis.facade.env.port.application |
Порт публичного интерфейса |
- |
8080 |
MANAGEMENT_SERVER_PORT |
ddis.facade.env.port.management |
Порт интерфейса управления |
- |
8083 |
MANAGEMENT_METRICS_TAGS_APPLICATION |
- |
Теги метрик управления приложением |
- |
ddis-facade |
MANAGEMENT_ENDPOINTS_WEB_EXPOSURE_INCLUDE |
- |
Ресурсы интерфейса управления |
- |
health,info,env,loggers,prometheus,metrics,gateway |
AUTH_ENABLED |
ddis.facade.env.auth_enabled |
Включение режима авторизации |
- |
true |
ddis.graceful-shutdown.enabled |
- |
Определяет необходимость использования плавной остановки |
- |
true |
ddis.graceful-shutdown.delay |
ddis.shutdown.timeout |
Время ожидания при выполнении обработчика |
- |
10000 |
SERVER_SHUTDOWN |
- |
Функциональность, обеспечивающая плавную остановку приложения |
- |
graceful |
SPRING_LIFECYCLE_TIMEOUTPERSHUTDOWNPHASE |
- |
Свойство в Spring Boot, которое контролирует максимальное время, выделенное для каждой фазы процесса выключения приложения |
- |
30s |
UFS_AUDIT_CLIENT_STUB |
- |
Включение режима заглушки аудита |
- |
false |
ufs.audit.client.context.audit.CImodule |
ddis.facade.union-audit.CImodule |
Идентификатор услуги, прикладной фабрики или КЭ (конфигурационного элемента) |
- |
_ddis-facade |
ufs.audit.client.context.audit.sourceSystem |
ddis.facade.union-audit.sourceSystem |
Название/КЭ АС, которая является источником события. Единый для всех компонентов АС-инсталляции |
- |
global.platform.union-audit.sourceSystem |
ufs.audit.client.module |
ddis.facade.env.audit.audm.module |
Название микросервиса DDIS |
- |
ddis-facade |
UserNode.NotOverride |
- |
Для передачи userNode напрямую через метод audit |
- |
true |
MANAGEMENT_ENDPOINT_HEALTH_SHOW_DETAILS |
ddis.facade.env.management.endpoint.health.show.details |
Параметр для определения объема информации, предоставляемой конечной точкой health |
- |
always |
MANAGEMENT_ENDPOINT_HEALTH_GROUP_LIVENESS_INCLUDE |
ddis.facade.env.management.endpoint.health.group.liveness.include |
Список идентификаторов работоспособности для группы LIVE |
- |
diskSpace,ping |
MANAGEMENT_ENDPOINT_HEALTH_GROUP_READINESS_INCLUDE |
ddis.facade.env.management.endpoint.health.group.readiness.include |
Список идентификаторов работоспособности для группы READY |
- |
ping |
IMHEALTH_ENABLED |
ddis.facade.env.integrationModuleHealth.enabled |
Параметр включения влияния статуса IntegrationModuleHealth на общий статус healthcheck |
- |
false |
Описание параметров Контроллера (ddis-controller)#
Параметры сервиса:
Имя параметра (PACMAN) |
Описание параметра |
Признак списочного параметра |
Тип данных |
Переменная дистрибутива |
Значение переменной/значение по умолчанию |
Условие применения |
|---|---|---|---|---|---|---|
platform.client.ip.header |
Название HTTP заголовка, в котором содержится IP адрес клиента |
FALSE |
STRING |
- |
iv-remote-address |
Рестарт pod |
platform.http.timeout |
Тайм-аут HTTP запроса |
FALSE |
LONG |
10000 |
Рестарт pod |
|
pv.node.type |
Тип блока, принимает одно из 3-х допустимых значений: PRIMARY, SANDBOX, CTL |
FALSE |
STRING |
NODE_TYPE |
PRIMARY |
Рестарт pod |
ufs.tenant.code |
Код тенанта |
FALSE |
STRING |
ufsparams_module_tenant_code |
„TENANT_CODE“ |
Рестарт pod |
ufsparams.module.monitoring.enabled |
Включение отправки метрики мониторинга при запросе параметра (true — метрики отправляются, false — метрики не отправляются) |
FALSE |
BOOLEAN |
ufsparams_module_monitoring_enabled |
false |
Рестарт pod |
ufsparams.agent.baseUrl.openshift |
Основной URL для IAG-mm (для OSE) |
FALSE |
STRING |
ufsparams_agent_baseUrl_insecure |
„global.ose.params.baseUrl.stringToBind“ |
Рестарт pod |
ufsparams.agent.baseUrl |
Основной URL для IAG-mm (для WAS) |
FALSE |
STRING |
ufsparams_agent_baseUrl_secure |
„global.params.baseUrl.stringToBind“ |
Рестарт pod |
ufsparams.agent.delay |
Интервал между проверками обновления конфигурации |
FALSE |
LONG |
ufsparams_agent_delay |
10000 |
Рестарт pod |
ufsparams.agent.max.file.size |
Максимальный размер файла конфигурации |
FALSE |
LONG |
ufsparams_agent_max_file_size |
104857600 |
Рестарт pod |
ufsparams.agent.min.file.size |
Минимальный размер файла конфигурации |
FALSE |
LONG |
ufsparams_agent_min_file_size |
50 |
Рестарт pod |
ufsparams.agent.ignore.file.pattern |
Паттерн, по которому Агент не будет отслеживать файл для обновления из БД |
FALSE |
STRING |
ufsparams_agent_ignore_file_pattern |
glob:**sup2_common.json |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.enable |
Признак работы механизма circuit breaker. Если указано false, то http вызов происходит без декорирования механизмом circuit breaker |
FALSE |
BOOLEAN |
ufsparams_agent_httpclient_circuitBreaker_enable |
false |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.failureRate.threshold |
Процент отказов в потоке запросов. После превышения данного процента поток будет прерван (переход в режим OPEN) |
FALSE |
LONG |
ufsparams_agent_httpclient_circuitBreaker_failureRate_threshold |
50 |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.openState.duration |
Время ожидания перед переходом от режима работы OPEN к HALF_OPEN |
FALSE |
LONG |
ufsparams_agent_httpclient_circuitBreaker_openState_duration |
60000 |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.halfOpen.requestBuffer |
Размер буфера запросов в режиме HALF_OPEN. После заполнения буфера рассчитывается процент отказов или процент медленных запросов для принятия решения о повторном прерывании потока (переход в режим OPEN) или о переходе в обычный режим работы потока запросов (переход в режим CLOSED). По умолчанию значение для данной настройки «0» и в этом случае реальный размер буфера запросов в режиме HALF_OPEN равен размеру буфера запросов в режиме CLOSED |
FALSE |
LONG |
ufsparams_agent_httpclient_circuitBreaker_halfOpen_requestBuffer |
0 |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.minimumCalls.size |
Минимальное количество вызовов, которое требуется (в режиме CLOSED), прежде чем CircuitBreaker сможет вычислить частоту ошибок. По умолчанию значение для данной настройки «10» |
FALSE |
LONG |
ufsparams_agent_httpclient_circuitBreaker_minimumCalls_size |
10 |
Рестарт pod |
ufsparams.agent.startup.synchronization.timeout |
FALSE |
LONG |
ufsparams_agent_startup_synchronization_timeout |
3000 |
Рестарт pod |
|
ddis.hotreload.db.toggle |
Включение/отключение функциональности hotreload для секретов БД в обработчике события |
FALSE |
BOOLEAN |
- |
true |
Runtime, без рестарта pod |
audit.ufs.client_module.context.error_total_size_threshold |
Параметры для квотирования — пороговое значение для общего размера сообщений уровня WARN в TPS |
FALSE |
STRING |
- |
0 |
Рестарт pod |
audit.ufs.client_module.context.error_count_threshold |
Параметры для квотирования — пороговое значение для количества сообщений уровня ERROR в TPS |
FALSE |
STRING |
- |
0 |
Рестарт pod |
audit.ufs.client_module.context.warn_count_threshold |
Параметры для квотирования — пороговое значение для количества сообщений уровня WARN в TPS |
FALSE |
STRING |
- |
0 |
Рестарт pod |
audit.ufs.client_module.context.warn_total_size_threshold |
Параметры для квотирования — пороговое значение для общего размера сообщений уровня WARN в TPS |
FALSE |
STRING |
- |
0 |
Рестарт pod |
audit.ufs.client_module.context.quota_escalation_period |
Параметры для квотирования — время эскалации с уровня WARN до уровня ERROR в секундах |
FALSE |
STRING |
- |
0 |
Рестарт pod |
audit.ufs.client_module.context.max_async_send_tasks |
Параметр, задающий максимальное количество асинхронно выполняемых задач отправки событий аудита, которое может одновременно существовать в приложении при отправке событий методом |
FALSE |
STRING |
- |
1000 |
Рестарт pod |
ddis.controller.resources.enabled |
Включение функциональности загрузки записей из JSON файлов |
FALSE |
BOOLEAN |
- |
false |
Рестарт pod |
hotreload.timeUpperBound |
Верхняя граница времени применения секрета (позже этого времени применение секрета не начнется) |
FALSE |
LONG |
- |
150 |
Runtime, без рестарта pod |
hotreload.timeLowerBound |
Нижняя граница времени применения секрета (раньше этого времени применение секрета не начнется) |
FALSE |
LONG |
- |
5 |
Runtime, без рестарта pod |
ufs.standin.node.path |
FALSE |
STRING |
- |
Рестарт pod |
Переменные окружения:
Переменная окружения |
Переменная дистрибутива |
Описание переменной окружения |
Единица измерения |
Значение по умолчанию |
|---|---|---|---|---|
SERVER_PORT |
ddis.controller.env.server_port |
Порт публичного интерфейса |
- |
8080 |
DATASOURCE_URL |
ddis.controller.env.datasource_url |
Адрес базы данных компонента формируется исходя из следующего набора параметров. |
- |
Обязательно к заполнению |
DATASOURCE_MINIMUM_IDLE |
ddis.controller.env.datasource_minimum_idle |
Минимальное количество простаивающих соединений к базе данных компонента |
- |
1 |
DATASOURCE_MAXIMUM_POOL_SIZE |
ddis.controller.env.datasource_maximum_pool_size |
Максимальное количество соединений с базой данных компонента |
- |
5 |
DATASOURCE_SCHEMA |
- |
Схема базы данных компонента |
- |
ddis_controller |
HIBERNATE_DIALECT |
ddis.controller.env.hibernate_dialect |
Диалект базы данных компонента |
- |
org.hibernate.dialect.PostgreSQL10Dialect |
HIBERNATE_HBM2DDL_AUTO |
- |
Режим автоматического обновления схемы базы данных компонента |
- |
none |
RESOURCES_PATH |
- |
Параметр указывающий путь к каталогу с предварительно подготовленными записями в формате JSON, предназначенными для загрузки в БД на старте приложения |
- |
file:///app/resources/db/json/ |
RETRYING_DELAY |
ddis.controller.env.application.retrying.delay |
Определение задержки переотправки распространения, у которых статус ERROR |
- |
60000 |
WATCHING_HEARTBEAT |
ddis.controller.env.watching_heartbeat |
Интервал опроса процессора при мониторинге распространения |
- |
1000 |
SHUTDOWN_TIMEOUT |
ddis.controller.env.shutdown_timeout |
Максимальное время завершения приложения. По истечении указанного времени внутренние процессы компонента будут завершены принудительно |
- |
60000 |
MANAGEMENT_SERVER_PORT |
ddis.controller.env.management_server_port |
Порт интерфейса управления |
- |
8083 |
MANAGEMENT_ENDPOINTS |
- |
Ресурсы интерфейса управления |
- |
env,health,info,loggers,metrics,prometheus |
MANAGEMENT_APPLICATION_TAG |
- |
Значение тега application |
- |
ddis-controller |
MAX_HTTP_HEADER_SIZE |
ddis.server.max-http-header-size |
Максимальный размер HTTP заголовка |
- |
32768 |
MAX_FILE_SIZE |
ddis.env.maxFileSize |
Максимальный размер файла в составном (multipart) HTTP-запросе |
- |
2GB |
MAX_REQUEST_SIZE |
ddis.env.maxRequestSize |
Максимальный размер составного (multipart) HTTP-запроса |
- |
2GB |
HTTP_REQUEST_TIMEOUT |
ddis.controller.env.http.request_timeout |
Тайм-аут запроса |
- |
120000 |
HTTP_CONNECTION_TIMEOUT |
ddis.controller.env.http.connection_timeout |
Тайм-аут подключения HTTP |
- |
120000 |
ufs.audit.client.module |
ddis.controller.env.audit.audm.module |
Название микросервиса DDIS |
- |
ddis-controller |
DDIS_AUDIT_AUDM_DEFAULTUSERNODE |
ddis.controller.env.audit.defaultUserNode |
Параметр, задающий значение, которое проставляется в событие аудита в поле адреса клиента userNode в случае, если событие аудита создается не по запросу пользователя |
- |
0.0.0.0 |
DDIS_AUDIT_AUDM_SOURCESYSTEM |
ddis.controller.union-audit.sourceSystem |
Параметр, задающий значение, которое проставляется в событие аудита в поле с названием АС-источника события |
- |
global.platform.union-audit.sourceSystem default=“FS“ |
ddis.audit.client |
- |
Параметр, задающий определение типа клиента, используемого для отправки аудита |
- |
AUDM |
ufs.audit.client.context.audit.CImodule |
ddis.controller.union-audit.CImodule |
Название микросервиса DDIS |
- |
_ddis-controller |
ddis.environment.tenantCode |
- |
Позволяет статически задать код тенанта через кастомную реализацию |
- |
TENANT_CODE |
ddis.environment.nodePath |
- |
Позволяет статически задать код узла через кастомную реализацию |
- |
NODE_PATH |
ufs.healthcheck.stub-agent-enabled |
- |
Параметр включения заглушки агента PACMAN. Значение по умолчанию false |
- |
false |
ufs.platform.environment.product.deployment-unit |
- |
Название элемента развертывания |
- |
ddis-controller |
APPLICATION_ERRORS_IGNOREINCREMENT |
ddis.controller.env.application.errors.ignore-increment |
Параметр, задающий регулярное выражение для определения ошибок при обращении к процессорам, для которых не следует увеличивать счетчик попыток выполнить распространение |
- |
503 ServiceUnavailable |
ddis.graceful-shutdown.enabled |
- |
Определяет необходимость использования плавной остановки |
- |
true |
ddis.graceful-shutdown.delay |
ddis.shutdown.timeout |
Время ожидания при выполнении обработчика |
- |
10000 |
SERVER_SHUTDOWN |
- |
Функциональность, обеспечивающая плавную остановку приложения |
- |
graceful |
SPRING_LIFECYCLE_TIMEOUTPERSHUTDOWNPHASE |
- |
Свойство в Spring Boot, которое контролирует максимальное время, выделенное для каждой фазы процесса выключения приложения |
- |
30s |
MANAGEMENT_ENDPOINT_HEALTH_SHOW_DETAILS |
ddis.controller.env.management.endpoint.health.show.details |
Параметр для определения объема информации, предоставляемой конечной точкой health |
- |
always |
MANAGEMENT_ENDPOINT_HEALTH_GROUP_LIVENESS_INCLUDE |
ddis.controller.env.management.endpoint.health.group.liveness.include |
Список идентификаторов работоспособности для группы LIVE |
- |
diskSpace,ping |
MANAGEMENT_ENDPOINT_HEALTH_GROUP_READINESS_INCLUDE |
ddis.controller.env.management.endpoint.health.group.readiness.include |
Список идентификаторов работоспособности для группы READY |
- |
db,ping |
Описание параметров Трансформера (ddis-transformer)#
Параметры сервиса:
Имя параметра (PACMAN) |
Описание параметра |
Признак списочного параметра |
Тип данных |
Переменная дистрибутива |
Значение переменной/значение по умолчанию |
Условие применения |
|---|---|---|---|---|---|---|
ddis.hotreload.db.toggle |
Включение/выключение функциональности hotreload для секретов БД в обработчике события |
FALSE |
BOOLEAN |
ddis.hotreload.db.toggle |
true |
Runtime, без рестарта pod |
ddis.hotreload.filestorage.toggle |
Включение/выключение функциональности hotreload для секретов хранилища файлов |
FALSE |
BOOLEAN |
ddis.hotreload.filestorage.toggle |
true |
Runtime, без рестарта pod |
ddis.transformer.invalidation.cron |
Cron выражение. Расписание запуска задачи инвалидации долго выполняющихся задач трансформации |
FALSE |
STRING |
- |
0 0/3 * * * ? |
Runtime, без рестарта pod |
ddis.transformer.invalidation.timeout.minutes |
Период в минутах, по истечении которого долго выполняющимся задачам трансформации будет проставлен статус ERROR |
FALSE |
LONG |
ddis.transformer.invalidation.timeout.minutes |
60 |
Runtime, без рестарта pod |
ddis.transformer.transformation.cron |
Cron выражение. Расписание запуска трансформации |
FALSE |
STRING |
ddis.transformer.transformation.cron |
0 0/1 * * * ? |
Runtime, без рестарта pod |
healthcheck.cascadeprotection.attempt.period |
Задержка перед повторной попыткой обработки метрик и установки флага (в миллисекундах) |
FALSE |
LONG |
- |
10000 |
Рестарт pod |
healthcheck.cascadeprotection.chatter.percent |
Процент значений метрик, превышающих дребезг |
FALSE |
LONG |
- |
50 |
Рестарт pod |
healthcheck.cascadeprotection.chatter.step.count |
Объем выборки окна дребезга |
FALSE |
LONG |
- |
5 |
Рестарт pod |
healthcheck.cascadeprotection.errorcode |
Код ошибки для механизма защиты от каскадных отказов |
FALSE |
LONG |
healthcheck.cascadeprotection.serviceunavailable |
503 |
Рестарт pod |
healthcheck.metric.logger.attempt.period |
Периодичность логирования ошибок незаданных пороговых значений (в миллисекундах) |
FALSE |
LONG |
- |
600000 |
Рестарт pod |
healthcheck.metric.logger.level |
Уровень логирования ошибок незаданных пороговых значений |
FALSE |
STRING |
- |
WARN |
Рестарт pod |
healthcheck.metric.task.attempt.period |
Задержка перед повторной попыткой снятия метрик |
FALSE |
LONG |
- |
2000 |
Рестарт pod |
hotreload.timeLowerBound |
Нижняя граница времени применения секрета (раньше этого времени применение секрета не начнется) |
FALSE |
LONG |
- |
5 |
Runtime, без рестарта pod |
hotreload.timeUpperBound |
Верхняя граница времени применения секрета (позже этого времени применение секрета не начнется) |
FALSE |
LONG |
- |
150 |
Runtime, без рестарта pod |
monitoring.metrics.infra.exclude |
Регулярное выражение для исключения инфраструктурных метрик мониторинга из публикации в микрометр registry true/false |
FALSE |
STRING |
- |
- |
Рестарт pod |
monitoring.metrics.micrometer.publish.idle |
Не публиковать метрики мониторинга в микрометр registry true/false |
FALSE |
BOOLEAN |
- |
false |
Рестарт pod |
platform.client.ip.header |
Название HTTP заголовка, в котором содержится IP адрес клиента |
FALSE |
STRING |
- |
iv-remote-address |
Рестарт pod |
platform.http.timeout |
Таймаут HTTP запроса |
FALSE |
LONG |
ufs.platform.http.timeout |
60000 |
Рестарт pod |
pv.node.type |
Тип блока, принимает одно из 3-х допустимых значений: PRIMARY, SANDBOX, CTL |
FALSE |
STRING |
NODE_TYPE |
PRIMARY |
Рестарт pod |
susd.client.header.names.to.proxy |
Список заголовков через запятую, которые КМ ССД берет из текущих бизнес-запросов в запросы к кластеру |
FALSE |
STRING |
props.susd.header.names.to.proxy |
UFS-GO-NODE$$$iag_routing_header$$$ |
Рестарт pod |
susd.client.preferred.node.header.name |
Имя header запроса для его отправки в предпочитаемый контур (nodeCode, пока значение не получено из кластера) |
FALSE |
STRING |
- |
UFS-PREFERRED-NODE |
Рестарт pod |
susd.client.target.node.header.name |
Имя header запроса для его отправки в требуемый контур (nodeCode) |
FALSE |
STRING |
- |
UFS-GO-NODE |
Рестарт pod |
susd.client.target.node.header.tmp.forced.value |
Временное принудительное значение для header запроса, направляющего его в требуемый контур (nodeCode). „-“ — отсутствие значения |
FALSE |
STRING |
- |
- |
Рестарт pod |
susd.client.target.node.random.selection.header.name |
Имя header запроса для случайного выбора требуемого контура (nodeCode, пока значение не получено из кластера) |
FALSE |
STRING |
- |
UFS-REPLICA-KEY |
Рестарт pod |
susd.cluster.baseurl |
URL для доступа клиентского модуля ССД к серверной части ССД |
FALSE |
STRING |
props.susd.cluster.baseurl |
„global.ose.platform.ufs.baseurl.sds.master“ |
Рестарт pod |
susd.cluster.context.path |
Context path серверной части ССД |
FALSE |
STRING |
props.susd.cluster.balancer.deploy.unit.name |
ufs-session-master$$$sandbox_suffix$$$/rest |
Рестарт pod |
ufs.baseurl.susd |
Базовый URL для доступа к серверной части ССД |
FALSE |
STRING |
- |
Not used |
Рестарт pod |
ufs.baseurl.susd.healthcheck |
Базовый URL для доступа для запросов healthcheck к серверной части ССД |
FALSE |
STRING |
- |
Not used |
Рестарт pod |
ufs.httpclient.bulkhead.enable.susd |
Признак работы механизма bulkHead |
FALSE |
BOOLEAN |
- |
true |
Рестарт pod |
ufs.httpclient.bulkhead.enable.susd.healthcheck |
Признак работы механизма bulkHead |
FALSE |
BOOLEAN |
- |
true |
Рестарт pod |
ufs.httpclient.bulkhead.max-attempts.susd |
Максимальное количество попыток повтора применения функциональности bulkHead |
FALSE |
LONG |
- |
30 |
Рестарт pod |
ufs.httpclient.bulkhead.max-attempts.susd.healthcheck |
Максимальное количество попыток повтора применения функциональности bulkHead |
FALSE |
LONG |
- |
30 |
Рестарт pod |
ufs.httpclient.bulkhead.max-concurrent-calls.susd |
Максимальное количество конкурентных вызовов методов-обработчиков в параллельных потоках |
FALSE |
LONG |
- |
150 |
Рестарт pod |
ufs.httpclient.bulkhead.max-concurrent-calls.susd.healthcheck |
Максимальное количество конкурентных вызовов методов-обработчиков в параллельных потоках |
FALSE |
LONG |
- |
150 |
Рестарт pod |
ufs.httpclient.bulkhead.wait-duration.susd |
Время ожидания для bulkHead при достижении максимального количества конкурентных вызовов (в миллисекундах) |
FALSE |
LONG |
- |
100 |
Рестарт pod |
ufs.httpclient.bulkhead.wait-duration.susd.healthcheck |
Время ожидания для bulkHead при достижении максимального количества конкурентных вызовов (в миллисекундах) |
FALSE |
LONG |
- |
100 |
Рестарт pod |
ufs.httpclient.circuit-breaker.enable.susd |
Признак работы механизма circuit breaker |
FALSE |
BOOLEAN |
- |
false |
Рестарт pod |
ufs.httpclient.circuit-breaker.enable.susd.healthcheck |
Признак работы механизма circuit breaker |
FALSE |
BOOLEAN |
- |
false |
Рестарт pod |
ufs.httpclient.circuit-breaker.failure-rate.threshold.percent.susd |
Максимальный процент ошибок в потоке запросов, после превышения которого circuit breaker перейдет в режим OPEN, и поток запросов будет прерван |
FALSE |
LONG |
- |
50 |
Рестарт pod |
ufs.httpclient.circuit-breaker.failure-rate.threshold.percent.susd.healthcheck |
Максимальный процент ошибок в потоке запросов, после превышения которого circuit breaker перейдет в режим OPEN, и поток запросов будет прерван |
FALSE |
LONG |
- |
50 |
Рестарт pod |
ufs.httpclient.circuit-breaker.record.exceptions.susd |
Список исключений, которые считаются ошибкой и влияют на механизм circuit breaker |
FALSE |
STRING |
- |
- |
Рестарт pod |
ufs.httpclient.circuit-breaker.record.exceptions.susd.healthcheck |
Список исключений, которые считаются ошибкой и влияют на механизм circuit breaker |
FALSE |
STRING |
- |
- |
Рестарт pod |
ufs.httpclient.circuit-breaker.record.httpException.codes.susd |
Список HTTP-кодов для исключений, которые считаются ошибкой для механизма circuit breaker |
FALSE |
STRING |
- |
- |
Рестарт pod |
ufs.httpclient.circuit-breaker.record.httpException.codes.susd.healthcheck |
Список HTTP-кодов для исключений, которые считаются ошибкой для механизма circuit breaker |
FALSE |
STRING |
- |
- |
Рестарт pod |
ufs.httpclient.circuit-breaker.smooth-start.rate-limit.change-step.percent.susd |
Шаг изменения ограничения скорости запросов в процессе работы задачи плавного старта. Указывается в процентах от предела ограничения скорости запросов |
FALSE |
LONG |
- |
5 |
Рестарт pod |
ufs.httpclient.circuit-breaker.smooth-start.rate-limit.change-step.percent.susd.healthcheck |
Шаг изменения ограничения скорости запросов в процессе работы задачи плавного старта. Указывается в процентах от предела ограничения скорости запросов |
FALSE |
LONG |
- |
5 |
Рестарт pod |
ufs.httpclient.circuit-breaker.smooth-start.rate-limit.start.percent.susd |
Ограничение скорости запросов в момент запуска задачи плавного старта. Указывается в процентах от предела ограничения скорости запросов |
FALSE |
LONG |
- |
50 |
Рестарт pod |
ufs.httpclient.circuit-breaker.smooth-start.rate-limit.start.percent.susd.healthcheck |
Ограничение скорости запросов в момент запуска задачи плавного старта. Указывается в процентах от предела ограничения скорости запросов |
FALSE |
LONG |
- |
50 |
Рестарт pod |
ufs.httpclient.circuit-breaker.smooth-start.rate-limit.upper.requests-per-second.susd |
Предел ограничения скорости запросов, при достижении которого задача плавного старта завершается |
FALSE |
LONG |
- |
2 |
Рестарт pod |
ufs.httpclient.circuit-breaker.smooth-start.rate-limit.upper.requests-per-second.susd.healthcheck |
Предел ограничения скорости запросов, при достижении которого задача плавного старта завершается |
FALSE |
LONG |
- |
2 |
Рестарт pod |
ufs.httpclient.circuit-breaker.state.closed.request-buffer.size.request-count.susd |
Размер буфера запросов для режима CLOSED, после заполнения которого рассчитывается процент ошибок в потоке запросов |
FALSE |
LONG |
- |
120 |
Рестарт pod |
ufs.httpclient.circuit-breaker.state.closed.request-buffer.size.request-count.susd.healthcheck |
Размер буфера запросов для режима CLOSED, после заполнения которого рассчитывается процент ошибок в потоке запросов |
FALSE |
LONG |
- |
120 |
Рестарт pod |
ufs.httpclient.circuit-breaker.state.half-open.request-buffer.size.request-count.susd |
Размер буфера запросов для режима HALF_OPEN, после заполнения которого рассчитывается процент ошибок в потоке запросов |
FALSE |
LONG |
- |
0 |
Рестарт pod |
ufs.httpclient.circuit-breaker.state.half-open.request-buffer.size.request-count.susd.healthcheck |
Размер буфера запросов для режима HALF_OPEN, после заполнения которого рассчитывается процент ошибок в потоке запросов |
FALSE |
LONG |
- |
0 |
Рестарт pod |
ufs.httpclient.circuit-breaker.state.open.duration.milliseconds.susd |
Длительность режима OPEN механизма circuit breaker, в течение действия которого поток запросов прерван (в миллисекундах) |
FALSE |
LONG |
- |
60000 |
Рестарт pod |
ufs.httpclient.circuit-breaker.state.open.duration.milliseconds.susd.healthcheck |
Длительность режима OPEN механизма circuit breaker, в течение действия которого поток запросов прерван (в миллисекундах) |
FALSE |
LONG |
- |
60000 |
Рестарт pod |
ufs.httpclient.connections.max.per-route.susd |
Максимальное количество соединений от КМ ССД к серверной части ССД на узел |
FALSE |
LONG |
ufs.httpclient.connections.max.per-route.susd |
150 |
Рестарт pod |
ufs.httpclient.connections.max.per-route.susd.healthcheck |
Максимальное количество соединений для запросов healthcheck от КМ ССД к серверной части ССД на узел |
FALSE |
LONG |
ufs.httpclient.connections.max.per-route.susd.healthcheck |
3 |
Рестарт pod |
ufs.httpclient.connections.max.total.susd |
Максимальное количество соединений от КМ ССД к серверной части ССД |
FALSE |
LONG |
ufs.httpclient.connections.max.total.susd |
150 |
Рестарт pod |
ufs.httpclient.connections.max.total.susd.healthcheck |
Максимальное количество соединений для запросов healthcheck от КМ ССД к серверной части ССД |
FALSE |
LONG |
ufs.httpclient.connections.max.total.susd.healthcheck |
3 |
Рестарт pod |
ufs.httpclient.headers.name.server-ip.susd |
Конфигурация передачи IP-адреса сервера в заголовке от КМ ССД к серверной части ССД |
FALSE |
STRING |
- |
ufs-client-ip |
Рестарт pod |
ufs.httpclient.headers.name.server-ip.susd.healthcheck |
Конфигурация передачи IP-адреса сервера в заголовке от КМ ССД к серверной части ССД |
FALSE |
STRING |
- |
ufs-client-ip |
Рестарт pod |
ufs.httpclient.time-out.connection.milliseconds.susd |
Таймаут на соединение от КМ ССД к серверной части ССД (в миллисекундах) |
FALSE |
LONG |
- |
500 |
Рестарт pod |
ufs.httpclient.time-out.connection.milliseconds.susd.healthcheck |
Таймаут на соединение для запросов healthcheck от КМ ССД к серверной части ССД (в миллисекундах) |
FALSE |
LONG |
- |
500 |
Рестарт pod |
ufs.httpclient.time-out.request.milliseconds.susd |
Таймаут запросов от КМ ССД к серверной части ССД (в миллисекундах) |
FALSE |
LONG |
- |
3000 |
Рестарт pod |
ufs.httpclient.time-out.request.milliseconds.susd.healthcheck |
Таймаут запросов healthcheck от КМ ССД к серверной части ССД (в миллисекундах) |
FALSE |
LONG |
ufs.httpclient.time-out.request.milliseconds.susd.healthcheck |
3000 |
Рестарт pod |
ufs.standin.node.path |
FALSE |
STRING |
- |
{{ NODE_PATH « |
default(„“) }} |
|
ufs.tenant.code |
Код тенанта |
FALSE |
STRING |
ufsparams_module_tenant_code |
„TENANT_CODE“ |
Рестарт pod |
ufsparams.agent.baseUrl |
Основной URL для IAG-mm (для WAS) |
FALSE |
STRING |
ufsparams_agent_baseUrl_secure |
„global.params.baseUrl.stringToBind“ |
Рестарт pod |
ufsparams.agent.baseUrl.openshift |
Основной URL для IAG-mm (для OSE) |
FALSE |
STRING |
ufsparams_agent_baseUrl_insecure |
„global.ose.params.baseUrl.stringToBind“ |
Рестарт pod |
ufsparams.agent.delay |
Интервал между проверками обновления конфигурации |
FALSE |
LONG |
ufsparams_agent_delay |
10000 |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.enable |
Признак работы механизма circuit breaker. Если указано false, то HTTP вызов происходит без декорирования механизмом circuit breaker. |
FALSE |
BOOLEAN |
ufsparams_agent_httpclient_circuitBreaker_enable |
false |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.failureRate.threshold |
Процент отказов в потоке запросов. После превышения данного процента поток будет прерван (переход в режим OPEN) |
FALSE |
LONG |
ufsparams_agent_httpclient_circuitBreaker_failureRate_threshold |
50 |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.halfOpen.requestBuffer |
Размер буфера запросов в режиме HALF_OPEN. После заполнения буфера рассчитывается процент отказов или процент медленных запросов для принятия решения о повторном прерывании потока (переход в режим OPEN) или о переходе в обычный режим работы потока запросов (переход в режим CLOSED). По умолчанию значение для данной настройки «0» и в этом случае реальный размер буфера запросов в режиме HALF_OPEN равен размеру буфера запросов в режиме CLOSED |
FALSE |
LONG |
ufsparams_agent_httpclient_circuitBreaker_halfOpen_requestBuffer |
0 |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.minimumCalls.size |
Минимальное количество вызовов, которое требуется (в режиме CLOSED), прежде чем CircuitBreaker сможет вычислить частоту ошибок. По умолчанию значение для данной настройки «10» |
FALSE |
LONG |
ufsparams_agent_httpclient_circuitBreaker_minimumCalls_size |
10 |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.openState.duration |
Время ожидания перед переходом от режима работы OPEN к HALF_OPEN |
FALSE |
LONG |
ufsparams_agent_httpclient_circuitBreaker_openState_duration |
60000 |
Рестарт pod |
ufsparams.agent.ignore.file.pattern |
Паттерн, по которому Агент не будет отслеживать файл для обновления из БД |
FALSE |
STRING |
ufsparams_agent_ignore_file_pattern |
glob:**sup2_common.json |
Рестарт pod |
ufsparams.agent.max.file.size |
Максимальный размер файла конфигурации |
FALSE |
LONG |
ufsparams_agent_max_file_size |
104857600 |
Рестарт pod |
ufsparams.agent.min.file.size |
Минимальный размер файла конфигурации |
FALSE |
LONG |
ufsparams_agent_min_file_size |
50 |
Рестарт pod |
ufsparams.agent.startup.synchronization.timeout |
- |
FALSE |
LONG |
ufsparams_agent_startup_synchronization_timeout |
3000 |
Рестарт pod |
ufsparams.module.monitoring.enabled |
Включение отправки метрики мониторинга при запросе параметра в ФП СУП. (true — метрики отправляются, false — метрики не отправляются) |
FALSE |
BOOLEAN |
ufsparams_module_monitoring_enabled |
false |
Рестарт pod |
ddis.transformer.interrupt.transformation.toggle |
Включение/выключение прерывания долгой активной операции трансформации распространения по таймауту (ddis.transformer.invalidation.timeout.minutes) |
FALSE |
BOOLEAN |
ddis.transformer.interrupt.transformation.toggle |
false |
Runtime, без рестарта pod |
ddis.transformer.write.awaiting.time |
Время ожидания завершения записи файла в хранилище (в миллисекундах) |
FALSE |
LONG |
ddis.transformer.write.awaiting.time |
30000 |
Runtime, без рестарта pod |
Переменные окружения:
Переменная окружения |
Переменная дистрибутива |
Описание переменной окружения |
Единица измерения |
Значение по умолчанию |
|---|---|---|---|---|
SERVER_PORT |
ddis.transformer.env.server_port |
Порт публичного интерфейса |
- |
8080 |
MANAGEMENT_SERVER_PORT |
ddis.transformer.env.management_server_port |
Порт интерфейса управления |
- |
8083 |
MANAGEMENT_METRICS_TAGS_APPLICATION |
- |
Теги метрик управления приложением |
- |
ddis-transformer |
DATASOURCE_URL |
ddis.transformer.env.spring_datasource_url |
Адрес базы данных компонента формируется исходя из следующего набора параметров |
- |
- |
Зависит от заполнения: |
- |
- |
- |
- |
ddis.postgres.url.base |
- |
- |
- |
- |
ddis.postgres.url.argv |
- |
Обязательно к заполнению |
- |
- |
DATASOURCE_DRIVER_CLASS_NAME |
ddis.transformer.env.spring_datasource_driver_class_name |
Имя класса драйвера для подключения к БД универсального парсера |
- |
org.postgresql.Driver |
DATASOURCE_SCHEMA |
- |
Схема базы данных компонента |
- |
ddis_transformer |
DATASOURCE_MINIMUM_IDLE |
ddis.transformer.env.datasource_minimum_idle |
Минимальное количество простаивающих соединений к базе данных компонента |
- |
1 |
DATASOURCE_MAXIMUM_POOL_SIZE |
ddis.transformer.env.datasource_maximum_pool_size |
Максимальное количество соединений с базой данных компонента |
- |
16 |
JPA_PROPERTIES_HIBERNATE_DIALECT |
ddis.transformer.env.hibernate_dialect |
Диалект обратного отображения hibernate java entity моделей на объекты БД |
- |
org.hibernate.dialect.PostgreSQL94Dialect |
ENDPOINTS_WEB_INCLUDE |
- |
Список включенных ресурсов Actuator, разделенных запятой |
- |
info,loggers,health,prometheus,env |
ENDPOINT_LOGGERS_ENABLED |
ddis.dictionary.env.endpoint.logger.enabled |
Включить адреса loggers Actuator - логгер актуатора |
- |
true |
APPLICATION_SERVICE |
- |
Имя приложения. Значение параметра должно соответствовать имени стейджа, который должно обрабатывать приложение |
- |
stx-transformer |
XSD_VALIDATION_DISABLED |
ddis.transformer.env.xsd_validation_disabled |
Ключ выключения валидации выходящего xml по XSD схеме (по-умолчанию выключена) |
- |
true |
APPLICATION_SHEDLOCK_TASK_TRANSFORMATION_LOCKATLEASTFORSTRING |
ddis.transformer.env.transformation.lockatleastforstring |
Минимальное время удержания блокировки для задачи трансформации |
- |
PT15S |
APPLICATION_SHEDLOCK_TASK_TRANSFORMATION_LOCKATMOSTFORSTRING |
ddis.transformer.env.transformation.lockatmostforstring |
Максимальное время удержания блокировки для задачи инвалидации статусов «зависших» распространений |
- |
PT15S |
ddis.graceful-shutdown.enabled |
- |
Определяет необходимость использования плавной остановки |
- |
true |
ddis.graceful-shutdown.delay |
ddis.shutdown.timeout |
Время ожидания при выполнении обработчика |
- |
10000 |
SERVER_SHUTDOWN |
- |
Функциональность, обеспечивающая плавную остановку приложения |
- |
graceful |
SPRING_LIFECYCLE_TIMEOUTPERSHUTDOWNPHASE |
- |
Свойство в Spring Boot, которое контролирует максимальное время, выделенное для каждой фазы процесса выключения приложения |
- |
30s |
MANAGEMENT_ENDPOINT_HEALTH_SHOW_DETAILS |
ddis.transformer.env.management.endpoint.health.show.details |
Параметр для определения объема информации, предоставляемой конечной точкой health |
- |
always |
MANAGEMENT_ENDPOINT_HEALTH_GROUP_LIVENESS_INCLUDE |
ddis.transformer.env.management.endpoint.health.group.liveness.include |
Список идентификаторов работоспособности для группы LIVE |
- |
diskSpace,ping |
MANAGEMENT_ENDPOINT_HEALTH_GROUP_READINESS_INCLUDE |
ddis.transformer.env.management.endpoint.health.group.readiness.include |
Список идентификаторов работоспособности для группы READY |
- |
db,ping |
TRANSFORMER_STX_FILE_PATH_ARCGIS |
- |
Путь к файлу stx преобразования для провайдера ArcGIS (абсолютный или относительный к рабочему каталогу) |
- |
template-CAS.stx |
TRANSFORMER_STX_FILE_PATH_DEPO |
- |
Путь к файлу stx преобразования для провайдера АС Депозитарий (абсолютный или относительный к рабочему каталогу) |
- |
template-DEPO.stx |
TRANSFORMER_STX_FILE_PATH_PCAP |
- |
Путь к файлу stx преобразования для провайдера ПКАП (абсолютный или относительный к рабочему каталогу) |
- |
template-UNSI.stx |
TRANSFORMER_STX_FILE_PATH_PCKIB |
- |
Путь к файлу stx преобразования для провайдера Продуктовый каталог КИБ (абсолютный или относительный к рабочему каталогу) |
- |
template-UNSI.stx |
TRANSFORMER_STX_FILE_PATH_POS |
- |
Путь к файлу stx преобразования для провайдера POS (абсолютный или относительный к рабочему каталогу) |
- |
template-CAS.stx |
TRANSFORMER_STX_FILE_PATH_CAS |
- |
Путь к файлу stx преобразования для провайдера ЦАС НСИ (абсолютный или относительный к рабочему каталогу) |
- |
template-CAS.stx |
TRANSFORMER_STX_FILE_PATH_KAKB |
- |
Путь к файлу stx преобразования для провайдера КАКБ (абсолютный или относительный к рабочему каталогу) |
- |
template-UNSI.stx |
TRANSFORMER_STX_FILE_PATH_TELECOM |
- |
Путь к файлу stx преобразования для провайдера ФГУП ЦНИИС (TELECOM) (абсолютный или относительный) |
- |
template-TELECOM.stx |
TRANSFORMER_STX_FILE_PATH_UNSI |
- |
Путь к файлу stx преобразования для провайдера УНСИ (абсолютный или относительный к рабочему каталогу) |
- |
template-UNSI.stx |
TRANSFORMER_STX_FILE_PATH_SAPEASUP |
- |
Путь к файлу stx преобразования для провайдера SAPEASUP (абсолютный или относительный) |
- |
template-SAPEASUP.stx |
Доступны провайдеры:
ARCGIS-ArcGIS;
UNSI-КАП.УНСИ;
KAKB-КАКБ;
PCKIB-Продуктовый каталог КИБ;
PCAP-ПКАП;
CAS-ЦАС НСИ.
Файл STX преобразования XML-файлов в формате провайдера (на примере UNSI) в XML-файлы в формате TransferReference2
TRANSFORMER_STX_FILE_PATH_UNSI задает путь к файлу (может быть абсолютным или относительным к рабочему каталогу выполнения) для провайдера UNSI.
Если переменная TRANSFORMER_STX_FILE_PATH_UNSI не задана, то приложение использует файл template-UNSI.stx из ресурсов проекта.
Если файл, на который указывает путь, заданный переменной TRANSFORMER_STX_FILE_PATH_UNSI не найден, то приложение использует файл template-UNSI.stx из ресурсов проекта.
Описание параметров Шлюз ТФС (ddis-gate-tfs)#
Параметры сервиса:
Имя параметра (PACMAN) |
Описание параметра |
Признак списочного параметра |
Тип данных |
Переменная дистрибутива |
Значение переменной/значение по умолчанию |
Условие применения |
|---|---|---|---|---|---|---|
ddis.gate-tfs.lock.timeout |
Максимальный интервал блокировки сообщения (в миллисекундах) |
FALSE |
LONG |
- |
120000 |
Рестарт pod |
ddis.gate-tfs.removal.enabled |
Параметр, который включает удаление файлов из внешнего хранилища |
FALSE |
BOOLEAN |
- |
false |
Рестарт pod |
ddis.gate-tfs.resource.enabled |
Включатель загрузки предварительно подготовленных ресурсов |
FALSE |
BOOLEAN |
- |
true |
Рестарт pod |
ddis.gate-tfs.resource.update |
Включение обновления ресурсов |
FALSE |
BOOLEAN |
- |
true |
Рестарт pod |
ddis.gate-tfs.logging.request.enabled |
Параметр включения функциональности отображения информации о запросах |
FALSE |
BOOLEAN |
- |
false |
Рестарт pod |
ddis.files.bucket.in.clean.name |
Очистка хранилищ. Имя папки внешнего хранилища |
FALSE |
STRING |
ddis.files.bucket.in.clean.name |
„ddis.gate-tfs.in.bucketName“ |
Runtime, без рестарта pod |
ddis.files.bucket.in.clean.ttl |
Очистка хранилищ. Время жизни файла (в минутах) |
FALSE |
LONG |
- |
4320 |
Runtime, без рестарта pod |
ddis.files.bucket.in.clean.time |
Очистка хранилищ. Cron выражение для запуска job очистки внешнего хранилища |
FALSE |
STRING |
- |
0 */5 * * * * |
Runtime, без рестарта pod |
ddis.files.bucket.in.clean.exclude |
Очистка хранилищ. Регулярное выражение для файлов исключений |
FALSE |
STRING |
- |
(?!) |
Runtime, без рестарта pod |
ddis.files.bucket.in.clean.enabled |
Очистка хранилищ. Параметр для включения очистки внешнего хранилища |
FALSE |
BOOLEAN |
- |
true |
Runtime, без рестарта pod |
ddis.files.bucket.local.clean.name |
Очистка хранилищ. Имя папки внутреннего хранилища |
FALSE |
STRING |
ddis.files.bucket.local.clean.name |
„ddis.settings.s3.bucket.name“ |
Runtime, без рестарта pod |
ddis.files.bucket.local.clean.ttl |
Очистка хранилищ. Время жизни файла (в минутах) |
FALSE |
LONG |
- |
4320 |
Runtime, без рестарта pod |
ddis.files.bucket.local.clean.time |
Очистка хранилищ. Cron выражение для запуска job очистки внутреннего хранилища |
FALSE |
STRING |
- |
0 */5 * * * * |
Runtime, без рестарта pod |
ddis.files.bucket.local.clean.exclude |
Очистка хранилищ. Регулярное выражение для файлов исключений |
FALSE |
STRING |
- |
(?!) |
Runtime, без рестарта pod |
ddis.files.bucket.local.clean.enabled |
Очистка хранилищ. Параметр для включения очистки внутреннего хранилища |
FALSE |
BOOLEAN |
- |
true |
Runtime, без рестарта pod |
ddis.files.bucket.in.clean.maxcount |
Очистка хранилищ. Максимальное количество файлов, удаляемых за одну итерацию |
FALSE |
LONG |
- |
3000 |
Runtime, без рестарта pod |
ddis.files.bucket.local.clean.maxcount |
Очистка хранилищ. Максимальное количество файлов, удаляемых за одну итерацию |
FALSE |
LONG |
- |
3000 |
Runtime, без рестарта pod |
ddis.hotreload.tfs.toggle |
Включение/выключение hotreload для Kafka ТФС |
FALSE |
BOOLEAN |
- |
false |
Runtime, без рестарта pod |
hotreload.timeLowerBound |
Нижняя граница времени применения секрета (раньше этого времени применение секрета не начнется) |
FALSE |
LONG |
- |
5 |
Runtime, без рестарта pod |
hotreload.timeUpperBound |
Верхняя граница времени применения секрета (позже этого времени применение секрета не начнется) |
FALSE |
LONG |
- |
150 |
Runtime, без рестарта pod |
ddis.hotreload.filestorage.toggle |
Включение/выключение hotreload для секретов хранилища файлов |
FALSE |
BOOLEAN |
- |
true |
Runtime, без рестарта pod |
platform.client.ip.header |
Название HTTP заголовка, в котором содержится IP адрес клиента |
FALSE |
STRING |
- |
iv-remote-address |
Рестарт pod |
platform.http.timeout |
Таймаут HTTP запроса |
FALSE |
LONG |
- |
10000 |
Рестарт pod |
pv.node.type |
Тип блока, принимает одно из 3-х допустимых значений: PRIMARY, SANDBOX, CTL |
FALSE |
STRING |
NODE_TYPE |
PRIMARY |
Рестарт pod |
ufs.tenant.code |
Код тенанта |
FALSE |
STRING |
ufsparams_module_tenant_code |
„TENANT_CODE“ |
Рестарт pod |
ufsparams.module.monitoring.enabled |
Включение отправки метрики мониторинга при запросе параметра в ФП СУП. (true — метрики отправляются, false — метрики не отправляются) |
FALSE |
BOOLEAN |
ufsparams_module_monitoring_enabled |
false |
Рестарт pod |
ufsparams.agent.baseUrl.openshift |
Основной URL для IAG-mm (для OSE) |
FALSE |
STRING |
ufsparams_agent_baseUrl_insecure |
„global.ose.params.baseUrl.stringToBind“ |
Рестарт pod |
ufsparams.agent.baseUrl |
Основной URL для IAG-mm (для WAS) |
FALSE |
STRING |
ufsparams_agent_baseUrl_secure |
„global.params.baseUrl.stringToBind“ |
Рестарт pod |
ufsparams.agent.delay |
Интервал между проверками обновления конфигурации |
FALSE |
LONG |
ufsparams_agent_delay |
10000 |
Рестарт pod |
ufsparams.agent.max.file.size |
Максимальный размер файла конфигурации |
FALSE |
LONG |
ufsparams_agent_max_file_size |
104857600 |
Рестарт pod |
ufsparams.agent.min.file.size |
Минимальный размер файла конфигурации |
FALSE |
LONG |
ufsparams_agent_min_file_size |
50 |
Рестарт pod |
ufsparams.agent.ignore.file.pattern |
Паттерн, по которому Агент не будет отслеживать файл для обновления из БД |
FALSE |
STRING |
ufsparams_agent_ignore_file_pattern |
glob:**sup2_common.json |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.enable |
Признак работы механизма circuit breaker. Если указано false, то HTTP вызов происходит без декорирования механизмом circuit breaker |
FALSE |
BOOLEAN |
ufsparams_agent_httpclient_circuitBreaker_enable |
false |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.failureRate.threshold |
Процент отказов в потоке запросов. После превышения данного процента поток будет прерван (переход в режим OPEN) |
FALSE |
LONG |
ufsparams_agent_httpclient_circuitBreaker_failureRate_threshold |
50 |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.openState.duration |
Время ожидания перед переходом от режима работы OPEN к HALF_OPEN |
FALSE |
LONG |
ufsparams_agent_httpclient_circuitBreaker_openState_duration |
60000 |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.halfOpen.requestBuffer |
Размер буфера запросов в режиме HALF_OPEN. После заполнения буфера рассчитывается процент отказов или процент медленных запросов для принятия решения о повторном прерывании потока (переход в режим OPEN) или о переходе в обычный режим работы потока запросов (переход в режим CLOSED). По умолчанию значение для данной настройки «0» и в этом случае реальный размер буфера запросов в режиме HALF_OPEN равен размеру буфера запросов в режиме CLOSED |
FALSE |
LONG |
ufsparams_agent_httpclient_circuitBreaker_halfOpen_requestBuffer |
0 |
Рестарт pod |
ufsparams.agent.httpclient.circuitBreaker.minimumCalls.size |
Минимальное количество вызовов, которое требуется (в режиме CLOSED), прежде чем CircuitBreaker сможет вычислить частоту ошибок. По умолчанию значение для данной настройки «10» |
FALSE |
LONG |
ufsparams_agent_httpclient_circuitBreaker_minimumCalls_size |
10 |
Рестарт pod |
ufsparams.agent.startup.synchronization.timeout |
- |
FALSE |
LONG |
ufsparams_agent_startup_synchronization_timeout |
3000 |
Рестарт pod |
ufs.baseurl.stand_in |
URL эндпоинта Stand-In |
FALSE |
STRING |
- |
${ufs.standin.rest.client.base.url} |
Рестарт pod |
ufs.baseurl.REPLICATOR |
URL эндпоинта ufs-si-replicator-bh |
FALSE |
STRING |
- |
${ufs.standin.rest.client.base.url} |
Рестарт pod |
ufs.standin.db.suffix |
Суффикс схемы текущего блока |
FALSE |
STRING |
- |
${ufs.standin.dbsuffix} |
Рестарт pod |
ufs.standin.use.mocks_7.2 |
Флаг использования моков |
FALSE |
BOOLEAN |
- |
false |
Рестарт pod |
ufs.standin.mocks_7.2 |
Значения моков |
FALSE |
STRING |
- |
- |
Рестарт pod |
ufs.standin.rest.client.max.total.connections |
Максимальное количество подключений к эндпоинту Stand-In |
FALSE |
LONG |
- |
10 |
Рестарт pod |
ufs.standin.rest.client.max.per.route |
Максимальное количество соединений на маршрут для эндпоинта Stand-In |
FALSE |
LONG |
- |
10 |
Рестарт pod |
ufs.standin.rest.client.read.timeout |
Тайм-аут чтения из эндпоинта Stand-In |
FALSE |
LONG |
- |
3000 |
Рестарт pod |
ufs.standin.rest.client.connection.timeout |
Тайм-аут подключения к эндпоинту Stand-In |
FALSE |
LONG |
- |
500 |
Рестарт pod |
ufs.standin.rest.client.header.server.ip |
Элемент для конфигурации передачи IP-сервера в header |
FALSE |
STRING |
- |
${ufs.standin.rest.client.header.server.ip} |
Рестарт pod |
ufs.standin.core.cache.enabled |
Признак использования локального кеша в клиентском модуле ФП Stand-In ядра платформы |
FALSE |
BOOLEAN |
- |
true |
Рестарт pod |
ufs.standin.core.cache.ttl |
Значение TTL для локального кеша в клиентском модуле ФП Stand-In ядра платформы |
FALSE |
LONG |
- |
60000 |
Рестарт pod |
ufs.standin.core.cache.dead.ttl |
Значение deadTTL для локального кеша в клиентском модуле ФП Stand-In ядра платформы |
FALSE |
LONG |
- |
3600000 |
Рестарт pod |
ufs.standin.is.use.operation.uid |
Признак поиска в getReplicationStatus по operationUid |
FALSE |
BOOLEAN |
- |
false |
Рестарт pod |
integration.adapter.PLTFRMV.SrvBlockModeChangeConsumer.001.checkResponseSchema |
Включение валидации ответа |
FALSE |
BOOLEAN |
- |
true |
Рестарт pod |
integration.adapter.PLTFRMV.SrvBlockModeChangeConsumer.001.checkRequestSchema |
Включение валидации запроса |
FALSE |
BOOLEAN |
- |
true |
Рестарт pod |
integration.module.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.excludeAdapter |
Рубильник, позволяющий отключать/включать адаптер-ИМ (INNER). |
FALSE |
BOOLEAN |
${ufs.standin.inner.message.disabled} |
Рестарт pod |
|
integration.module.PLTFRMV.SrvBlockModeChangeConsumer.001.excludeAdapter |
Рубильник, позволяющий отключать/включать адаптер-ИМ (PLTFRMV). |
FALSE |
BOOLEAN |
${ufs.standin.external.message.disabled} |
Рестарт pod |
|
integration.module.PLTFRMV.SrvBlockModeChangeConsumer.001.kafkaTopicName |
Название топика |
FALSE |
STRING |
- |
${ufs.standin.subscribe.kafka.external.topic.name} |
Рестарт pod |
integration.module.PLTFRMV.SrvBlockModeChangeConsumer.001.transportType |
Тип транспорта ИМ |
FALSE |
STRING |
- |
${ufs.standin.pltfrmv.transportType} |
Рестарт pod |
integration.module.PLTFRMV.SrvBlockModeChangeConsumer.001.kafkaConsumerFactory |
Фабрика-потребитель для ИМ |
FALSE |
STRING |
kafka/external_factory/consumer_factory_1 |
Рестарт pod |
|
integration.module.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.topicConnectionFactory |
Connection Factory Round-Robin для Topic |
FALSE |
STRING |
jms/factory/INNER_TOPIC_ROUND_ROBIN |
Рестарт pod |
|
integration.adapter.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.checkRequestSchema |
Включение валидации запроса |
FALSE |
BOOLEAN |
- |
true |
Рестарт pod |
integration.adapter.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.checkResponseSchema |
Включение валидации ответа |
FALSE |
BOOLEAN |
- |
true |
Рестарт pod |
integration.module.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.topicName |
Название топика |
FALSE |
STRING |
- |
${ufs.standin.root_topic_name}/%s/%s/%s |
Рестарт pod |
integration.module.UFS_INNER.srvblockmodechangeasync.001.CLIENT.transportType |
Тип транспорта ИМ для передачи уведомлений (внутриблочный механизм) |
FALSE |
STRING |
- |
${ufs.standin.ufsinner.transportType} |
Рестарт pod |
integration.module.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.kafkaConsumerFactory |
Фабрика-потребитель для ИМ |
FALSE |
STRING |
- |
kafka/inner_factory/consumer_factory |
Рестарт pod |
integration.module.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.kafkaProducerFactory |
Фабрика отправки сообщений для ИМ |
FALSE |
STRING |
- |
kafka/inner_factory/producer_factory |
Рестарт pod |
integration.module.UFS_INNER.SrvBlockModeChangeAsync.001.CLIENT.kafkaTopicName |
Название топика |
FALSE |
STRING |
- |
${ufs.standin.subscribe.kafka.inner.topic.name} |
Рестарт pod |
ufs.standin.subscribe.adapter.message |
Используемые средства для получения сообщений о смене режима блока |
FALSE |
STRING |
${ufs.standin.subscribe.adapter.message.use} |
Рестарт pod |
|
ufs.standin.is.use.ufs.force.node |
Признак обязательной установки HEADER UFS_FORCE_NODE |
FALSE |
BOOLEAN |
- |
false |
Рестарт pod |
ufs.httpclient.circuitBreaker.enable.STAND_IN |
Признак работы механизма circuit breaker |
FALSE |
BOOLEAN |
- |
true |
Рестарт pod |
ufs.httpclient.circuitBreaker.failureRate.threshold.percent.STAND_IN |
Процент отказов в потоке запросов. После превышения данного процента поток будет прерван (переход в режим OPEN) |
FALSE |
LONG |
- |
50 |
Рестарт pod |
ufs.httpclient.circuitBreaker.closed.requestBuffer.size.requestCount.STAND_IN |
Размер буфера запросов в режиме CLOSED (обычный режим работы потока запросов). После заполнения буфера рассчитывается процент отказов для принятия решения о прерывании потока запросов (переход в режим OPEN) |
FALSE |
LONG |
- |
120 |
Рестарт pod |
ufs.httpclient.circuitBreaker.halfOpen.requestBuffer.size.requestCount.STAND_IN |
Размер буфера запросов в режиме HALF_OPEN. После заполнения буфера рассчитывается процент отказов для принятия решения о повторном прерывании потока (переход в режим OPEN) или о переходе в обычный режим работы потока запросов (переход в режим CLOSED). Настройка объединяется с ringBufferSizeInClosedState и не доступна потребителям для изменений. По умолчанию значение для данной настройки „0“ и в этом случае реальный размер буфера запросов в режиме HALF_OPEN равен размеру буфера запросов в режиме CLOSED |
FALSE |
LONG |
- |
0 |
Рестарт pod |
ufs.httpclient.circuitBreaker.open.duration.milliseconds.STAND_IN |
Время ожидания перед переходом от режима работы OPEN к HALF_OPEN |
FALSE |
LONG |
- |
60000 |
Рестарт pod |
ufs.httpclient.circuitBreaker.smoothStart.rate.upperLimit.requestsPerSecond.STAND_IN |
Предел ограничения скорости запросов, при достижении которого задача плавного старта завершается |
FALSE |
LONG |
- |
2 |
Рестарт pod |
ufs.httpclient.circuitBreaker.smoothStart.rate.startLimit.percent.STAND_IN |
Ограничение скорости запросов в момент запуска задачи плавного старта. Указывается в процентах от предела ограничения скорости запросов |
FALSE |
LONG |
- |
50 |
Рестарт pod |
ufs.httpclient.circuitBreaker.smoothStart.rate.limitChange.step.percent.STAND_IN |
Шаг изменения ограничения скорости запросов, в процессе работы задачи плавного старта. Указывается в процентах от предела ограничения скорости запросов |
FALSE |
LONG |
- |
5 |
Рестарт pod |
ufs.httpclient.circuitBreaker.record.exceptions.STAND_IN |
Список исключений, которые считаются ошибкой и влияют на механизм circuit breaker |
FALSE |
STRING |
- |
- |
Рестарт pod |
ufs.httpclient.circuitBreaker.record.httpException.codes.STAND_IN |
Список HTTP кодов для исключений, которые считаются ошибкой для механизма circuit breaker |
FALSE |
STRING |
- |
- |
Рестарт pod |
ddis.hotreload.db.toggle |
Включение/отключение функциональности hotreload БД в обработчике события |
FALSE |
BOOLEAN |
- |
true |
Runtime, без рестарта pod |
audit.ufs.client_module.context.error_total_size_threshold |
Параметры для квотирования — пороговое значение для общего размера сообщений уровня WARN в TPS |
FALSE |
STRING |
- |
0 |
Рестарт pod |
audit.ufs.client_module.context.error_count_threshold |
Параметры для квотирования — пороговое значение для количества сообщений уровня ERROR в TPS |
FALSE |
STRING |
- |
0 |
Рестарт pod |
audit.ufs.client_module.context.warn_count_threshold |
Параметры для квотирования — пороговое значение для количества сообщений уровня WARN в TPS |
FALSE |
STRING |
- |
0 |
Рестарт pod |
audit.ufs.client_module.context.warn_total_size_threshold |
Параметры для квотирования — пороговое значение для общего размера сообщений уровня WARN в TPS |
FALSE |
STRING |
- |
0 |
Рестарт pod |
audit.ufs.client_module.context.quota_escalation_period |
Параметры для квотирования — время эскалации с уровня WARN до уровня ERROR в секундах |
FALSE |
STRING |
- |
0 |
Рестарт pod |
audit.ufs.client_module.context.max_async_send_tasks |
Параметр, задающий максимальное количество асинхронно выполняемых задач отправки событий аудита, которое может одновременно существовать в приложении при отправке событий методом |
FALSE |
STRING |
- |
1000 |
Рестарт pod |
integration.module.zone194 |
- |
FALSE |
STRING |
- |
Рестарт pod |
|
integration.module.zone |
- |
FALSE |
STRING |
- |
Рестарт pod |
|
ufs.standin.node.path |
FALSE |
STRING |
- |
Рестарт pod |
Предупреждение
Важно!
При старте приложения происходит проверка параметра ddis.gate-tfs.resource.enabled. Если он принимает значение true, то запускается процедура загрузки ресурсов. Во время ее работы проверяется значение параметра ddis.gate-tfs.resource.update. Если он равен true, то для каждого провайдера будет вызываться процедура merge (обновление — в случае если провайдер есть в БД и создание — если провайдера нет). Если параметр ddis.gate-tfs.resource.update равен false, то будут создаваться провайдеры. При этом если провайдер уже есть с таким именем, то будет формироваться исключение ProviderAlreadyExistsException.
Переменные окружения:
Переменная окружения |
Переменная дистрибутива |
Описание переменной окружения |
Единица измерения |
Значение по умолчанию |
|---|---|---|---|---|
APPLICATION_PCP_ENABLED |
- |
Параметр включения функциональности работы в режиме PCP |
- |
false |
ufs.integration.module.autostart |
- |
Настройки функциональности PCP |
- |
false |
ufs.integration.module.notStartingListeners |
- |
Настройки функциональности PCP |
- |
true |
SERVER_PORT |
ddis.gateway.env.server_port |
Порт публичного интерфейса |
- |
8080 |
DATASOURCE_URL |
ddis.gateway.env.datasource_url |
Адрес базы данных компонента формируется исходя из следующего набора параметров. |
- |
Обязательно к заполнению |
DATASOURCE_MINIMUM_IDLE |
ddis.gateway.env.datasource_minimum_idle |
Минимальное количество простаивающих соединений к базе данных компонента |
- |
1 |
DATASOURCE_MAXIMUM_POOL_SIZE |
ddis.gateway.env.datasource_maximum_pool_size |
Максимальное количество соединений с базой данных компонента |
- |
5 |
DATASOURCE_SCHEMA |
- |
Схема базы данных компонента |
- |
ddis_gate_tfs |
SERVICE |
- |
Название Шлюза ТФС в схеме распространения |
- |
gate-tfs |
LOCK_TIMEOUT |
ddis.gateway.env.lock_timeout |
Параметр, задающий максимальный интервал блокировки сообщения |
- |
120000 |
RESOURCES_PATH |
- |
Путь к каталогу с предварительно подготовленными записями формате JSON, предназначенными для загрузки в БД на старте приложения. Путь к каталогу в файловой системе должен начинаться с file: и оканчиваться разделителем пути, соответствующим файловой системе (например, косой чертой) |
- |
file:///srv/resources/ |
REMOVAL_ENABLED |
ddis.gateway.env.removal_enabled |
Параметр включения функциональности, удаляющей файлы из интеграционного хранилища S3 |
- |
false |
PROVIDER_GROUP_ID |
- |
Групповой идентификатор потребителя Kafka по умолчанию |
- |
distribution-gateway |
CONTROLLER_ENDPOINT |
ddis.gateway.env.controller_endpoint |
URL Контроллера DDIS. Обязательно к указанию |
- |
http://svc-ddis-controller:ddis.controller.env.server_port |
MANAGEMENT_SERVER_PORT |
ddis.gateway.env.management_server_port |
Порт интерфейса управления |
- |
8083 |
MANAGEMENT_ENDPOINTS |
- |
Ресурсы интерфейса управления |
- |
env,health,info,loggers,metrics,prometheus |
MAX_FILE_SIZE |
ddis.env.maxFileSize |
Максимальный размер файла в составном (multipart) HTTP-запросе |
- |
2GB |
MAX_REQUEST_SIZE |
ddis.env.maxRequestSize |
Максимальный размер составного (multipart) HTTP-запроса |
- |
2GB |
LOADING_PARALLELISM |
ddis.gateway.env.loadingParallelism |
Максимальное количество файлов, одновременно загружаемых из интеграционного S3 |
- |
8 |
REMOVAL_PARALLELISM |
ddis.gateway.env.removalParallelism |
Максимальное количество файлов, одновременно удаляемых из интеграционного S3 |
- |
8 |
PROCESSING_PARALLELISM |
ddis.gateway.env.processingParallelism |
Максимальное количество одновременно обрабатываемых сообщений |
- |
1 |
MAX_HTTP_HEADER_SIZE |
ddis.server.max-http-header-size |
Максимальный размер HTTP заголовка |
- |
32768 |
MANAGEMENT_APPLICATION_TAG |
- |
Значение тега application |
- |
ddis-gate-tfs |
SCHEDULING_ENABLED |
ddis.gateway.cm.data.scheduling_enabled |
Параметр включения функциональности регулярного выполнения действий (задержки, тайм-ауты, расписания) |
- |
true |
APPLICATION_SENDING_ENABLED |
ddis.gateway.cm.data.application_sending_enabled |
Параметр включения функциональности, отправляющей нотификацию об обработке поступивших файлов (обратную квитанцию) |
- |
false |
PROVIDER_SOCKET_TIMEOUT |
ddis.gateway.cm.data.provider_socket_timeout |
Тайм-аут на передачу данных при работе с интеграционным S3. Значение 0 означает бесконечное ожидание |
- |
10000 |
PROVIDER_REQUEST_TIMEOUT |
ddis.gateway.cm.data.provider_request_timeout |
Тайм-аут на выполнение запроса к интеграционному S3. Использование функциональности увеличивает потребление памяти. Отрицательное значение отключает функциональность |
- |
10000 |
PROVIDER_CONNECTION_TIMEOUT |
ddis.gateway.cm.data.provider_connection_timeout |
Тайм-аут на инициализацию подключения к интеграционному S3. Значение 0 означает бесконечное ожидание |
- |
10000 |
APPLICATION_PROVIDER_MESSAGELINKINGSTRATEGY |
ddis.gateway.cm.data.application_provider_messageLinkingStrategy |
Стратегия связывания поступившего события с Поставщиком. Доступны значения BY_PROVIDER_ID, BY_MESSAGE_SPNAME и BY_MESSAGE_SCENARIOID. Иные значения не предусмотрены и вызовут ошибку на старте приложения. Стратегия BY_PROVIDER_ID связывает Сообщение с Поставщиком, который соответствует слушателю Kafka, прочитавшему Сообщение. Стратегия BY_MESSAGE_SPNAME связывает Сообщение с Поставщиком, имя которого указано в Сообщении. Стратегия BY_MESSAGE_SCENARIOID связывает Сообщение с Поставщиком, который обрабатывает соответствующий транспортный сценарий |
- |
«BY_MESSAGE_SCENARIOID» |
SHUTDOWN_TIMEOUT |
ddis.gateway.cm.data.shutdown_timeout |
Максимальное время завершения приложения. По истечении указанного времени внутренние процессы компонента будут завершены принудительно |
- |
60000 |
ddis.environment.tenantCode |
- |
Позволяет статически задать код тенанта через кастомную реализацию |
- |
TENANT_CODE |
ddis.environment.nodePath |
- |
Позволяет статически задать код узла через кастомную реализацию |
- |
NODE_PATH |
DDIS_AUDIT_CLIENT |
- |
Параметр, задающий определение типа клиента, используемого для отправки аудита |
- |
AUDM |
DDIS_AUDIT_AUDM_SOURCESYSTEM |
ddis.gateway.union-audit.sourceSystem |
Значение, которое проставляется в событие аудита в поле с названием АС-источника события |
- |
global.platform.union-audit.sourceSystem |
default=“FS“ |
- |
- |
- |
- |
ufs.audit.client.context.audit.CImodule |
ddis.gateway.union-audit.CImodule |
Название микросервиса DDIS |
- |
_ddis-gate-tfs |
ufs.audit.client.module |
ddis.gateway.env.audit.audm.module |
Название микросервиса DDIS |
- |
ddis-gate-tfs |
DDIS_AUDIT_AUDM_ADDITIONALPARAMETERS_0_NAME |
ddis.gateway.cm.data.audit.additionalparameters.0.name |
Дополнительные параметры для конфигурации аудита |
- |
ufs.groupCode |
DDIS_LOGGING_REQUEST_ENABLED |
ddis.gateway.cm.data.logging.request.enabled |
Параметр включения функциональности отображения информации о запросах |
- |
true |
DDIS_AUDIT_AUDM_DEFAULTUSERNODE |
ddis.gateway.env.audit.defaultUserNode |
Значение, которое проставляется в событие аудита в поле адреса клиента userNode в случае, если событие аудита создается не по запросу пользователя |
- |
0.0.0.0 |
ufs.healthcheck.stub-agent-enabled |
- |
Параметр включения заглушки агента PACMAN. Значение по умолчанию false |
- |
false |
SUP_ENABLED |
- |
Параметр включения поиска параметров в SUP |
- |
true |
APPLICATION_LOCALSTORAGEPATH |
- |
Настройка имени локального хранилища |
- |
local |
APPLICATION_SLEEP-DURATION |
- |
Задержка между попытками |
- |
3000 |
ufs.platform.environment.product.deployment-unit |
- |
Название элемента развертывания |
- |
ddis-gate-tfs |
APPLICATION_HOTRELOAD_SECRETREFRESHINGWINDOW |
- |
Время ожидания (сек) в течение заданного временного интервала при получении события об изменении файла |
- |
3000 |
APPLICATION_HOTRELOAD_SECRETUPDATERETRYLIMIT |
- |
Количество попыток которое следует применить если обновление секретов и сертификатов завершилось провалом |
- |
3 |
APPLICATION_HOTRELOAD_SECRETUPDATERETRYWINDOW |
- |
Время ожидания повторной попытки применения секрета |
- |
5000 |
APPLICATION_HOTRELOAD_SECRETREFRESHLIMITINGWINDOW |
- |
Время ожидания после успешного обновления секрета |
- |
180000 |
ddis.graceful-shutdown.enabled |
- |
Определяет необходимость использования плавной остановки |
- |
true |
ddis.graceful-shutdown.delay |
ddis.shutdown.timeout |
Время ожидания при выполнении обработчика |
- |
10000 |
SERVER_SHUTDOWN |
- |
Функциональность, обеспечивающая плавную остановку приложения |
- |
graceful |
SPRING_LIFECYCLE_TIMEOUTPERSHUTDOWNPHASE |
- |
Свойство, которое контролирует максимальное время, выделенное для каждой фазы процесса выключения приложения |
- |
30s |
MANAGEMENT_ENDPOINT_HEALTH_SHOW_DETAILS |
ddis.gateway.env.management.endpoint.health.show.details |
Параметр для определения объема информации, предоставляемой конечной точкой health |
- |
always |
MANAGEMENT_ENDPOINT_HEALTH_GROUP_LIVENESS_INCLUDE |
ddis.gateway.env.management.endpoint.health.group.liveness.include |
Список идентификаторов работоспособности для группы LIVE |
- |
diskSpace,ping |
MANAGEMENT_ENDPOINT_HEALTH_GROUP_READINESS_INCLUDE |
ddis.gateway.env.management.endpoint.health.group.readiness.include |
Список идентификаторов работоспособности для группы READY |
- |
db,ping |
IMHEALTH_ENABLED |
ddis.gateway.env.integrationModuleHealth.enabled |
Параметр включения влияния статуса IntegrationModuleHealth на общий статус healthcheck |
- |
false |
Общие параметры или вынесенные во внешнюю конфигурацию#
cm-ddis-km-hotreload
Переменная окружения |
Переменная дистрибутива |
Описание переменной окружения |
Единица измерения |
Значение по умолчанию |
|---|---|---|---|---|
SECRET_UPDATE_RETRY_LIMIT |
- |
Параметр, задающий количество попыток применения секрета после обновления |
- |
3 |
SECRET_UPDATE_RETRY_WINDOW |
- |
Параметр, задающий время ожидания между попытками применения секрета после обновления |
- |
5000 |
SECRET_REFRESH_LIMITING_WINDOW |
- |
Параметр, задающий время ожидания после успешного обновления секрета |
- |
3000 |
SECRET_REFRESHING_WINDOW |
- |
Параметр, задающий время ожидания при обнаружении обновления файла с секретами |
мс |
180000 |
HOTRELOAD_DBSECRETS_FILE |
- |
Параметр, задающий полный путь к файлу с секретами подключения к БД для отслеживания обновления |
- |
/mnt/secrets/db.properties |
cm-ddis-s3client-in.yaml
Переменная окружения |
Переменная дистрибутива |
Описание переменной окружения |
Единица измерения |
Значение по умолчанию |
|---|---|---|---|---|
webdav.storages.in.enabled |
- |
Параметр включения функциональности подключения по webdav |
- |
false |
s3client.storages.in.enabled |
- |
Параметр включения функциональности подключения по протоколу S3 |
- |
true |
s3client.storages.in.endpoint |
ddis.gate-tfs.in.host:ddis.gate-tfs.in.internal.port |
Параметр, задающий адрес сервиса S3 для внешнего хранилища |
- |
- |
ddis.gate-tfs.in.internal.port по умолчанию 8556, значение порта должно пересекаться со значением переменной истио: ddis.istio.egress.all.s3.servers [internal_port_1] (см руководство по установке) |
- |
Обязательно для заполнения перед установкой |
- |
- |
s3client.storages.in.region |
ddis.gate-tfs.in.signing.region |
Параметр, задающий регион сервиса S3 для внешнего хранилища |
- |
- |
s3client.storages.in.protocol |
- |
Параметр, задающий протокол соединения с сервисом S3 для внешнего хранилища |
- |
http |
s3client.storages.in.connectionTimeout |
ddis.gate-tfs.in.connectionTimeout |
Параметр, задающий время ожидания соединения с сервисом S3 для внешнего хранилища |
- |
10000 |
s3client.storages.in.maxConnections |
ddis.gate-tfs.in.maxConnections |
Параметр, задающий максимальное количество соединений с сервисом S3 для внешнего хранилища |
- |
50 |
s3client.storages.in.keepAlive |
ddis.gate-tfs.in.keepAlive |
Параметр включения функциональности удержания соединения с сервисом S3 для внешнего хранилища |
- |
false |
s3client.storages.in.connectionMaxIdleMillis |
ddis.gate-tfs.in.connectionMaxIdleMillis |
Параметр, задающий максимальное время простоя соединения с сервисом S3 для внешнего хранилища |
мс |
60000 |
s3client.storages.in.socketTimeout |
ddis.gate-tfs.in.socketTimeout |
Параметр, задающий время ожидания передачи данных в сервис S3 для внешнего хранилища |
мс |
50000 |
s3client.storages.in.filePathSecrets |
- |
Параметр, задающий путь к файлу с секретами подключения к сервису S3 для внешнего хранилища |
- |
/mnt/secrets/s3tfs.properties |
s3client.storages.in.payload-signing-enabled |
ddis.s3.payloadSigningEnabled |
Параметр включения функциональности подписи на данных в сервис S3 для внешнего хранилища |
- |
true |
s3client.storages.in.chunk-encoding-disabled |
ddis.s3.chunkEncodingDisabled |
Параметр отключения функциональности кодировки запросов в S3 для внешнего хранилища |
- |
true |
cm-ddis-s3client-local.yaml |
- |
- |
- |
- |
webdav.storages.local.enabled |
- |
Параметр включения функциональности подключения по webdav |
- |
false |
s3client.storages.local.enabled |
- |
Параметр включения функциональности подключения по протоколу S3 |
- |
true |
s3client.storages.local.endpoint |
ddis.settings.s3.url:ddis.settings.s3.internal.port |
Параметр, задающий адрес сервиса S3 для внутреннего хранилища |
- |
- |
cm-ddis-s3client-local.yaml
Переменная окружения |
Переменная дистрибутива |
Описание переменной окружения |
Единица измерения |
Значение по умолчанию |
|---|---|---|---|---|
webdav.storages.local.enabled |
- |
Параметр включения функциональности подключения по webdav |
- |
false |
s3client.storages.local.enabled |
- |
Параметр включения функциональности подключения по протоколу S3 |
- |
true |
s3client.storages.local.endpoint |
ddis.settings.s3.url:ddis.settings.s3.internal.port |
Параметр, задающий адрес сервиса S3 для внутреннего хранилища |
- |
- |
ddis.settings.s3.internal.port по умолчанию 8556, значение порта должно пересекаются со значением переменой истио: ddis.istio.egress.all.s3.servers [internal_port_1] (см руководство по установке) |
- |
Обязательно для заполнения перед установкой |
- |
- |
s3client.storages.local.region |
ddis.settings.s3.signing.region |
Параметр, задающий регион сервиса S3 для внутреннего хранилища |
- |
Обязательно для заполнения перед установкой |
s3client.storages.local.protocol |
- |
Параметр, задающий протокол соединения с сервисом S3 для внутреннего хранилища |
- |
http |
s3client.storages.local.connectionTimeout |
ddis.settings.s3.local.connectionTimeout |
Параметр, задающий время ожидания соединения с сервисом S3 для внутреннего хранилища |
- |
10000 |
s3client.storages.local.maxConnections |
ddis.settings.s3.local.maxConnections |
Параметр, задающий максимальное количество соединений с сервисом S3 для внутреннего хранилища |
- |
50 |
s3client.storages.local.keepAlive |
ddis.settings.s3.local.keepAlive |
Параметр включения функциональности удержания соединения с сервисом S3 для внутреннего хранилища |
- |
false |
s3client.storages.local.connectionMaxIdleMillis |
ddis.settings.s3.local.connectionMaxIdleMillis |
Параметр, задающий максимальное время простоя соединения с сервисом S3 для внутреннего хранилища |
мс |
60000 |
s3client.storages.local.filePathSecrets |
- |
Параметр, задающий путь к файлу с секретами подключения к сервису S3 для внутреннего хранилища |
- |
/mnt/secrets/s3.properties |
s3client.storages.local.socketTimeout |
ddis.settings.s3.local.socketTimeout |
Параметр, задающий время ожидания передачи данных в сервис S3 для внутреннего хранилища |
мс |
50000 |
s3client.storages.local.payload-signing-enabled |
ddis.s3.payloadSigningEnabled |
Параметр включения функциональности подписи на данных в сервис S3 для внутреннего хранилища |
- |
true |
s3client.storages.local.chunk-encoding-disabled |
ddis.s3.chunkEncodingDisabled |
Параметр отключения функциональности кодировки запросов в S3 для внутреннего хранилища |
- |
true |
cm-ddis-trigger-default.yaml
Переменная окружения |
Переменная дистрибутива |
Описание переменной окружения |
Единица измерения |
Значение по умолчанию |
|---|---|---|---|---|
DDIS_SSL_ENABLED |
- |
Параметр включения функциональности обработки SSL соединений в обход Istio |
- |
false |
APPLICATION_CREATEJKS |
- |
Параметр включения функциональности обновления контейнера JKS |
- |
false |
APPLICATION_ENABLETRIGGERS |
- |
Параметр включения функциональности использования обработчиков обновлений |
- |
true |
APPLICATION_HOTRELOAD-DB_ENABLED |
- |
Параметр включения функциональности отслеживания обновления секретов подключения БД |
- |
true |
Описание REST-запросов для HealthCheck#
В компонент DDIS встроен клиентский модуль ufs-healthcheck-spring-boot-starter, который реализует программный интерфейс самодиагностики компонентов (HealthCheck).
С route namespace DDIS доступны REST-запросы:
/healthcheck/service-healthcheck/ , возвращающий результат healthcheck соответствующего deployment-unit; /healthcheck/service-healthcheck/ /detail, возвращающий результат healthcheck/detail соответствующего deployment-unit; /ddis/ /environment/product, возвращающий результат environment/product соответствующего deployment-unit; /ddis/ /environment/dependency, возвращающий результат environment/product соответствующего deployment-unit; /ddis/ /healthcheck, возвращающий результат healthcheck соответствующего deployment-unit; /ddis/ /healthcheck/detail, возвращающий результат healthcheck/detail соответствующего deployment-uni
События системного журнала#
Действия, производимые продуктом, логируются и записываются в локальный лог-файл контейнера. С этой целью продукт может быть интегрирован со сторонним компонентом, предоставляющим данную функциональность. В качестве такого компонента может использоваться компонент Журналирование (LOGA) продукта Platform V Monitor (OPM) (см. раздел Платформенные зависимости документа Руководство по установке). Продукт не имеет локального журнала для записи лог-файлов. Запись осуществляется автоматически по умолчанию.
Существует возможность настройки уровней логирования, нет возможности отключения логирования. Уровни логирования настраиваются системным администратором в стороннем компоненте логирования, например, в компоненте LOGA при его использовании в соответствии с его эксплуатационной документацией.
Идентификаторами компонента в лог-файлах являются: «ddis-controller», «ddis-gate-tfs», «ddis-facade», «ddis-publish-lnse».
Системный журнал содержит события, связанные с экземпляром компонента LOGA, запущенного в контексте каждого конкретного прикладного модуля. Например, в этот журнал попадают сообщения о регистрации метрик, публикуемых прикладным модулем. Технический специалист, администрирующий прикладной модуль или технологический сервис может использовать данные системного журнала для диагностики сбойных ситуаций, относящихся к некорректному использованию компонента LOGA.
Для системного журнала используются следующие приоритеты:
ERROR:
ошибки вызова сервисов Platform V, кроме отправки метрик в компонент DDIS;
ошибки интеграционных вызовов.
WARNING:
ошибки отправки метрик в компонент DDIS;
некритичные ошибки, кроме ошибок отправки метрик.
INFO: сообщения о вызове и возврате из вызова интеграционного адаптера.
DEBUG:
все входные и выходные параметры операций сервисов;
все входные и выходные параметры вызовов интеграционных адаптеров.
Запись и просмотр (поиск, анализ) событий, происходящих в функциональных подсистемах, поддерживается в технологическом сервисе компонентом LOGA.
Включение уровня логирования DEBUG не рекомендуется использовать в промышленных инсталляциях.
Примеры отправляемого события типа ERROR в формате json:
{"timestamp":"2000-00-00T08:13:02.982109Z",
"serverEventDatetime":1713773582980,
"logger-impl":"7.4.2.3",
"version":"1.16.0",
"distribVersion":"6.0.0-524_FS",
"release":"unver","deploymentUnit":"ddis-controller",
"channel":"ALL",
"subsystem":"DDIS",
"className":"com.zaxxer.hikari.pool.HikariPool",
"logLevel":"ERROR",
"tenantCode":"DICT",
"message":"HikariPool-1 - Exception during pool initialization.",
"threadName":"http-nio-8083-exec-10",
"type":"SYSTEM",
"hostname":"ddis-controller-unver",
"stacktrace":"org.postgresql.util.PSQLException: The connection attempt failed.\norg.postgresql.core.v3.ConnectionFactoryImpl.openConnectionImpl(ConnectionFactoryImpl.java:354) ~[postgresql-42.6.0.jar!/:42.6.0]\norg.postgresql.core.v3.ConnectionFactoryImpl.openConnectionImpl(ConnectionFactoryImpl.java:258) ~[postgresql-42.6.0.jar!/:42.6.0]\n... 80 common frames omitted\n",
"systemIp":"{ IP_ADDRESS }",
"traceId":"00000000-0000-0000-0000-000000000000",
"md5":"08DD3DF22FA1B57610753528677DD5F6",
"hostName":"ddis-controller-unver",
"namespace":"<наименование_namespace>",
"nodeId":"nodeId",
"nodePath":"nodePath"}
Примеры отправляемого события типа WARNING в формате json:
{"timestamp":"2000-00-00T08:06:46.750091Z",
"tenantCode":"DICT",
"version":"1.16.0",
"message":"HHH000069: Duplicate generator name base-generator","threadName":"main","hostname":"ddis-controller-unver","systemIp":"{ IP_ADDRESS }",
"logLevel":"WARN",
"traceId":"00000000-0000-0000-0000-000000000000",
"serverEventDatetime":1713773206749,
"logger-impl":"7.4.2.3",
"distribVersion":"6.0.0-524_FS",
"type":"SYSTEM",
"release":"unver",
"deploymentUnit":"ddis-controller",
"channel":"ALL",
"subsystem":"DDIS",
"className":"org.hibernate.boot.internal.InFlightMetadataCollectorImpl",
"hostName":"ddis-controller-unver",
"namespace":"<наименование_namespace>",
"nodeId":"nodeId",
"nodePath":"nodePath"}
Примеры отправляемого события типа INFO в формате json:
{"timestamp":"2000-00-00T08:06:46.151733Z",
"tenantCode":"DICT",
"version":"1.16.0",
"message":"HHH000400: Using dialect: org.hibernate.dialect.PostgreSQL10Dialect",
"threadName":"main",
"hostname":"ddis-controller-unver",
"systemIp":"{ IP_ADDRESS }",
"logLevel":"INFO",
"traceId":"00000000-0000-0000-0000-000000000000",
"serverEventDatetime":1713773206151,
"logger-impl":"7.4.2.3",
"distribVersion":"6.0.0-524_FS",
"type":"SYSTEM",
"release":"unver",
"deploymentUnit": "ddis-controller",
"channel":"ALL",
"subsystem":"DDIS",
"className":"org.hibernate.dialect.Dialect",
"hostName":"ddis-controller-unver",
"namespace":"<наименование_namespace>",
"nodeId":"nodeId",
"nodePath":"nodePath"}
Примеры отправляемого события типа DEBUG в формате json:
{"timestamp":"2000-00-00T08:06:46.151733Z",
"tenantCode":"DICT",
"version":"1.16.0",
"message":"Completed 200 OK",
"threadName":"http-nio-8083-exec-10",
"hostname":"ddis-controller-unver",
"systemIp":"{ IP_ADDRESS }",
"logLevel":"DEBUG",
"traceId":"00000000-0000-0000-0000-000000000000",
"serverEventDatetime":1713773206151,
"logger-impl":"7.4.2.3",
"distribVersion":"6.0.0-524_FS",
"type":"SYSTEM",
"release":"unver",
"deploymentUnit": "ddis-controller",
"channel":"ALL",
"subsystem":"DDIS",
"className":"o.s.w.s.DispatcherServlet",
"hostName":"ddis-controller-unver",
"namespace":"<наименование_namespace>",
"nodeId":"nodeId",
"nodePath":"nodePath"}
Описание событий ERROR:
Сообщение |
Причина возникновения |
|---|---|
DistributionAlreadyExistsException |
Распространение с таким идентификатором уже существует |
DistributionNotFoundException |
Распространение не найдено |
GateAlreadyExistsException |
Шлюз с таким идентификатором уже существует |
GateNotFoundException |
Шлюз не найден |
GatePointIdException |
Идентификатор первой точки маршрута должен быть равен единице |
GatePointParentException |
У первой точки маршрута не может быть ссылки на предыдущую точку |
GateServiceDuplicateException |
Шлюз для такого сервиса уже существует |
ParentPointNotFoundException |
Для точки маршрута, которая не является первой, не найдена предыдущая точка |
ParentPointNullException |
Для точки маршрута, которая не является первой, не задана предыдущая точка |
ParentPointOrderException |
Идентификатор точки маршрута должен быть больше идентификатора предыдущей текущей точки |
ParentStageNotFoundException |
Не найден предыдущий этап распространения |
PointIdDuplicateException |
Идентификатор точки маршрута не уникален |
PointServiceDuplicateException |
Сервис точки маршрута не уникален в рамках одной общей родительской точки |
ProcessorAlreadyExistsException |
Процессор с таким идентификатором уже существует |
ProcessorNotFoundException |
Процессор не найден |
ProcessorServiceDuplicateException |
Процессор для такого сервиса уже существует |
ResourceIdDuplicateException |
Идентификатор ресурса не уникален |
ResourceLoadException |
Ошибка загрузки ресурсов |
RoadmapAlreadyExistsException |
Дорожная карта с таким идентификатором уже существует |
RoadmapGateDuplicateException |
Дорожная карта для такого шлюза уже существует |
RoadmapNotFoundException |
Дорожная карта не найдена |
StageNotFoundException |
Не найден этап распространения |
StageStatusIllegalException |
Статус этапа распространения не подходит для выполнения этой операции |
Описание событий ротации секретов - HotReload:
Событие |
Уровень логирования |
|---|---|
Имя файла» файл изменен! Старый hash: «hash старого файла», Новый hash: «hash нового файла |
info |
Создание объекта подключения с последующей попыткой подключения к БД. |
debug |
Попытка подключения к БД |
debug |
Подключение к БД успешно |
debug |
Подключение к БД не успешно |
error |
Попытка закрытия соединения для уничтожения объекта. |
debug |
Закрытие соединения для уничтожения объекта прошло успешно. |
debug |
Старт метода добавления новых секретов для БД |
debug |
Извлечение свойств из properties файла путь к файлу |
debug |
Тестовое подключение к БД с новыми секретами прошло успешно. |
info |
Реинициализация пула подключений с новыми доступами прошла успешно. |
info |
Достигнуто максимальное количество попыток подключения к БД. Прекращение попыток. |
error |
Во время создания подключения к БД с новыми секретами произошла ошибка: текст ошибки. Будет произведена попытка номер <номер попытки> |
error |
Старт HR |
info |
Выполнение имя хендлера |
info |
Конец HR |
info |
Параметр имя параметра равен true. Будет произведена попытка обновления секретов |
debug |
Конфигурация логирования хранится в configMap:
cm-ddis-fluent-bit-conf: информация для логирования для отправки в компонент LOGA;
cm-ddis-logback-xml: локального логирования. В данной configMap можно изменить уровень логирования. По умолчанию указан уровень логирования INFO.
<root level="INFO">
<appender-ref ref="STDOUT"/>
<appender-ref ref="JSON"/>
</root>
Просмотр журнала доступен пользователю только в компоненте LOGA с соответствующими правами доступа к компоненту DDIS.
Уровень логирования не доступен к изменению в интерфейсе пользователя. Не задается при установке компонента DDIS. Может быть изменен только в ручном режиме Администратором.
События мониторинга#
В компоненте DDIS реализован мониторинг событий с использованием компонента MONA.
Формат метрик соответствует требованиям системы Prometheus.
Осуществляется отправка информации по системным метрикам компонента DDIS.
Список метрик для ddis-publish-lnse:
Код метрики |
Название метрик (основной сценарий) |
Название метрик (ошибки) |
Тип метрики |
Метки |
|---|---|---|---|---|
ddis_sender_distribution_received_count |
Получено распространение |
Counter |
domain_rn |
|
ddis_checker_get_started_count |
Старт проверки распространения |
Counter |
external_id, domain_rn |
|
ddis_checker_resource_detected_count |
Обнаружен ресурс для загрузки |
Counter |
external_id, resource_id, domain_rn |
|
ddis_checker_archive_processing_get_started_count |
Старт обработки архива |
Counter |
external_id, resource_id, domain_rn |
|
ddis_checker_accessing_ceph_error_count |
Ошибка обращения к Хранилищу |
Counter |
external_id, resource_id, domain_rn |
|
ddis_checker_gz_not_found_error_count |
Архив не найден в Хранилище |
Counter |
external_id, resource_id, domain_rn |
|
ddis_checker_unzip_error_count |
Ошибка распаковки архива |
Counter |
external_id, resource_id, domain_rn |
|
ddis_loader_accessing_ceph_error_count |
Ошибка обращения к Хранилищу |
Counter |
external_id, dictionary_id, model_version, domain_rn |
|
ddis_loader_loading_get_started_count |
Старт загрузки справочника LNSE |
Counter |
dictionary_id, model_version, data_version, domain_rn |
|
ddis_loader_loading_done_count |
Загрузка справочника LNSE успешно завершена |
Counter |
external_id, dictionary_id, model_version, data_version, domain_rn |
|
ddis_loader_loading_error_count |
Ошибка загрузки справочника LNSE |
Counter |
external_id, dictionary_id, model_version, data_version, domain_rn |
|
ddis_loader_activation_rq_count |
Запрос активации |
Counter |
external_id, dictionary_id, model_version, data_version, domain_rn |
|
ddis_loader_activation_done_count |
Запрос активации выполнен |
Counter |
external_id, dictionary_id, model_version, data_version, domain_rn |
|
ddis_loader_activation_error_count |
Ошибка активации |
Counter |
external_id, dictionary_id, model_version, data_version, domain_rn |
|
ddis_checker_httpclient_pool_leased_count |
Количество занятых соединений в пуле HTTP-клиентов |
Gauge |
||
ddis_outbound_${application.service}_traffic |
Метрика биллинга. Суммарный объем данных выгрузок. Монотонно возрастающий счетчик объема загружаемых архивов |
Counter |
||
ddis_${application.service}_publication_speed |
Метрика биллинга. Скорость публикации данных. Отношение объема загружаемых архивов ко времени загрузки |
Gauge |
DictionaryName, billedResourceName, unit_type |
|
UFS_DDIS_DISTRIBUTION_DICTIONARY_STARTED |
Старт сервиса Публикатор в LNSE |
Counter |
Описание healthcheck по каждому сервису DDIS приведено в разделе «Приложение» настоящего документа.
Часто встречающиеся проблемы и пути их устранения#
Проблема:
Встречается проблема с наличием дискового пространства на сервере БД.
Решение проблемы:
Необходимо регулярно проводить удаление «потерянных» large objects средствами СУБД PostgreSQL (рекомендуется использование компонента Pangolin (PSQL)), используя утилиту vacuumlo.
Программа vacuumlo представляет собой простую утилиту, которая удаляет все «потерянные» большие объекты из базы данных рекомендуемого к использованию компонента Pangolin (PSQL). Потерянным большим объектом (БО) считается такой БО, OID которого не фигурирует ни в каком столбце oid или large object(lo) в базе данных.
Программа vacuumlo работает следующим образом. Сначала vacuumlo строит временную таблицу, содержащую все OID больших объектов в выбранной базе данных. Затем она сканирует все столбцы в базе данных, имеющие тип oid или lo, и удаляет соответствующие записи из временной таблицы (замечание: рассматриваются только типы именно с такими именами, а не, например, домены на их базе). Оставшиеся записи во временной таблице указывают на потерянные БО, которые затем и удаляются.
Приложение#
Описание endpoint для отслеживания версий и доступности pod и сервисов компонента DDIS.
Описание для сервиса ddis-publish-lnse:
"taskName": "Проверка сервиса через nginx II",
"links": [
{
"protocol": "${nginxIIProtocol1_ssl}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${nginxIIPort1_ssl}",
"host": "${nginxIIHost1}",
"path": "/ddis/healthcheck",
"data": "",
"method": "POST"
},
{
"protocol": "${nginxIIProtocol1_ssl}",
"responseAssertion": "",
"port": "${nginxIIPort1_ssl}",
"host": "${nginxIIHost1}",
"path": "/ddis/environment/product",
"data": "",
"method": "GET"
}
],
"taskType": "healthcheck"
"taskName": "Проверка сервиса на OPENSHIFT",
"links": [
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-publish-lnse/healthcheck",
"data": "",
"method": "POST"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "",
"port": "${OSE_Port}",
"responseFailAssertions": "status\":\"DOWN",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-publish-lnse/healthcheck/db",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"responseFailAssertions": "",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-publish-lnse/healthcheck/diskSpace",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"responseFailAssertions": "",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-publish-lnse/healthcheck/livenessState",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"responseFailAssertions": "",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-publish-lnse/healthcheck/readinessState",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"responseFailAssertions": "",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-publish-lnse/healthcheck/ping",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-publish-lnse/environment/product",
"data": "",
"method": "GET"
}
],
"taskType": "healthcheck"
Описание для сервиса ddis-controller:
"taskName": "Проверка сервиса на OPENSHIFT",
"links": [
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-controller/healthcheck",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-controller/healthcheck/db",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-controller/healthcheck/diskSpace",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-controller/healthcheck/livenessState",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-controller/healthcheck/readinessState",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-controller/healthcheck/ping",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-controller/environment/product",
"data": "",
"method": "GET"
}
],
"taskType": "healthcheck"
Описание для сервиса ddis-gate-tfs:
"taskName": "Проверка сервиса на OPENSHIFT",
"links": [
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-gate-tfs/healthcheck",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-gate-tfs/healthcheck/db",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-gate-tfs/healthcheck/diskSpace",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-gate-tfs/healthcheck/livenessState",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-gate-tfs/healthcheck/readinessState",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-gate-tfs/healthcheck/ping",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-gate-tfs/environment/product",
"data": "",
"method": "GET"
}
],
"taskType": "healthcheck"
Описание для сервиса ddis-transformer:
"taskName": "Проверка сервиса на OPENSHIFT",
"links": [
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-transformer/healthcheck",
"data": "",
"method": "POST"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-transformer/healthcheck/db",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-transformer/healthcheck/diskSpace",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-transformer/healthcheck/livenessState",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-transformer/healthcheck/readinessState",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-transformer/healthcheck/ping",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-transformer/environment/product",
"data": "",
"method": "GET"
}
],
"taskType": "healthcheck"
Описание для сервиса ddis-facade:
"taskName": "Проверка сервиса через nginx UI",
"links": [
{
"protocol": "${nginxIIProtocol1_ssl}",
"responseAssertion": "\"status\":\"UP\»»,
"port": "${nginxUIPort1_ssl}",
"host": "${nginxUIHost1}",
"path": "/ddis/healthcheck",
"data": "",
"method": "GET"
},
{
"protocol": "${nginxUIProtocol1_ssl}",
"responseAssertion": "",
"port": "${nginxUIPort1_ssl}",
"responseFailAssertions": "status\":\"DOWN",
"host": "${nginxUIHost1}",
"path": "/ddis/healthcheck/detail",
"data": "",
"method": "GET"
},
{
"protocol": "${nginxUIProtocol1_ssl}",
"responseAssertion": "",
"port": "${nginxUIPort1_ssl}",
"host": "${nginxUIHost1}",
"path": "/ddis/environment/product",
"data": "",
"method": "GET"
}
],
"taskType": "healthcheck"
"taskName": "Проверка сервиса на OPENSHIFT",
"links": [
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"body\":\"ON\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-facade/healthcheck",
"data": "",
"method": "POST"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-facade/healthcheck/diskSpace",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-facade/healthcheck/livenessState",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-facade/healthcheck/readinessState",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "\"status\":\"UP\"",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-facade/healthcheck/ping",
"data": "",
"method": "GET"
},
{
"protocol": "${OSE_Protocol}",
"responseAssertion": "",
"port": "${OSE_Port}",
"host": "${OSE_Ddis_Host}",
"path": "/ddis/ddis-facade/environment/product",
"data": "",
"method": "GET"
}
],
"taskType": "healthcheck"