Общая конфигурация сервисов Coordinator#

server.jetty.threads.max

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

long

200

нет

spring.cloud.vault.app-role.app-role

App role для аутентификации

string

-

нет

spring.cloud.vault.app-role.role-id

Role id для аутентификации

password

-

нет

spring.cloud.vault.authentication

Тип аутентификации в vault. Возможные варианты: - token, - kubernetes, - app-role

string

app-role

нет

spring.cloud.vault.enabled

Включение использования vault

boolean

false

нет

spring.cloud.vault.uri

URI хранилища с секретами vault

string

-

нет

spring.cloud.vault.read-timeout

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

long

15000

нет

pvm.system.security.ssl.ca-certificates

Путь к сертификату CA (или сертификат CA)

string

-

нет

pvm.system.security.ssl.certificate-ip-sans

Список IP SANов (Subject Alternative Names) для SSL-сертификатов в системе PVM. Формат ip1,ip2,…

string

-

нет

spring.datasource.url

JDBC URL для подключения к БД. Формат: jdbc:postgresql://localhost:5432/db

string

-

да

spring.datasource.password

Пароль для подключения к БД

secret

-

нет

spring.flyway.user

Имя flyway пользователя для подключения к БД

string

см. раздел конфигурации сервиса

нет

spring.datasource.hikari.connection-timeout

Таймаут получения соединения из пула соединений. К таймауту может приводить длительное подключение к БД или отсутствие свободных соединений в пуле. Задается в миллисекундах. Минимальное допустимое значение 250 ms. (если spring.datasource.type = com.zaxxer.hikari.HikariDataSource)

long

30000

нет

spring.datasource.hikari.maximum-pool-size

Максимальный размер пула соединений (если spring.datasource.type = com.zaxxer.hikari.HikariDataSource)

long

6

нет

spring.datasource.hikari.max-lifetime

Максимальное время жизни соединения в пуле. Используемые соединения не закрываются при достижении данного значения. Рекомендуется обязательно устанавливать и использовать значение на несколько секунд меньше чем таймаут используемой БД. Задается в миллисекундах. Минимальное допустимое значение 30000ms (30 seconds). (если spring.datasource.type = com.zaxxer.hikari.HikariDataSource)

long

1200000

нет

spring.datasource.hikari.allow-pool-suspension

Включает возможность остановки пула соединений (может потребоваться для дианостики нештатной работы подключения сервисов Abyss к бд)

boolean

true

нет

service.java.home

Переменная окружения, указывающая на директорию с установленным JDK. Переопределеяет значение JAVA_HOME для компонента.

string

-

нет

server.max-http-header-size

Максимально разрешенный размер заголовка HTTP запроса

string

32KB

нет

common.internal-communication.max-retries

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

int

2

нет

logger.kafka.bootstrap-servers

Список Kafka брокеров для отправки логов. Список должен содержать больше, чем одного брокера для большей доступности, но не обязательно перечислять их всех. Формат: hostname1:port1,hostname2:port2.

string

-

нет

logger.directory

Директория, в которой будут храниться логи сервиса

string

/var/log/abyss

нет

logger.max-file-amount

Максимальное число файлов логов на сервере

long

10

нет

- ALL;

- DEBUG;

- WARN;

- OFF.

- ALL;

- DEBUG;

- WARN;

- OFF.

common.discovery.type

Определяет, каким способом будет происходить регистрация сервисов, с помощью ZooKeeper или же статически, используя готовый список хостов. Возможные значения: STATIC/ZOOKEEPER.

string_enum

ZOOKEEPER

нет

common.discovery.zookeeper.retry-interval-ms

Интервал между попытками переподключения к ZooKeeper в миллисекундах

string

10000

нет

common.discovery.zookeeper.acl-enabled

Включает автоустановку ACL на Znode для обнаружения сервисов

boolean

false

нет

common.http.client.socket-timeout-ms

Тайм-аут сокета на клиенте. Максимальное ограничение бездействия между двумя пакетами в миллисекундах.

long

50000

нет

common.http.client.eviction.interval-ms

Интервал, по истечении которого будут закрыты все бездействующие соединения

long

10000

нет

common.http.client.max-connections

Максимальное количество HTTP соединений

long

1000

нет

common.tracing.enabled

Включение/отключение функциональности трейсинга

boolean

false

нет

common.tracing.sampling-percent

Количество трейсов в процентном отношении, которые будут отправлены на сервер сбора трейсов. Если был создан составной трейс, то он отправляется на сервер целиком. Возможные значения: 1-100.

long

100

нет

common.metric.distributionStatisticExpiry

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

long

15

нет

pvm.system.security.ssl.certificates.common-internal-communication.client-certificate

Путь к клиентскому сертификату (или клиентский сертификат) для межмодульного взаимодействия по SSL

