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

Описание параметров плагина kafka_exporter.

Параметры запуска экспортера и сбора метрик с него#

Basic Auth Password#

Пароль пользователя BasicAuth для доступа к экспортеру.

Значение по умолчанию: skala-r.

Только запись: Да.

Basic Auth Username#

Имя пользователя BasicAuth для доступа к экспортеру.

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

Group Exclude#

Регулярное выражение, определяющее, какие потребительские группы исключить.

Значение по умолчанию: '^$' (никакие).

Group Filter#

Регулярное выражение, определяющее, какие потребительские группы собирать.

Значение по умолчанию: '.*' (все).

Kafka Allow Auto Topic Creation#

Автоматическое создание запрошенных топиков, которые ещё не существуют.

Значение по умолчанию: False (создание несуществующих топиков выключено).

Kafka Servers#

Адрес сервера Kafka или список адресов серверов Kafka.

Адреса задаются в формате host:port, где:

  • host — имя хоста.

    Имя хоста может содержать буквы латинского алфавита, цифры, точки . и дефисы -.

  • port — номер порта.

    Номер порта должен быть в диапазоне от 1 до 65535 включительно.

Значение по умолчанию: ['kafka:9092'].

Kafka Tls Ca File#

Путь к файлу CA для аутентификации клиента Kafka TLS (необязательно).

Значение по умолчанию: '' (пустая строка).

Kafka Tls Cert File#

Путь к файлу сертификата для аутентификации клиента Kafka TLS (необязательно).

Значение по умолчанию: '' (пустая строка).

Kafka Tls Enabled#

Подключение к Kafka с TLS.

Значение по умолчанию: False (подключение без TLS).

Kafka Tls Key File#

Путь к файлу ключа сертификата для аутентификации клиента Kafka TLS (необязательно).

Значение по умолчанию: '' (пустая строка).

Kafka Tls Server Name#

Имя сервера Kafka. Значение этого параметра используется для проверки имени хоста в возвращаемых сертификатах, если не задан пропуск проверки сертификата.

Значение по умолчанию: '' (пустая строка).

Kafka Tls Skip Verify#

Пропуск проверки сертификата TLS.

Значение по умолчанию: False (проверка сертификата включена).

Kafka Version#

Версия брокера Kafka.

Номер версии может состоять из трёх или четырёх цифр, разделённых точками. При этом, если номер состоит из четырёх цифр, первая цифра — 0.

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

Offset Show All#

Отображение смещения или задержки для всех групп потребителей.

Значение по умолчанию: True (задержки и смещения показываются только для подключённых групп потребителей).

Refresh Metadata#

Интервал обновления метаданных.

Допустимая длина строки: от 1 до 255 знаков.

Период времени.

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

Sasl Disable Pa Fx Fast#

Сконфигурировать клиент Kerberos без использования PA_FX_FAST. Используется только при sasl_mechanism="gssapi".

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

Sasl Enabled#

Подключение с использованием SASL/PLAIN.

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

Sasl Handshake#

Использование SASL-handshake при подключении к Kafka. Присвойте параметру значение False, если используется SASL-прокси, не связанный с Kafka.

Значение по умолчанию: True (включено).

Sasl Kerberos Auth Type#

Тип аутентификации Kerberos. Используется только при sasl_mechanism="gssapi".

Допустимые значения:

  • keytabAuth;
  • userAuth.

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

Sasl Kerberos Config Path#

Путь к конфигурации Kerberos. Используется только при sasl_mechanism="gssapi".

Значение по умолчанию: '' (пустая строка).

Sasl Keytab Path#

Путь к файлу keytab для Kerberos. Используется только при sasl_mechanism="gssapi" и sasl_kerberos_auth_type="keytabAuth".

Значение по умолчанию: '' (пустая строка).

Sasl Mechanism#

Механизм SASL.

Допустимые значения:

  • scram-sha256;
  • scram-sha512;
  • gssapi;
  • plain.
  • '' (пустая строка).

Значение по умолчанию: '' (пустая строка).

Sasl Password#

Пароль пользователя SASL.

Значение по умолчанию: '' (пустая строка).

Sasl Realm#

Realm Kerberos. Используется только при sasl_mechanism="gssapi".

Значение по умолчанию: '' (пустая строка).

Sasl Service Name#

Имя сервиса при использовании аутентификации Kerberos. Используется только при sasl_mechanism="gssapi".

Значение по умолчанию: '' (пустая строка).

Sasl Username#

Имя пользователя SASL.

Значение по умолчанию: '' (пустая строка).

Scrape Interval#

Периодичность опроса экспортера.

Значение по умолчанию: 15s (15 секунд).

Допустимая длина строки: от 1 до 255 знаков.

Период времени: Да.

Scrape Timeout#

Таймаут опроса таргетов. Значение не должно превышать значение параметра Scrape Interval.

Значение по умолчанию: 10s (10 секунд).

Допустимая длина строки: от 1 до 255 знаков.

Период времени: Да.

Tls Cert File#

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

Значение по умолчанию: /opt/skala-r/vision/cert/components_default.crt.

Tls Insecure Skip Verify#

Пропуск проверки сертификата при подключении агента к источнику метрик.

Значение по умолчанию: False (проверка сертификата включена).

Tls Key File#

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

Значение по умолчанию: /opt/skala-r/vision/cert/components_default.key.

Topic Exclude#

Регулярное выражение, определяющее, какие топики исключить.

Значение по умолчанию: '^$' (никакие).

Topic Filter#

Регулярное выражение, определяющее, какие топики собирать.

Значение по умолчанию: '.*' (все).

Topic Workers#

Количество параллельных потоков для обработки топиков. Указанное значение должно быть положительным.

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

Use Consumer Lag Zookeeper#

Сбор текущей задержки (Zookeeper) ConsumerGroup в топике/разделе.

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

Web Listen Address#

Порт запуска экспортера.

Допустимые значения: от 1 до 65535 включительно.

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

Zookeeper Servers#

Адрес сервера Zookeeper или список адресов серверов Zookeeper.

Адреса задаются в формате host:port, где:

  • host — имя хоста.

    Имя хоста может содержать буквы латинского алфавита, цифры, точки . и дефисы -.

  • port — номер порта.

    Номер порта должен быть в диапазоне от 1 до 65535 включительно.

Значение по умолчанию: [] (пустой список).

Параметры таргета#

Ограничение в один таргет.

Адрес#

Адрес и порт экспортера, которому принадлежит таргет.

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

Имя объекта#

Допустимые типы объектов:

  • Виртуальная машина.
  • Сервер.

Значение по умолчанию: имя объекта.