kafka_exporter

Экспортер для сбора метрик c Apache Kafka.

Компонент Визиона: Агент.

Способ установки: Интерфейс Визион.Сервера через plagent.

Расположение журналов: системный журнал.

Порт по умолчанию: 9308.

Учётная запись ОС для запуска сервиса: vision.

Используемые сторонние учётные записи: Apache Kafka.

Файлы конфигурации:

  • /etc/systemd/system/vision_kafka_exporter.service — юнит systemd;

  • /opt/skala-r/etc/vision-agent/kafka_exporter/kafka_exporter.yml;

  • /opt/skala-r/etc/vision/agent/kafka_exporter/environment.env — параметры запуска, в том числе учётные данные для подключения к Kafka;

  • /opt/skala-r/etc/vision/agent/kafka_exporter/web.yml — веб-конфигурация, в том числе параметры TSL и аутентификации для доступа к компоненту по HTTPS;

  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/kafka_exporter.yml.

Во время установки экспортера с помощью плагинов через интерфейс Визиона в директорию jobs/ компонента vmagent_agent добавляется файл с параметрами скрепинга метрик с данного источника.

Параметры запуска

--audit.filePath

Путь к файлу для сохранения журнала аудита.

Пустое значение отключает аудит.

Значение по умолчанию: /opt/skala-r/var/log/vision/audit/agent/kafka_exporter/audit.log.

--group.exclude

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

--group.filter

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

--kafka.allow-auto-topic-creation

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

--kafka.server

Адрес сервера Kafka в формате host:port.

Для указания нескольких адресов передайте параметр несколько раз.

--kafka.version

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

--no-kafka.allow-auto-topic-creation

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

--no-offset.show-all

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

--no-sasl.disable-PA-FX-FAST

Настройка клиента Kerberos без использования PA_FX_FAST.

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

По умолчанию выключено.

--no-sasl.enabled

Подключение с использованием типа аутентификации PLAIN.

Используется по умолчанию.

--no-sasl.handshake

Отключение рукопожатия SASL.

Используйте, если SASL-прокси не связан с Kafka.

--no-tls.enabled

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

Используется по умолчанию.

--no-tls.insecure-skip-tls-verify

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

--no-use.consumelag.zookeeper

Отключение сбора текущей задержки (ZooKeeper) ConsumerGroup в топике или разделе.

--offset.show-all

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

--refresh.metadata

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

--sasl.disable-PA-FX-FAST

Настройка клиента Kerberos с использованием PA_FX_FAST.

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

По умолчанию включено.

--sasl.enabled

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

--sasl.handshake

Рукопожатие SASL.

--sasl.kerberos-auth-type

Тип аутентификации Kerberos.

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

Возможные значения

  • keytabAuth;

  • 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.

Возможные значения

  • gssapi;

  • plain;

  • scram-sha256;

  • scram-sha512.

--sasl.password

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

Значение хранится в Ansible Vault.
--sasl.realm

Realm Kerberos.

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

--sasl.service-name

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

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

--sasl.username

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

--tls.ca-file

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

--tls.cert-file

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

--tls.enabled

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

--tls.insecure-skip-tls-verify

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

--tls.key-file

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

--tls.server-name

Используется для проверки имени хоста в возвращаемых сертификатах, если не задан пропуск проверки сертификата. Должно быть указано имя сервера Kafka.

--topic.exclude

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

--topic.filter

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

--topic.workers

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

--use.consumelag.zookeeper

Включение сбора текущей задержки (ZooKeeper) ConsumerGroup в топике/разделе.

--web.config.file

Путь к файлу веб-конфигурации компонента.

Значение по умолчанию: /opt/skala-r/etc/vision/agent/kafka_exporter/web.yml.

--web.listen-address

Адрес для прослушивания входящих HTTP-запросов.

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

--zookeeper.server

Адрес сервера ZooKeeper в формате host:port.

Для указания нескольких адресов передайте параметр несколько раз.