secret

-

нет

pvm.system.security.ssl.certificates.common-internal-communication.private-key

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

secret

-

нет

pvm.system.security.ssl.certificates.common-internal-communication.verify-hosts

Параметр, включающий проверку сертификата хоста для межмодульного взаимодействия по SSL

boolean

false

нет

common.internal-communication.ssl.protocol

Протокол межмодульного взаимодействия, возможны три варианта:

string_enum

PLAINTEXT

нет

SSL_WANT - опциональный TLS (если включен на модуле, к которому осуществляется подключение),

pvm.system.security.ssl.certificates.global.client-certificate

Путь к клиентскому сертификату (или клиентский сертификат) (глобальный для всего модуля)

secret

-

нет

pvm.system.security.ssl.certificates.global.private-key-password

Пароль от приватного ключа (глобальный для всего модуля)

secret

-

нет

Путь к клиентскому сертификату (или клиентский сертификат) для доступа к COTE по SSL в формате PEM

string

-

нет

Параметр позволяющий установить значения параметров SSL контекста audit-client из указанного SSL контекста

string

global

нет

Пароль от приватного ключа для доступа к COTE по SSL

password

-

нет

Путь к клиентскому сертификату (или клиентский сертификат) для доступа к Kafka по SSL в формате PEM

string

-

нет

Параметр, позволяющий установить значения параметров SSL контекста audit-kafka-client из указанного SSL контекста

string

global

нет

Пароль от приватного ключа для доступа к Kafka по SSL

password

-

нет

pvm.system.security.ssl.certificates.common-tracing.client-certificate

Путь к клиентскому сертификату (или клиентский сертификат) для доступа к серверу выполняющему сбор трейсов по SSL в формате PEM

secret

-

нет

pvm.system.security.ssl.certificates.common-tracing.private-key

Путь к приватному ключу (или приватный ключ) для доступа к серверу выполняющему сбор трейсов по SSL

secret

-

нет

pvm.system.security.ssl.certificates.common-tracing.verify-hosts

Параметр, включающий проверку сертификата хоста для доступа к серверу выполняющему сбор трейсов по SSL

boolean

false

false

pvm.system.security.ssl.certificates.logger-ssl.client-certificate

Путь к клиентскому сертификату (или клиентский сертификат) для доступа KafkaAppender к Kafka по SSL в формате PEM

secret

-

нет

pvm.system.security.ssl.certificates.logger-ssl.overridden-by

Параметр, позволяющий установить значения параметров SSL контекста logger-ssl из указанного SSL контекста

string

global

нет

pvm.system.security.ssl.certificates.logger-ssl.private-key-password

Пароль от приватного ключа для доступа KafkaAppender к Kafka по SSL

secret

-

нет

pvm.system.security.ssl.certificates.database.client-certificate

Путь к клиентскому сертификату (или клиентский сертификат) для доступа к БД по SSL в формате PEM

secret

-

нет

pvm.system.security.ssl.certificates.database.private-key

Путь к приватному ключу (или приватный ключ) для доступа к БД по SSL

secret

-

нет

pvm.system.security.ssl.certificates.server.client-certificate

Путь к клиентскому сертификату (или клиентский сертификат) для входящих соединений по SSL в формате PEM

secret

-

нет

pvm.system.security.ssl.certificates.server.mutual-enabled

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

boolean

false

нет

pvm.system.security.ssl.certificates.server.private-key

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

secret

-

нет

pvm.system.security.ssl.certificates.common-auth-iam.client-certificate

Путь к клиентскому сертификату (или клиентский сертификат) для доступа к IAM по SSL

secret

-

нет

pvm.system.security.ssl.certificates.common-auth-iam.private-key

Путь к приватному ключу (или приватный ключ) для доступа к IAM по SSL

secret

-

нет

pvm.system.security.ssl.certificates.common-auth-iam.verify-hosts

Параметр, включающий проверку сертификата хоста для доступа к IAM по SSL

boolean

false

нет

common.auth.type

Тип аутентификации (для подключения к OIDC провайдеру), два возможных значения:

string_enum

SECRET_AND_JWK

нет

- SECRET_AND_JWK.

common.auth.jwk-resource-server

Сервер ресурсов jwk с ключами для проверки подписи JWT (для подключения к OIDC провайдеру). Формат: https://url/to/jwk/resource/server.

string

-

да

common.auth.certificate.get-cert-from-header

Параметр, определяющий необходимость доставать сертификат из заголовка sslClientCertHeader

boolean

true

нет

common.service.api-basepath

Путь к API

string

api

нет

common.pvm-security.ssl.protocol

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

string_enum

PLAINTEXT

нет

- SSL_WANT,

common.pvm-security.max-retries

Максимальное количество переподключений к сервису авторизации

long

2

нет

