Конфигурационные параметры ADS Control

Статья описывает параметры, которые могу быть настроены для сервиса ADS Control через ADCM. Процесс настройки сервиса приведен в соответствующих статьях: Online-установка, Offline-установка.

ПРИМЕЧАНИЕ
Некоторые из перечисленных параметров становятся доступны в UI ADCM после установки флага Show advanced.

В описаниях конфигурации используются понятия, относящиеся к фреймворку Eclipse Vert.x:

  • Вертикль (verticle) — фрагмент кода, являющийся циклом обработки событий (Event Loop), который может быть развернут в среде Vert.x.

  • Рабочий вертикль (worker verticle) — вертикль, который выполняется с использованием потока из пула уже созданных рабочих потоков Vert.x, а не с использованием цикла новых событий.

General

 

Параметр Описание Значение по умолчанию

server.http.port

Порт для подключения к UI ADS Control

8888

server.vertx.pools.eventLoopPoolSize

Максимальное количество вертиклей Event Loop в пуле

8

server.vertx.pools.workerPoolSize

Максимальное количество рабочих вертиклей в пуле

20

server.vertx.config.clusterResponseTimeoutMs

Интервал времени для запроса получения метрик от кластера Kafka (в мс)

500

JMX Workers

 

Параметр Описание Значение по умолчанию

server.vertx.verticle.jmx.instances

Количество экземпляров вертиклей JMX, которые получают и обрабатывают запрос с кластера ADS по JMX

1

server.vertx.verticle.jmx.workerPoolSize

Максимальное количество рабочих вертиклей JMX в пуле

5

server.vertx.verticle.jmx.jmxPoolTimeMilliseconds

Интервал времени для запроса получения метрик с кластера ADS по JMX (в мс)

60000

Kafka Workers

 

Параметр Описание Значение по умолчанию

server.vertx.verticle.kafka-cluster-info-producer.instances

Количество экземпляров вертиклей kafka-cluster-info-producer, которые получают данные от кластеров ADS и записывают в вертикли kafka-cluster-info-storage

1

server.vertx.verticle.kafka-cluster-info-producer.workerPoolSize

Количество экземпляров рабочих вертиклей kafka-cluster-info-producer в пуле

7

server.vertx.verticle.kafka-cluster-info-storage.instances

Количество экземпляров вертиклей kafka-cluster-info-storage, в которые записываются и хранятся данные последних опросов кластеров ADS

1

server.vertx.verticle.kafka-cluster-info-storage.workerPoolSize

Количество экземпляров рабочих вертиклей kafka-cluster-info-storage в пуле

1

server.vertx.verticle.kafka-cluster-name-publisher.instances

Kоличество экземпляров вертиклей kafka-cluster-name-publisher, которые передают данные об импортированных кластерах Kafka в вертикли kafka-cluster-info-producer для запуска опроса кластеров

1

server.vertx.verticle.kafka-cluster-name-publisher.workerPoolSize

Количество экземпляров рабочих вертиклей kafka-cluster-name-publisher в пуле

1

server.vertx.verticle.kafka-cluster-name-publisher.pushPeriodMilliseconds

Период между запросами информации об импортированных кластерах вертиклем kafka-cluster-name-publisher (в мс)

5000

server.vertx.verticle.kafka-cluster-name-publisher.responseTimeoutMilliseconds

Время ожидания при запросе информации об импортированных кластерах вертиклем kafka-cluster-name-publisher (в мс)

15000

server.vertx.verticle.kafka-offset-info-producer.instances

Количество экземпляров вертиклей kafka-offset-info-producer, которые получают данные о последних смещениях в топиках Kafka и записывают в вертикль kafka-cluster-info-storage

1

server.vertx.verticle.kafka-offset-info-producer.workerPoolSize

Количество экземпляров рабочих вертиклей kafka-offset-info-producer в пуле

2

