Настройка интеграции с компонентом Аудит (AUDT)#

Функциональность аудита предоставляется компонентом продукта Platform V Audit SE (AUD) или Platform V Monitor (OPM), подробнее см. в разделе Платформенные зависимости.

Файлы конфигурации расположены в дистрибутиве, подробнее см. в разделе Состав дистрибутива.

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

Общие настройки#

Наименование параметра в файле конфигурирования

Расположение

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

Ограничения

Значение по умолчанию или глобальные параметры при установке Deploy tools

Версия ПО

dcgn.audit.useMultitenancy

Репозиторий настройки компонента, файл dcgn.all.conf

Режим работы с компонентом Аудит (AUDT):
- true — мультитенантный режим;
- false — не мультитенантный режим

Возможные значения: true, false

false

1.0

Настройки для конфигурации в окружение Platform V Backend#

Наименование параметра в файле конфигурирования

Расположение

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

Ограничения

Значение по умолчанию или глобальные параметры при установке Deploy tools

Версия ПО

dcgn.platform.audit.host

Репозиторий настройки компонента, файл dcgn.istio.all.conf

Хост подключения к компоненту Аудит

-

1.0

dcgn.platform.audit.port

Репозиторий настройки компонента, файл dcgn.istio.all.conf

Порт подключения к компоненту Аудит

-

1.0

dcgn.platform.audit.protocol

Репозиторий настройки компонента, файл dcgn.istio.all.conf

Протокол подключения к компоненту Аудит

-

1.0

dcgn.platform.audit.egress.ose.vs.spec.http.retries.attempts

Репозиторий настройки компонента, файл dcgn.istio.all.conf

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

-

10

1.0

dcgn.platform.audit.egress.ose.vs.spec.http.retries.perTryTimeout

Репозиторий настройки компонента, файл dcgn.istio.all.conf

Максимальное время ожидания одной попытки

Формат:
- h — часы;
- m — минуты;
- s — секунды;
- ms — миллисекунды. Должно быть больше или равно 1ms

2s

1.0

dcgn.platform.audit.egress.ose.vs.spec.http.timeout

Репозиторий настройки компонента, файл dcgn.istio.all.conf

Общее максимальное время ожидания выполнения запроса

Формат:
- h — часы;
- m — минуты;
- s — секунды;
- ms — миллисекунды. Должно быть больше или равно 1ms

5s

1.0

Параметры для template-registry

-

-

-

-

-

dcgn.template-registry.platform.audit-proxy.contextPath

Репозиторий настройки компонента, файл dcgn.template-registry.conf

Контекстный путь компонента Аудит (например /audit2)

-

Не установлено

1.0

dcgn.template-registry.platform.audit-proxy.baseurl

Репозиторий настройки компонента, файл dcgn.template-registry.conf

URL для подключения к компоненту Аудит

-

1.0

dcgn.template-registry.platform.audit.module.id

Репозиторий настройки компонента, файл dcgn.template-registry.conf

Параметр для событий Аудита

-

CI90000079_DCGN

4.0.0

Параметры аудита для ott

-

-

-

-

-

dcgn.platform.ott.audit.host

Репозиторий настройки компонента, файл dcgn.istio.all.conf

Хост подключения к компоненту Аудит без ott

-

3.0.0.0

dcgn.platform.ott.audit.port

Репозиторий настройки компонента, файл dcgn.istio.all.conf

Порт подключения к компоненту Аудит

-

3.0.0.0

dcgn.platform.ott.audit.protocol

Репозиторий настройки компонента, файл dcgn.istio.all.conf

Протокол подключения к компоненту Аудит

-

3.0.0.0

Настройки для конфигурации в окружение Platform V Frontend Std#

Совместно с сервисами компонента DCGN происходит установка сервиса ufs-adapter, который обеспечивает интеграцию с компонентом Аудит в окружении Platform V Frontend Std.

Наименование параметра в файле конфигурирования

Расположение

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

Ограничения

Значение по умолчанию или глобальные параметры при установке Deploy tools

Версия ПО

dcgn.union-audit.CImodule

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Имя модуля (сервиса/АС/подсистемы/приложения)

-

_template-registry

1.4.6

dcgn.union-audit.sourceSystem

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Идентификатор инсталляции, в которой происходит событие

-

1.4.6

union-audit.useQuota

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Использование квотирования

Возможные значения: true, false

false

1.4

union-audit.circuit-breaker.mode

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Режим работы главного балансировщика (DUP - включает режим дублирования, STD - стандартный режим)

-

1.4

Параметры для каждого экземпляра kafka_union_audit_list

-

-

-

-

-

union-audit.kafka.$$$item.name$$$.bootstrap.servers

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

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

-