common.pvm-security.password

Пароль для подключения к сервису авторизации

secret

-

нет

common.pvm-security.port

Порт, на котором запущен сервис авторизации

long

29102

нет

common.pvm-security.api-basepath

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

string

v1

нет

service.metrics.kafka.bootstrap-servers

Список Kafka брокеров (список должен содержать больше, чем одного брокера для большей доступности, но не обязательно перечислять их всех). Формат: hostname1:port1,hostname2:port2.

string

-

нет

service.metrics.kafka.acks

Конфигурация подтверждений:

string_enum

-1

нет

1 - получает подтверждение после того, как реплика лидера получила данные;

service.metrics.kafka.compression_codec

Конфигурация сжатия:

string_enum

3

нет

1 - Gzip;

3 - LZ4;

service.metrics.kafka.max_message_bytes

Максимально допустимый размер сообщения. Должно быть меньше или равно, чем значение параметра message.max.bytes в Kafka.

long

1000000

нет

service.metrics.buffer_limit

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

long

10000

нет

service.metrics.config-dir

Путь до директории конфигурации, в который записывается содержимое параметра-шаблона metrics_config

path

/etc/telegraf/telegraf.d/{service_name}

нет

service.metrics.flush_interval

Интервал публикации метрик в Kafka

string

30s

нет

service.metrics.kafka.group-id

Идентификатор группы для Kafka-producer, под которым будет осуществляться отправка метрик в Kafka

string

см. раздел конфигурации сервиса

нет

service.metrics.kafka.data_format.template

Шаблон сообщений отправляемых в Kafka в формате GO template (используется только, если data_format = template)

string

{«labels.telegraf_metric_name»:»»,\n \n \n «»:»»,\n \n «labels.»:»»,\n \n \n \n \n «»:,\n \n «labels.»:»»,\n \n \n «timestamp»:}

нет

service.metrics.client.ssl.tls_ca

Путь до корневого сертификата в формате PEM, используемого при установлении соединения с эндпоинтом Actuator сервиса

string

-

нет

service.metrics.client.ssl.tls_key

Путь до ключа от сертификата в формате PEM, используемого при установлении соединения с эндпоинтом Actuator сервиса

string

-

нет

service.metrics.kafka.ssl.enabled

Включение/Выключение TLS при установлении соединения с Kafka

boolean

false

нет

service.metrics.kafka.ssl.tls_cert

Путь до клиентского сертификата в формате PEM, используемого при установлении соединения с Kafka

string

-

нет

service.metrics.kafka.ssl.skip-verify-hosts

Параметр, выключающий проверку сертификата хоста при установлении TLS соединения c Kafka

boolean

false

нет

abyss.audit.enabled

Включение/выключение аудита

boolean

false

нет

ASYNC - асинхронный REST клиент

KAFKA - Kafka клиент

abyss.audit.client.ssl.enabled

Включение/выключение TLS для соединения с COTE

boolean

false

нет

abyss.audit.kafka.client.bootstrap-servers

Список Kafka брокеров для отправки метамодели и событий аудита. Формат: hostname1:port1,hostname2:port2.

string

-

нет

abyss.audit.kafka.client.source-system

Идентификатор исходной системы (AS)

string

tengri

нет

- PLAINTEXT

- SASL_PLAINTEXT

abyss.audit.kafka.client.sync-send-enabled

Флаг, включающий синхронный режим отправки сообщений в Kafka

boolean

true

нет

abyss.audit.kafka.client.producer.delivery-timeout-ms

Время ожидания подтверждения от Kafka брокера об успешной доставке сообщения.

long

120000

нет

Отличается от delivery-timeout-ms тем что delivery-timeout-ms охватывает всю цепочку доставки сообщения

а request-timeout-ms ограничивает время ожидания ответа одного запроса к брокеру Kafka.

abyss.audit.kafka.client.producer.kafka-event-topic-name

Топик для публикации событий аудита

string

abyss.coordinator_audit_events

нет

abyss.audit.ott.enabled

Включение/выключение OTT для аудита

boolean

false

нет

abyss.audit.ott.service-hosts

Список серверов OTT. Формат: hostname1:port1,hostname2:port2.

string

-

нет

management.endpoints.web.exposure.include

Список включенных endpoints Actuator, поддерживается только prometheus, пустое значение отключает метрики

string

prometheus

нет

common.actuator.basic-auth.enabled

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

boolean

false

нет

common.actuator.basic-auth.password

Пароль пользователя для Basic Auth для Actuator

secret

-

нет

management.endpoints.web.exposure.include

Список включенных endpoints Actuator, поддерживается только prometheus, пустое значение отключает метрики

string

prometheus

common.actuator.basic-auth.enabled

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

boolean

false

common.actuator.basic-auth.password

Пароль для Basic Auth

password