server.vertx.verticle.kafka-offset-info-producer.updatePeriodMilliseconds

Период между запросами данных о последних смещениях в топиках Kafka кластеров ADS (в мс)

200

server.vertx.verticle.kafka-commit-offset-info-producer.instances

Количество экземпляров вертиклей kafka-commit-offset-info-producer, которые получают данные о последнем смещении топика __consumer_offsets (данные о последнем прочитанном сообщении потребителем)

1

server.vertx.verticle.kafka-commit-offset-info-producer.workerPoolSize

Количество экземпляров рабочих вертиклей kafka-commit-offset-info-producer в пуле

2

Kafka Consumer

 

Параметр Описание Значение по умолчанию

server.vertx.kafka.lastOffsetPollTimeoutMs

Тайм-аут последнего опроса смещения топика __consumer_offsets (данные о последнем прочитанном сообщении потребителем) (в мс)

200

Basic authentication

 

Параметр Описание Значение по умолчанию

Admin Password

Пароль администратора ADS Control

 — 

SSL

 

Параметр Описание Значение по умолчанию

server.http.ssl.keyStoreFilename

Название хранилища ключей

certs/keystore.jks

server.http.ssl.keyStorePassword

Пароль хранилища ключей

 — 

Logging

 

    Параметр logback_template — определяет шаблон лога.

    Значение по умолчанию:

 <?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <property name="LOG_PATH" value="logs/app.log"/>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
            </pattern>
        </encoder>
    </appender>

    <appender name="FILE-ROLLING" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_PATH}</file>

        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>logs/archived/app.%d{yyyy-MM-dd}.%i.log.gz</fileNamePattern>
            <!-- each archived file, size max 10MB -->
            <maxFileSize>10MB</maxFileSize>
            <!-- total size of all archive files, if total size > 20GB, it will delete old archived file -->
            <totalSizeCap>20GB</totalSizeCap>
            <!-- 60 days to keep -->
            <maxHistory>60</maxHistory>
        </rollingPolicy>

        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    <root level="INFO">
        <appender-ref ref="STDOUT"/>
    </root>
    <logger name="io.arenadata.adscc" level="DEBUG">
        <appender-ref ref="FILE-ROLLING"/>
    </logger>
    <logger name="io.arenadata.adscc" level="DEBUG">
        <appender-ref ref="STDOUT"/>
    </logger>
    <logger name="org.apache.kafka" level="ERROR">
        <appender-ref ref="STDOUT"/>
    </logger>
</configuration>
Monitoring

 

Параметр Описание Значение по умолчанию

server.monitoring.openTelemetry.enable

Включение системы мониторинга "OpenTelemetry"

ON

server.monitoring.prometheus.enable

Включение системы мониторинга "Prometheus"

ON

Client

 

Параметр Описание Значение по умолчанию

client.http.webClientOptions.maxPoolSize

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

100

client.http.circuitbreaker.maxFailures

Количество отказов, при котором паттерн Circuit Breaker отключает выполнение операции

3

client.http.circuitbreaker.timeout

Значение, при превышении которого запрос увеличивает значение количества отказов (в мс)

500

client.http.circuitbreaker.fallbackOnFailure

Устанавливает, выполняются ли резервные действия при отказе, даже если цепь замкнута

ON

client.http.circuitbreaker.resetTimeout

Время, после которого паттерн circuit breaker попытается повторно замкнуть цепь (в мс)

100

Kafka Clusters

 

Группа Параметр Описание

clusters

name

Имя кластера Kafka

bootstrapServers

Bootstrap-серверы кластера Kafka

schemaRegistryUrl

URL подключения к Schema Registry

jmxClientProperties

JMX-порт

kafkaConnectClusters

name

Имя кластера Kafka Connect

url

URL подключения к Kafka Connect

jmxClientProperties

JMX-порт

Нашли ошибку? Выделите текст и нажмите Ctrl+Enter чтобы сообщить о ней