dcgn-svc-egress-audit-$$$ item.name | replace(„_“, „-“) | lower $$$-unver..svc.cluster.local:

1.4.7

union-audit.kafka.$$$item.name$$$.batch.size

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Максимальных размер batch с сообщениями

-

1.4

union-audit.kafka.$$$item.name$$$.buffer.memory

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Объем буфера, хранящего сообщения перед отправкой

-

1.4

union-audit.kafka.$$$item.name$$$.compression.type

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Сжатие данных

-

1.4

union-audit.kafka.$$$item.name$$$.connections.max.idle.ms

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Тайм-аут закрытия неиспользуемых подключений

-

1.4

union-audit.kafka.$$$item.name$$$.delivery.timeout.ms

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

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

-

1.4

union-audit.kafka.$$$item.name$$$.linger.ms

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Фиксация времени, затрачиваемого на сбор batch

-

1.4

union-audit.kafka.$$$item.name$$$.max.block.ms

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Время блокировки буфера при его переполнении либо недоступности метаданных

-

1.4

union-audit.kafka.$$$item.name$$$.max.request.size

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Максимальный размер запроса (сообщения) producer

-

1.4

union-audit.kafka.$$$item.name$$$.metadata.max.age.ms

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Время, через которое происходит принудительное обновление метаданных «по графику», не зависящее от внешних изменений

-

1.4

union-audit.kafka.$$$item.name$$$.receive.buffer.bytes

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Размер TCP-буфера на чтение данных

-

1.4

union-audit.kafka.$$$item.name$$$.request.timeout.ms

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Максимальное время ожидания ответа от сервера на запрос.

-

1.4

union-audit.kafka.$$$item.name$$$.send.buffer.bytes

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Размер TCP-буфера на отправку сообщения

-

1.4

union-audit.kafka.$$$item.name$$$.security.protocol

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Протокол безопасности, по которому происходит подключение к Kafka

-

PLAINTEXT

1.4

union-audit.kafka.$$$item.name$$$.ssl.endpoint.identification.algorithm

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Алгоритм идентификации точки подключения, используемый клиентом

-

1.4

union-audit.kafka.$$$item.name$$$.ssl.enabled.protocols

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

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

-

1.4

Параметры для каждого экземпляра balance_group_union_audit_list

-

-

-

-

-

union-audit.kafka.$$$item.name$$$.topic.audit-events-crit-in

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Topic для отправки критичных событий

- Значение параметра для при условии group.protocol == «UFS»
- Значение параметра для при условии group.protocol == «AVRO»
- Значение параметра для при условии group.protocol in [«UNION», «PRE_UNION»]

-
-
-

1.4

union-audit.kafka.$$$item.name$$$.topic.audit-events-uncrit-in

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

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

- Значение параметра для при условии group.protocol == «UFS»
- Значение параметра для при условии group.protocol == «AVRO»
- Значение параметра для при условии group.protocol in [«UNION», «PRE_UNION»]

-
-
-

1.4

union-audit.kafka.$$$item.name$$$.topic.audit-metamodel-in

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Topic для отправки метамоделей

Значение параметра для при условии group.protocol == «UFS»

1.4

Парамтеры групп балансировки для КМ Аудит balance_group_union_audit_list

-

-

-

-

-

union-audit.balance_group.$$$item.name$$$.main

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

-

-

$$$item.main$$$

1.4

union-audit.balance_group.$$$item.name$$$.providerClass

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

-

-

$$$item.provider_class$$$

1.4

union-audit.balance_group.$$$item.name$$$.priority

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

-

-

$$$loop.revindex * 11$$$

1.4

union-audit.balance_group.$$$item.name$$$.eventProtocol

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

-

-

$$$item.protocol$$$

1.4

union-audit.balance_group.$$$item.name$$$.balanceMode

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

-

-

RR

1.4

union-audit.balance_group.$$$item.name$$$.circuit_breaker.recoveryTimeout

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Время восстановления после сбоя в миллисекундах для Circuit breaker в КМ Аудит

-

1.4

union-audit.balance_group.$$$item.name$$$.circuit_breaker.successThreshold

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Количество успешных отправок для перехода из состояния half-open в close

-

1.4

union-audit.balance_group.$$$item.name$$$.circuit_breaker.mode

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Режим работы основного circuit breaker

-

ERROR_WINDOW

1.4

union-audit.balance_group.$$$item.name$$$.circuit_breaker.failureThreshold

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Количество ошибок для открытия Circuit breaker в КМ Аудит

-

1.4

union-audit.balance_group.$$$item.name$$$.providers

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

-

-

$$$item.providers | join(„,“)$$$

1.4

Настройки для конфигурации в окружение Platform V Frontend High Load#

Совместно с сервисами компонента DCGN происходит установка сервиса ufs-adapter, который обеспечивает интеграцию с компонентом Аудит в окружении Platform V Frontend High Load.

Наименование параметра в файле конфигурирования

Расположение

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

Ограничения

Значение по умолчанию или глобальные параметры при установке Deploy tools

Версия ПО

Параметры для каждого экземпляра kafka_union_audit_list

-

-

-

-

1.5.0

union-audit.kafka.$$$item.name$$$.bootstrap.servers

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

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

-

$$$item.bootstrap$$$

1.5.0

union-audit.kafka.$$$item.name$$$.batch.size

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Максимальных размер batch с сообщениями

-

1.5.0

union-audit.kafka.$$$item.name$$$.buffer.memory

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Объем буфера, хранящего сообщения перед отправкой

-

1.5.0

union-audit.kafka.$$$item.name$$$.compression.type

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Сжатие данных

-

1.5.0

union-audit.kafka.$$$item.name$$$.connections.max.idle.ms

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Тайм-аут закрытия неиспользуемых подключений

-

1.5.0

union-audit.kafka.$$$item.name$$$.delivery.timeout.ms

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

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

-

1.5.0

union-audit.kafka.$$$item.name$$$.linger.ms

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Фиксация времени, затрачиваемого на сбор batch

-

1.5.0

union-audit.kafka.$$$item.name$$$.max.block.ms

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Время блокировки буфера при его переполнении либо недоступности метаданных

-

1.5.0

union-audit.kafka.$$$item.name$$$.max.request.size

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Максимальный размер запроса (сообщения) producer

-

1.5.0

union-audit.kafka.$$$item.name$$$.metadata.max.age.ms

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Время, через которое происходит принудительное обновление метаданных «по графику», не зависящее от внешних изменений

-

1.5.0

union-audit.kafka.$$$item.name$$$.receive.buffer.bytes

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Размер TCP-буфера на чтение данных

-

1.5.0

union-audit.kafka.$$$item.name$$$.request.timeout.ms

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Максимальное время ожидания ответа от сервера на запрос.

-

1.5.0

union-audit.kafka.$$$item.name$$$.send.buffer.bytes

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Размер TCP-буфера на отправку сообщения

-

1.5.0

union-audit.kafka.$$$item.name$$$.security.protocol

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Протокол безопасности, по которому происходит подключение к Kafka

-

1.5.0

union-audit.kafka.$$$item.name$$$.ssl.endpoint.identification.algorithm

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Алгоритм идентификации точки подключения, используемый клиентом

-

1.5.0

union-audit.kafka.$$$item.name$$$.ssl.enabled.protocols

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

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

-

1.5.0

Параметры для каждого экземпляра balance_group_union_audit_list

-

-

-

-

-

union-audit.kafka.$$$item.name$$$.topic.audit-events-crit-in

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Topic для отправки критичных событий

-

audit-events-crit-in

1.5.0

union-audit.kafka.$$$item.name$$$.topic.audit-events-uncrit-in

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

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

-

audit-events-uncrit-in

1.5.0

union-audit.kafka.$$$item.name$$$.topic.audit-metamodel-in

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Topic для отправки метамоделей

-

audit-metamodel-in

1.5.0

Парамтеры групп балансировки для КМ Аудит balance_group_union_audit_list

-

-

-

-

-

union-audit.balance_group.$$$item.name$$$.main

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

-

-

$$$item.main$$$

1.5.0

union-audit.balance_group.$$$item.name$$$.providerClass

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

-

-

$$$item.provider_class$$$

1.5.0

union-audit.balance_group.$$$item.name$$$.priority

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

-

-

$$$loop.revindex * 11$$$

1.5.0

union-audit.balance_group.$$$item.name$$$.eventProtocol

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

-

-

$$$item.protocol$$$

1.5.0

union-audit.balance_group.$$$item.name$$$.balanceMode

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

-

-

RR

1.5.0

union-audit.balance_group.$$$item.name$$$.circuit_breaker.recoveryTimeout

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Время восстановления после сбоя в миллисекундах для Circuit breaker в КМ Аудит

-

1.5.0

union-audit.balance_group.$$$item.name$$$.circuit_breaker.successThreshold

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Количество успешных отправок для перехода из состояния half-open в close

-

1.5.0

union-audit.balance_group.$$$item.name$$$.circuit_breaker.mode

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Режим работы основного circuit breaker

-

ERROR_WINDOW

1.5.0

union-audit.balance_group.$$$item.name$$$.circuit_breaker.failureThreshold

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

Количество ошибок для открытия Circuit breaker в КМ Аудит

-

1.5.0

union-audit.balance_group.$$$item.name$$$.providers

Репозиторий настройки компонента, файл dcgn.ufs-adapter.conf

-

-

$$$item.providers | join(„,“)$$$

1.5.0