Компоненты Визиона: файлы конфигурации, описание параметров

1 Визион.Сервер#

1.1 vision_core#

Компонент Визиона: Сервер Способ установки: Дистрибутив Визиона Расположение журналов: системный журнал, /opt/skala-r/var/log/vision/audit/audit.log, /opt/skala-r/var/log/vision/journal/journal.log Порт по умолчанию: 8088 Описание: Сервер Визиона УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: служебная БД PostgreSQL, Grafana, VictoriaMetrics, VMAlert, AlertCollector, AlertManager, SNMPNotifier, Plagent, VMAgent Proxy, VMAgent Agent, Node Exporter, IPMI Exporter, SNMP Exporter, Utlz Exporter, HaCluster Exporter, Postgres Exporter, SQL Exporter, SUPV Exporter, Nginx Exporter, Vision Exporter. Используемые сторонние УЗ: провайдер OAuth2, SMTP-шлюз, SNMP-шлюз, доступ по IPMI, публичный SNMP, Opennebula, PostgreSQL, СУПВ. Файлы конфигурации:

  • /etc/systemd/system/vision_core.service
  • /opt/skala-r/etc/vision/server/vision_core/config.yml
  • /opt/skala-r/etc/vision/server/vision_core/grafana.yml
  • /opt/skala-r/etc/vision/server/vision_core/log_config.yml
  • /opt/skala-r/vision/.secrets_vault

Файл конфигурации config.yml содержит основные параметры Визиона, в том числе данные для подключения к компонентам Визион.Сервера и описание конфигурации компонентов устанавливаемых на узлы через интерфейс Визиона.

Файл конфигурации grafana.yml, содержит параметры для генерации INI-файла конфигурации Grafana с возможностью использования в качестве значений ссылки на значения из файлов config.yml и .secrets_vault.

Секреты хранятся в зашифрованном Ansible Vault файле .secrets_vault на ключи которого ссылаются значения из config.yml и grafana.yml в формате vault.*.

Подробное описание config.yml: Описание файла конфигурации vision_core (config.yml) .

Файл конфигурации grafana.yml#

Файл в формате YAML используется для создания файла /opt/skala-r/etc/vision/server/grafana/grafana.ini, который позволяет выполнить настройки параметров TLS, аутентификации и прочие параметры.

Файл grafana.yml предоставляет возможность в качестве значений ключей использовать ссылки на значения из других файлов конфигурации Визиона:

  • файл конфигурации vision_core: в формате “config.*”.
  • файл хранилища секретов: в формате “vault.*”.
Ключ paths#
Параметр Описание Секрет
data Путь к директории для хранения временных файлов, сеансы и базы данных.
logs Путь к директории для хранения логов.
plugins Путь к директории плагинов.
provisioning Путь к директории, содержащей файлы конфигурации, которые применяются при запуске и во время работы.
Ключ server#
Параметр Описание Секрет
protocol Протокол (http, https, h2, сокет)
http_addr Адрес для прослушивания входящих http-запросов.
http_port Порт для прослушивания входящих http-запросов.
root_url Полный общедоступный URL-адрес, который вы используете в браузере. При использования обратного прокси и дополнительного пути, необходимо указывать полный URL-адрес.
cert_file Путь к файлу с сертификатом TLS сервера.
cert_key Путь к файлу с ключом TLS сервера.
domain Публичное доменное имя, используемое для доступа к графане из браузера.
Ключ security#
Параметр Описание Секрет
admin_user Пользователь-администратор по умолчанию, создается при запуске.
admin_password Пароль администратора по умолчанию, можно изменить перед первым запуском Grafana или в настройках профиля. +
Ключ dashboards#
Параметр Описание Секрет
default_home_dashboard_path Путь к дашборду по умолчанию.
Ключ log#
Параметр Описание Секрет
mode Режим записи логов. Допустимые значения: “console”, “file”, “syslog”. Разделитель значений: пробел.
level Уровень логирования. Допустимые значения: “debug”, “info”, “warn”, “error”, “critical”.
Ключ metrics#
Параметр Описание Секрет
enabled Включает внутренние метрики Grafana.
basic_auth_username Имя пользователя BasicAuth для получения метрик Grafana.
basic_auth_password Пароль BasicAuth для получения метрик Grafana. +
Ключ auth#
Параметр Описание Секрет
signout_redirect_url URL-адрес для перенаправления пользователя после выхода из системы.
Ключ auth.anonymous#
Параметр Описание Секрет
enabled Включает анонимный доступ.
Ключ auth.generic_oauth#
Параметр Описание Секрет
enabled Включает общую аутентификацию OAuth2.
name Имя, которое относится к общей аутентификации OAuth2 для пользовательского интерфейса Grafana.
allow_sign_up Управляет созданием пользователей Grafana через общий вход OAuth2. Только существующие пользователи Grafana могут войти в систему с помощью общего OAuth, если установлено значение false.
client_id Идентификатор клиента, предоставленный приложением OAuth2.
client_secret Секрет клиента, предоставленный приложением OAuth2. +
scopes Список областей OAuth2, разделенных запятыми или пробелами.
email_attribute_path Выражение JMESPath, используемое для поиска электронной почты пользователя по информации о пользователе.
login_attribute_path Выражение JMESPath, используемое для поиска имени входа пользователя по маркеру идентификатора пользователя.
name_attribute_path Выражение JMESPath, используемое для поиска имени пользователя по маркеру идентификатора пользователя. Это имя будет использоваться в качестве отображаемого имени пользователя.
auth_url Конечная точка авторизации провайдера OAuth2.
token_url Конечная точка, используемая для получения токена доступа OAuth2.
api_url Конечная точка, используемая для получения информации о пользователе, совместимой с OpenID UserInfo.
role_attribute_path Выражение JMESPath, используемое для поиска ролей Grafana. Grafana сначала оценит выражение, используя токен идентификатора OAuth2. Если роль не найдена, выражение будет оцениваться с использованием информации о пользователе, полученной из конечной точки UserInfo. Результатом оценки должна быть действующая роль Grafana (None, Viewer, Editor, Admin or GrafanaAdmin).
role_attribute_strict Установите значение true, чтобы запретить вход пользователя в систему, если роль организации Grafana не может быть извлечена с помощью role_attribute_path or org_mapping.
allow_assign_grafana_admin Установите значение true, чтобы включить автоматическую синхронизацию роли администратора сервера Grafana. Если для этого параметра установлено значение true и результатом оценки role_attribute_path для пользователя является GrafanaAdmin, Grafana предоставляет пользователю права администратора сервера и роль администратора организации. Если для этого параметра установлено значение false и результатом оценки role_attribute_path для пользователя является GrafanaAdmin, Grafana предоставляет пользователю только роль администратора организации.

1.2 vision_taskdaemon#

Компонент Визиона: Сервер Способ установки: Дистрибутив Визиона Расположение журналов: системный журнал Порт по умолчанию: Неприменимо Описание: Сервис выполнения задач из служебной БД УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: служебная БД PostgreSQL Используемые сторонние УЗ: - Файлы конфигурации:

  • /etc/systemd/system/vision_taskdaemon.service
  • /opt/skala-r/etc/vision/server/vision_core/config.yml

TaskDaemon используется для выполнения задач по обращению к plagent. Не имеет API и соответствующих ему настроек. Использует общий файл конфигурации vision_core config.yml.

1.3 postgresql#

Компонент Визиона: Сервер Способ установки: Дистрибутив Визиона Расположение журналов: системный журнал и стандартное расположение логов PostgreSQL /var/lib/pgsql/data/log/ Порт по умолчанию: 5432 Описание: Служебная БД УЗ ОС запуска сервиса: postgres Используемые сторонние УЗ: - Файлы конфигурации: Местоположение по умолчанию пакета ОС

  • ALT Linux, РЕД ОС:
    • /var/lib/pgsql/data/postgresql.conf
    • /var/lib/pgsql/data/pg_hba.conf
  • Astra Linux:
    • /etc/postgresql/11/main/postgresql.conf
    • /etc/postgresql/11/main/pg_hba.conf

Изменение пароля пользователя vision служебной базы данных Визиона#

Подключитесь к PostgreSQL с помощью psql в консоли на Визион.Сервере:

psql -U postgres

Затем выполните эту команду в вашем терминале SQL:

ALTER USER vision WITH PASSWORD '<новый-пароль>';

Откройте файл хранилища секретов /opt/skala-r/vision/.secrets_vault с помощью команды ansible-vault edit:

ansible-vault edit /opt/skala-r/vision/.secrets_vault

Измените пароль подключения к служебной базе данных Визиона и сохраните изменения:

vault.database.password: '<новый-пароль>'

Перезапустите systemd сервисы:

  • vision_core.service
  • vision_alertcollector.service
  • vision_taskdaemon.service
systemctl restart vision_core.service vision_alertcollector.service vision_taskdaemon.service

1.4 Nginx#

Компонент Визиона: Сервер Способ установки: Дистрибутив Визиона Расположение журналов: системный журнал и стандартное расположение логов nginx /var/log/nginx/ Порт по умолчанию: 80, 443, 8092 Описание: Веб-сервер УЗ ОС запуска сервиса: root (главный процесс), nginx (рабочие процессы сервиса) Используемые сторонние УЗ: - Файлы конфигурации:

  • /usr/share/nginx/html/vision - статические файлы
  • /etc/nginx
    • /ssl - директория с сертификатами
    • /nginx.conf
    • /snippets/vision-ssl-params.conf
    • /sites-available.d
      • /default.conf
      • /vision.conf

Замена сертификата Nginx#

  1. Добавьте сертификат в директорию /etc/nginx/ssl
  2. Откройте файл /snippets/vision-ssl-params.conf и укажите пути до нового сертификата и ключа в ssl_certificate и ssl_certificate_key, соответственно

ssl_certificate /etc/nginx/ssl/vision.crt; ssl_certificate_key /etc/nginx/ssl/vision.key;

  1. Перезапустите nginx

systemctl restart nginx.service

1.5 grafana#

Компонент Визиона: Сервер Способ установки: Дистрибутив Визиона Расположение журналов: системный журнал и /opt/skala-r/var/log/vision/server/grafana/grafana.log Порт по умолчанию: 3000 Описание: Средство визуализации УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: VictoriaMetrics BasicAuth Используемые сторонние УЗ: провайдер OAuth2 Файлы конфигурации:

  • /etc/systemd/system/grafana.service
  • /opt/skala-r/etc/vision/server/grafana/environment.env
  • /opt/skala-r/etc/vision/server/grafana/grafana.ini
  • /opt/skala-r/etc/vision/server/grafana/provisioning/datasources/datasources.yml
  • /opt/skala-r/etc/vision/server/grafana/provisioning/dashboards/dashboards.yml

Файл grafana.ini. создаётся через vision_core на основе файла /opt/skala-r/etc/vision/server/vision_core/grafana.yml, где происходит настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS.

Параметры доступа к источнику данных указываются в datasources.yml, файл генерируется через vision_core с параметрами из /opt/skala-r/etc/vision/server/vision_core/config.yml.

Для подключения OAuth2 (Кейклоак, Аванпост & etc) используйте инструкцию из руководства администратора.

Используемые параметры источника данных#

Пример файла datasources.yml, созданного через vision_core. Для изменения параметров источника данных Grafana используйте /opt/skala-r/etc/vision/server/vision_core/config.yml.

apiVersion: 1
datasources:
  - name: Vision TSDB
    type: prometheus
    access: proxy
    uid: n_XcXSk4k
    url: https://127.0.0.1:8428/vision/victoriametrics

    basicAuth: true
    basicAuthUser: vision

    jsonData:
       tlsAuthWithCACert: true
    secureJsonData:
      basicAuthPassword: <зашифрованное-значение>
      tlsCACert: [...]
      tlsClientCert: [...]
      tlsClientKey: [...]
  • apiVersion - Версия файла конфигурации
  • datasources - Список источников данных
    • name - Имя источника данных
    • type - Тип источника данных
    • access - Устанавливает режим доступа: прокси-сервер или прямой
    • uid - UID источника данных. Не рекомендуется изменять, используется в дашбордах.
    • url - Устанавливает URL-адрес источника данных, включая порт
    • basicAuth - Включает базовую авторизацию для доступа к источнику данных.
    • basicAuthUser - Имя пользователя BasicAuth.
    • jsonData - Поля для преобразования в JSON и сохранения в jsonData.
      • tlsAuthWithCACert - Включает аутентификацию TLS с использованием сертификата CA.
    • secureJsonData
      • basicAuthPassword - Пароль BasicAuth.
      • tlsCACert - Сертификат CA.
      • tlsClientCert - Сертификат клиента.
      • tlsClientKey - Ключ клиента.

Используемые ключи запуска#

Имя ключа Описание
config Путь к файлу конфигурации.
homepath Путь к рабочему каталогу.

1.6 victoriametrics_st#

Компонент Визиона: Сервер Способ установки: Дистрибутив Визиона Расположение журналов: системный журнал Порт по умолчанию: 8428 Описание: БД временных рядов УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: alertmanager, snmp_notifier, grafana, vmalert Используемые сторонние УЗ: - Файлы конфигурации:

  • /etc/systemd/system/victoriametrics_st.service
  • /opt/skala-r/etc/vision/server/victoriametrics_st/environment.env
  • /opt/skala-r/etc/vision/server/victoriametrics_st/victoriametrics_st.yml

Компонент отвечает за хранение метрик и агрегацию временных рядов.

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится ключами запуска в файле environment.env.

Параметры скрепинга метрик с внутренних компонентов мониторинга устанавливаются с помощью файла victoriametrics_st.yml.

Используемые ключи запуска#

Имя ключа Описание
storageDataPath Путь к данным хранилища
retentionPeriod Период хранения данных. Данные с отметками времени за пределами периода хранения автоматически удаляются.
promscrape.config Путь к файлу конфигурации Prometheus с разделом «scrape_configs», содержащим цели для очистки.
promscrape.maxScrapeSize Максимальный размер ответа на запрос в байтах для обработки от целей Prometheus. Ответы больших размеров отклоняются.
httpListenAddr Адрес для прослушивания входящих http-запросов.
http.pathPrefix Необязательный префикс для добавления ко всем путям, обрабатываемым http-сервером.
httpAuth.username Имя пользователя для BasicAuth HTTP-сервера.
httpAuth.password Пароль для BasicAuth HTTP-сервера.
tls Включить ли TLS для входящих HTTP-запросов по заданному -httpListenAddr
tlsCertFile Путь к файлу с сертификатом TLS для соответствующего -httpListenAddr
tlsKeyFile Путь к файлу с ключом TLS для соответствующего -httpListenAddr
tlsMinVersion Минимальная версия TLS для использования для соответствующего -httpListenAddr.
Все доступные ключи запуска компонента

1.7 victorialogs#

Компонент Визиона: Сервер Способ установки: Дистрибутив Визиона Расположение журналов: системный журнал Порт по умолчанию: 9428 Описание: БД логов УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: - Используемые сторонние УЗ: - Файлы конфигурации:

  • /etc/systemd/system/victorialogs.service
  • /opt/skala-r/etc/vision/server/victorialogs/environment.env

Компонент отвечает за хранение логов и агрегацию логов.

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится ключами запуска в файле environment.env.

Используемые ключи запуска#

Имя ключа Описание
storageDataPath Путь к данным хранилища
storage.minFreeDiskSpaceBytes Минимальный объём свободного места на диске по адресу -storageDataPath, после которого хранилище перестаёт принимать новые данные
retention.maxDiskSpaceUsageBytes Максимальное использование дискового пространства по адресу -storageDataPath до автоматического удаления старых разделов по дням
httpListenAddr Адрес для прослушивания входящих http-запросов.
http.pathPrefix Необязательный префикс для добавления ко всем путям, обрабатываемым http-сервером.
httpAuth.username Имя пользователя для BasicAuth HTTP-сервера.
httpAuth.password Пароль для BasicAuth HTTP-сервера.
tls Включить ли TLS для входящих HTTP-запросов по заданному -httpListenAddr
tlsCertFile Путь к файлу с сертификатом TLS для соответствующего -httpListenAddr
tlsKeyFile Путь к файлу с ключом TLS для соответствующего -httpListenAddr
tlsMinVersion Минимальная версия TLS для использования для соответствующего -httpListenAddr.

1.8 vmalert_st#

Компонент Визиона: Сервер Способ установки: Дистрибутив Визиона Расположение журналов: системный журнал Порт по умолчанию: 8880 Описание: Сервис проверки срабатывания правил оповещений (триггеров) УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: VictoriaMetrics BasicAuth, Alertmanager BasicAuth, Vision AlertCollector BasicAuth Используемые сторонние УЗ: - Файлы конфигурации:

  • /etc/systemd/system/vmalert_st.service
  • /opt/skala-r/etc/vision/server/vmalert_st/environment.env
  • /opt/skala-r/etc/vision/server/vmalert_st/rules/*

Компонент отвечает за оценку правил оповещения и правил записи метрик.

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится ключами запуска в файле environment.env.

Правила оповещения и правила записи управляются из интерфейса Визиона через компонент vision_core и записываются в директорию rules.

Используемые ключи запуска#

Имя ключа Описание
rule Путь к файлам с правилами оповещения и/или записи.
evaluationInterval Как часто оценивать правила.
httpListenAddr Адрес для прослушивания входящих http-запросов.
http.pathPrefix Необязательный префикс для добавления ко всем путям, обрабатываемым http-сервером.
httpAuth.username Имя пользователя для BasicAuth HTTP-сервера.
httpAuth.password Пароль для BasicAuth HTTP-сервера.
tls Включить ли TLS для входящих HTTP-запросов по заданному -httpListenAddr
tlsCertFile Путь к файлу с сертификатом TLS для соответствующего -httpListenAddr
tlsKeyFile Путь к файлу с ключом TLS для соответствующего -httpListenAddr
tlsMinVersion Минимальная версия TLS для использования для соответствующего -httpListenAddr.
datasource.url Источник данных, совместимый с HTTP API Prometheus. Это может быть URL-адрес VictoriaMetrics с одним узлом или vmselect. Обязательный параметр.
datasource.basicAuth.username Имя пользователя basicAuth к -datasource.url
datasource.basicAuth.password Пароль basicAuth к -datasource.url
datasource.tlsCAFile Путь к файлу TLS CA, который будет использоваться для проверки подключений к -datasource.url
datasource.tlsCertFile Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к -datasource.url
datasource.tlsKeyFile Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к -datasource.url
datasource.tlsInsecureSkipVerify Пропускать ли проверку tls при подключении к -datasource.url
notifier.url URL-адрес Prometheus Alertmanager
notifier.basicAuth.username Имя пользователя basicAuth к -notifier.url
notifier.basicAuth.password Пароль basicAuth к -notifier.url
notifier.tlsCAFile Путь к файлу TLS CA, который будет использоваться для проверки подключений к -notifier.url
notifier.tlsCertFile Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к -notifier.url
notifier.tlsKeyFile Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к -notifier.url
notifier.tlsInsecureSkipVerify Пропускать ли проверку tls при подключении к -notifier.url
remoteWrite.url URL-адрес VictoriaMetrics или vminsert, где сохраняется состояние оповещений и результаты правил записи.
remoteWrite.basicAuth.username Имя пользователя basicAuth к -remoteWrite.url
remoteWrite.basicAuth.password Пароль basicAuth к -remoteWrite.url
remoteWrite.tlsCAFile Путь к файлу TLS CA, который будет использоваться для проверки подключений к -remoteWrite.url
remoteWrite.tlsCertFile Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к -remoteWrite.url
remoteWrite.tlsKeyFile Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к -remoteWrite.url
remoteWrite.tlsInsecureSkipVerify Пропускать ли проверку tls при подключении к -remoteWrite.url
remoteRead.url URL-адрес источника данных, совместимого с HTTP API Prometheus.
remoteRead.basicAuth.username Имя пользователя basicAuth к -remoteRead.url
remoteRead.basicAuth.password Пароль basicAuth к -remoteRead.url
remoteRead.tlsCAFile Путь к файлу TLS CA, который будет использоваться для проверки подключений к -remoteRead.url
remoteRead.tlsCertFile Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к -remoteRead.url
remoteRead.tlsKeyFile Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к -remoteRead.url
remoteRead.tlsInsecureSkipVerify Пропускать ли проверку tls при подключении к -remoteRead.url
Все доступные ключ запуска компонента

1.9 vision_alertcollector#

Компонент Визиона: Сервер Способ установки: Дистрибутив Визиона Расположение журналов: системный журнал и /opt/skala-r/var/log/vision/server/vision_alertcollector/vision_alertcollector.log Порт по умолчанию: 10111 Описание: Сервис сбора оповещений в служебную БД УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: служебная БД PostgreSQL Используемые сторонние УЗ: - Файлы конфигурации:

  • /etc/systemd/system/vision_alertcollector.service
  • /opt/skala-r/etc/vision/server/vision_alertcollector/environment.env
  • /opt/skala-r/etc/vision/server/vision_alertcollector/web.yml

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

Используемые ключи запуска#

Имя ключа Описание
web.config.file Путь к файлу веб-конфигурации, который позволяет включить TLS и/или аутентификацию.
web.firing-path Путь для приема алертов (совпадает с таким путем у alertmanager) (default “/api/v2/alerts”)
web.listen-address Адреса, по которым доступен компонент.
core.config Путь к конфигурационному файлу vision_core (default “/opt/skala-r/etc/vision/server/vision_core/config.yml”)
core.python Путь к интерпретару python для запуска vision_core (default “/opt/skala-r/vision/server/vision_venv/bin/python3”)
core.vault Путь к ansible vault (default “/opt/skala-r/vision/.vault_store”)
logging.output Тип логирования. Допустимые значения: file, stdout, stderr (default “file”).
logging.filePath Путь к файлу записи логов.

1.10 alertmanager#

Компонент Визиона: Сервер Способ установки: Дистрибутив Визиона Расположение журналов: системный журнал Порт по умолчанию: 9093 Описание: Средство отправки сообщений о сработавших правилах оповещения УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: SNMP-notifier BasicAuth Используемые сторонние УЗ: SMTP-шлюз Файлы конфигурации:

  • /etc/systemd/system/alertmanager.service
  • /opt/skala-r/etc/vision/server/alertmanager/environment.env
  • /opt/skala-r/etc/vision/server/alertmanager/alertmanager.yml
  • /opt/skala-r/etc/vision/server/alertmanager/web.yml

Компонент отвечает за отправку сообщений о сработавших правилах оповещения.

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

Правила и учётные записи для отправки сообщений по SMTP и Webhooks управляются из интерфейса Визиона через компонент vision_core в файле alertmanager.yml.

Используемые ключи запуска#

Имя ключа Описание
config.file Файл конфигурации доставки сообщений.
storage.path Базовый путь для данных.
web.listen-address Адреса, по которым доступен компонент.
web.route-prefix Префикс для внутренних маршрутов веб-конечных точек.
web.config.file Путь к файлу веб-конфигурации, который позволяет включить TLS и/или аутентификацию.
cluster.listen-address Адрес прослушивания для кластерного режима. Пустое значение, чтобы отключить режим HA.
log.level Уровень логирования

1.11 snmp_notifier#

Компонент Визиона: Сервер Способ установки: Дистрибутив Визиона Расположение журналов: системный журнал Порт по умолчанию: 9464 Описание: Средство отправки сообщений о сработавших правилах оповещения по протоколу SNMP УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: - Используемые сторонние УЗ: SNMP-шлюз Файлы конфигурации:

  • /etc/systemd/system/snmp_notifier.service
  • /opt/skala-r/etc/vision/server/snmp_notifier/environment.env
  • /opt/skala-r/etc/vision/server/snmp_notifier/description-template.tpl
  • /opt/skala-r/etc/vision/server/snmp_notifier/web.yml

Компонент отвечает за отправку SNMP-трапов.

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

Формат отправляемых сообщений регулируется файлов шаблона сообщений SNMP в формате Go template description-template.tpl.

Параметры отправки SNMP-трапов управляются с помощью API Визиона (интерфейса в будущем) через компонент vision_core путём изменения ключей запуска компонента в файле environment.env.

Используемые ключи запуска#

При генерации файла snmp_notifier/environment.env vision_core использует параметры из файла конфигурации /opt/skala-r/etc/vision/server/vision_core/config.yml из ключа snmp_notifier_config и преобразует в следующие ключи запуска компонента.

Имя ключа Описание Значение можно изменить через API Визиона (в будущем UI)
web.listen-address Адреса, по которым доступен компонент Нет
web.config.file Путь к файлу веб-конфигурации, который позволяет включить TLS и/или аутентификацию. Нет
snmp.trap-description-template Шаблон сообщения SNMP в формате Go template Нет
snmp.version Версия SNMP. Допустимые значения: “V2c”, “V3”. Да
snmp.destination Адресат сообщений. В формате “127.0.0.1:162”. Да
snmp.retries Количество повторных посылок сообщения SNMP. По умолчанию 1. Да
snmp.trap-oid-label Метка, содержащая OID ловушки. Нет
snmp.trap-default-oid OID ловушки, если он не найден в метках сработавшего правила. По умолчанию “1.3.6.1.4.1.98789”. Да
snmp.timeout Длительность таймаута в секундах. По умолчанию 5. Да
snmp.community Комьюнити SNMP (только V2c). По умолчанию “public”. Да
snmp.authentication-enabled Включить аутентификацию SNMP (только V3). Да
snmp.authentication-protocol Протокол шифрования пароля (только V3). Допустимые значения: “MD5”, “SHA” Да
snmp.authentication-username Имя пользователя аутентификации SNMP (только V3). Да
snmp.authentication-password Пароль аутентификации SNMP (только V3). Да
snmp.private-enabled Включить шифрование SNMP (только V3). Да
snmp.private-protocol Протокол передачи данных SNMP (только V3). Допустимые значения: “DES”, “AES” Да
snmp.private-password Пароль шифрования SNMP (только V3). Да
snmp.security-engine-id ID механизма безопасности SNMP (только V3). Да
snmp.context-engine-id ID механизма контекста (только V3). Да
snmp.context-name Имя контекста (только V3). Да

1.12 vision_backup#

Компонент Визиона: Сервер Способ установки: Дистрибутив Визиона Расположение журналов: системный журнал и /opt/skala-r/var/log/vision/server/vision_backup/vision_backup.log Порт по умолчанию: 17050 Описание: Сервис резервного копирования конфигурации Визиона УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: служебная БД PostgreSQL Используемые сторонние УЗ: - Файлы конфигурации:

  • /etc/systemd/system/vision_backup.service
  • /opt/skala-r/etc/vision/server/vision_backup/environment.env
  • /opt/skala-r/etc/vision/server/vision_backup/web.yml
  • /opt/skala-r/etc/vision/server/vision_backup/config.yml

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

Файлы конфигурации компонента перегенерируются компонентом vision_core при изменении параметров расписания резервного копирования в интерфейсе.

Используемые ключи запуска#

Имя ключа Описание
common.config-path Путь до файла конфигурации компонента.
common.instance Уникальный идентификатор установки для сверки принадлежности резервной копии конкретной установке.
web.config.file Путь к файлу конфигурации web.yml, который позволяет включить TLS и/или аутентификацию.
web.listen-address Адреса, по которым доступен компонент.
logging.output Тип логирования. Допустимые значения: file, stdout, stderr (default “file”).
logging.filePath Путь к файлу записи логов.
audit.filePath Путь файла аудита (пустой - отключение аудита).

2 Визион.Прокси#

2.1 vision_vmagent_proxy#

Компонент Визиона: Прокси Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал и /opt/skala-r/var/log/vision/proxy/vmagent_proxy/vmagent.log Порт по умолчанию: 8430 Описание: Сервис приёма метрик ПАКа и отправки их в базу данных временных рядов УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: VictoriaMetrics BasicAuth Используемые сторонние УЗ: - Файлы конфигурации:

  • /etc/systemd/system/vision_vmagent_proxy.service
  • /opt/skala-r/etc/vision/proxy/vmagent_proxy/environment.env
  • /opt/skala-r/etc/vision/proxy/vmagent_proxy/vmagent.yml

Компонент устанавливается на узел из интерфейса Визиона компонентом vision_core с параметрами указанными в конфигурационном файле vision_core/config.yml.

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится ключами запуска в файле environment.env.

Параметры скрепинга метрик этого компонента устанавливаются с помощью файла vmagent.yml.

В ключах запуска компонента в файле environment.env указывается адрес назначения метрик с указанием BasicAuth и сертификатов VictoriaMetrics.

Используемые ключи запуска#

Имя ключа Описание
promscrape.config Путь к файлу конфигурации Prometheus с разделом «scrape_configs», содержащим цели для очистки.
promscrape.configCheckInterval
promscrape.maxScrapeSize Максимальный размер ответа на запрос в байтах для обработки от целей Prometheus. Ответы больших размеров отклоняются.
remoteWrite.showURL
httpListenAddr Адрес для прослушивания входящих http-запросов.
http.pathPrefix Необязательный префикс для добавления ко всем путям, обрабатываемым http-сервером.
httpAuth.username Имя пользователя для BasicAuth HTTP-сервера.
httpAuth.password Пароль для BasicAuth HTTP-сервера.
tls Включить ли TLS для входящих HTTP-запросов по заданному -httpListenAddr
tlsCertFile Путь к файлу с сертификатом TLS для соответствующего -httpListenAddr
tlsKeyFile Путь к файлу с ключом TLS для соответствующего -httpListenAddr
tlsMinVersion Минимальная версия TLS для использования для соответствующего -httpListenAddr.
remoteWrite.url URL-адрес VictoriaMetrics или vminsert, где сохраняется состояние оповещений и результаты правил записи.
remoteWrite.basicAuth.username Имя пользователя basicAuth к -remoteWrite.url
remoteWrite.basicAuth.password Пароль basicAuth к -remoteWrite.url
remoteWrite.tlsCAFile Путь к файлу TLS CA, который будет использоваться для проверки подключений к -remoteWrite.url
remoteWrite.tlsCertFile Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к -remoteWrite.url
remoteWrite.tlsKeyFile Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к -remoteWrite.url
remoteWrite.tlsInsecureSkipVerify Пропускать ли проверку tls при подключении к -remoteWrite.url
remoteWrite.maxDiskUsagePerURL
loggerOutput Тип логирования. Допустимые значения: file, stdout, stderr (default “file”).
loggerFileName Путь к файлу записи логов.

Все доступные ключи запуска компонента

2.2 vision_vlagent_proxy#

Компонент Визиона: Прокси Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал и /opt/skala-r/var/log/vision/proxy/vlagent_proxy/vlagent.log Порт по умолчанию: 29511 Описание: Сервис приёма логов ПАКа и отправки их в базу данных логов УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: VictoriaLogs BasicAuth Используемые сторонние УЗ: - Файлы конфигурации:

  • /etc/systemd/system/vision_vlagent_proxy.service
  • /opt/skala-r/etc/vision/proxy/vlagent_proxy/environment.env

Компонент устанавливается на узел из интерфейса Визиона компонентом vision_core с параметрами указанными в конфигурационном файле vision_core/config.yml.

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится ключами запуска в файле environment.env.

В ключах запуска компонента в файле environment.env указывается адрес назначения логов с указанием BasicAuth и сертификатов VictoriaLogs.

Используемые ключи запуска#

Имя ключа Описание
remoteWrite.showURL Нужно ли указывать -remoteWrite.url в экспортируемых метриках
httpListenAddr Адрес для прослушивания входящих http-запросов.
http.pathPrefix Необязательный префикс для добавления ко всем путям, обрабатываемым http-сервером.
httpAuth.username Имя пользователя для BasicAuth HTTP-сервера.
httpAuth.password Пароль для BasicAuth HTTP-сервера.
tls Включить ли TLS для входящих HTTP-запросов по заданному -httpListenAddr
tlsCertFile Путь к файлу с сертификатом TLS для соответствующего -httpListenAddr
tlsKeyFile Путь к файлу с ключом TLS для соответствующего -httpListenAddr
tlsMinVersion Минимальная версия TLS для использования для соответствующего -httpListenAddr.
remoteWrite.url URL-адрес VictoriaMetrics или vminsert, где сохраняется состояние оповещений и результаты правил записи.
remoteWrite.basicAuth.username Имя пользователя basicAuth к -remoteWrite.url
remoteWrite.basicAuth.password Пароль basicAuth к -remoteWrite.url
remoteWrite.tlsCAFile Путь к файлу TLS CA, который будет использоваться для проверки подключений к -remoteWrite.url
remoteWrite.tlsCertFile Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к -remoteWrite.url
remoteWrite.tlsKeyFile Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к -remoteWrite.url
remoteWrite.tlsInsecureSkipVerify Пропускать ли проверку tls при подключении к -remoteWrite.url
loggerOutput Тип логирования. Допустимые значения: file, stdout, stderr (default “file”).
loggerFileName Путь к файлу записи логов.

3 Визион.Агент#

Все параметры плагинов, доступные для настройки через UI, описаны в разделе Плагины

3.1 vision_logwatcher#

Компонент Визиона: Агент Платформы Способ установки: Плейбук из дистрибутива Визиона. Расположение журналов: системный журнал, файл Порт по умолчанию: 17078 (HTTPS) Описание: Компонент распаковки сжатых логов. УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: - Используемые сторонние УЗ: - Файлы конфигурации:

  • /etc/systemd/system/vision_logwatcher.service
  • /opt/skala-r/etc/vision/agent/vision_logwatcher/environment.env
  • /opt/skala-r/etc/vision/agent/vision_logwatcher/config.yml
  • /opt/skala-r/etc/vision/agent/vision_logwatcher/web.yml
  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/vision_logwatcher.yml

Устанавливается на все узлы плейбуком Ansible из дистрибутива Визиона rsyslog_config/deploy.yml, на которых будет необходимо отслеживать zst-логи для распаковки и дальнейшей отправки с помощью rsyslog в VictoriaLogs. Для выполнения плейбука будет необходим доступ к узлам по SSH.

HTTPS сервер поднимается для отдачи метрик и контролирования компонента.

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

Используемые ключи запуска#

Имя ключа Описание
config.file Путь до файла конфигурации.
web.listen-address Адрес для прослушивания входящих http-запросов.
web.config.file Путь к файлу веб-конфигурации, который позволяет включить TLS и/или аутентификацию.
logging.level Уровень логирования (default “INFO”)
logging.output Тип логирования. Допустимые значения: file, stdout, stderr (default “file”).
logging.filePath Путь к файлу записи логов.
audit.filePath Путь лога аудита.

3.2 plagent#

Компонент Визиона: Агент Платформы Способ установки: Плейбук из дистрибутива Визиона. Расположение журналов: системный журнал Порт по умолчанию: 7550 (HTTPS), 7551 (gRPC) Описание: Агент управления конфигурацией мониторинга УЗ ОС запуска сервиса: plagent Используемые УЗ компонентов Визиона: - Используемые сторонние УЗ: - Файлы конфигурации:

  • /etc/systemd/system/plagent.service
  • /opt/skala-r/plagent/environment.env
  • /opt/skala-r/plagent/whitelists/vision

Устанавливается на все узлы плейбуком Ansible из дистрибутива Визиона plagent/install.yml, на которых будет необходимо настраивать сбор метрик через интерфейс Визиона. Для выполнения плейбука будет необходим доступ к узлам по SSH.

Ограничение доступа к компоненту осуществляется с помощью механизма токенов в ключах запуска в файле environment.env.

Предусмотрен механизм белых списков с перечнем разрешенных операций при запросах (файл whitelists/vision).

Используемые ключи запуска#

Имя ключа Описание
http.port Порт для прослушивания входящих http-запросов.
grpc.port Порт для прослушивания входящих grpc-запросов.
plugins.folder Путь к директории с плагинами.
uploads.folder Путь к директории хранения загруженных файлов.
whitelists.folder Путь к директории с файлами конфигурации белых списков.
ca.certfile PEM-файл сертификата CA.
ca.keyfile PEM-файл ключа CA.
server.certfile PEM-файл сертификата сервера.
server.keyfile PEM-файл ключа сервера.
tokens Действительные токены на предъявителя.
use_sudo Использование sudo для запуска плагинов.

Запуск из-под непривилегированного пользователя подразумевает выполнение плагинов через sudo. По умолчанию sudo не используется, необходимо указание флага -use_sudo.

В sudoers должны быть прописаны пути для запуска плагинов без запроса пароля для пользователя, под которым запущен plagent.

Cmnd_Alias FILES = /opt/skala-r/plagent/plugins/files *
Cmnd_Alias SERVICES = /opt/skala-r/plagent/plugins/services *
Cmnd_Alias IP = /opt/skala-r/plagent/plugins/ip *

plagent ALL=(root) NOPASSWD: FILES,SERVICES,IP

3.3 vision_vmagent_agent#

Компонент Визиона: Агент Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал и /opt/skala-r/var/log/vision/agent/vmagent_agent/vmagent.log Порт по умолчанию: 8429 Описание: Сервис сбора метрик и отправки их в Прокси УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: vmagent_proxy BasicAuth Используемые сторонние УЗ: Экспортеры и скреперы BasicAuth Файлы конфигурации:

  • /etc/systemd/system/vision_vmagent_agent.service
  • /opt/skala-r/etc/vision/agent/vmagent_agent/environment.env
  • /opt/skala-r/etc/vision/agent/vmagent_agent/vmagent.yml
  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/*

Компонент устанавливается на узел из интерфейса Визиона компонентом vision_core с параметрами указанными в конфигурационном файле vision_core/config.yml.

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится ключами запуска в файле environment.env.

Параметры скрепинга метрик устанавливаются с помощью файла vmagent.yml. Директория jobs используется для постановки новых задач скрепинга путём добавления в неё новых файлов (1 плагин устанавливает 1 файл).

В ключах запуска компонента в файле environment.env указывается адрес назначения метрик с указанием BasicAuth и сертификатов vmagent_proxy.

Используемые ключи запуска аналогичны vmagent_proxy.

3.4 vision_vlagent_agent#

Компонент Визиона: Агент Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал и /opt/skala-r/var/log/vision/agent/vlagent_agent/vlagent.log Порт по умолчанию: 29510 Описание: Сервис приёма логов ПАКа и отправки их в Прокси УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: VictoriaLogs BasicAuth Используемые сторонние УЗ: - Файлы конфигурации:

  • /etc/systemd/system/vision_vlagent_agent.service
  • /opt/skala-r/etc/vision/agent/vlagent_agent/environment.env

Компонент устанавливается на узел из интерфейса Визиона компонентом vision_core с параметрами указанными в конфигурационном файле vision_core/config.yml.

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится ключами запуска в файле environment.env.

В ключах запуска компонента в файле environment.env указывается адрес назначения логов с указанием BasicAuth и сертификатов vlagent_proxy.

Используемые ключи запуска#

Имя ключа Описание
remoteWrite.showURL Нужно ли указывать -remoteWrite.url в экспортируемых метриках
httpListenAddr Адрес для прослушивания входящих http-запросов.
http.pathPrefix Необязательный префикс для добавления ко всем путям, обрабатываемым http-сервером.
httpAuth.username Имя пользователя для BasicAuth HTTP-сервера.
httpAuth.password Пароль для BasicAuth HTTP-сервера.
tls Включить ли TLS для входящих HTTP-запросов по заданному -httpListenAddr
tlsCertFile Путь к файлу с сертификатом TLS для соответствующего -httpListenAddr
tlsKeyFile Путь к файлу с ключом TLS для соответствующего -httpListenAddr
tlsMinVersion Минимальная версия TLS для использования для соответствующего -httpListenAddr.
remoteWrite.url URL-адрес VictoriaMetrics или vminsert, где сохраняется состояние оповещений и результаты правил записи.
remoteWrite.basicAuth.username Имя пользователя basicAuth к -remoteWrite.url
remoteWrite.basicAuth.password Пароль basicAuth к -remoteWrite.url
remoteWrite.tlsCAFile Путь к файлу TLS CA, который будет использоваться для проверки подключений к -remoteWrite.url
remoteWrite.tlsCertFile Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к -remoteWrite.url
remoteWrite.tlsKeyFile Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к -remoteWrite.url
remoteWrite.tlsInsecureSkipVerify Пропускать ли проверку tls при подключении к -remoteWrite.url
loggerOutput Тип логирования. Допустимые значения: file, stdout, stderr (default “file”).
loggerFileName Путь к файлу записи логов.
syslog.listenAddr.tcp Список TCP-адресов, разделенных запятыми, для прослушивания сообщений системного журнала.
syslog.tls Следует ли включать TLS для получения сообщений системного журнала по соответствующему адресу -syslog.listenAddr.tcp.
syslog.tlsCAFile Необязательный путь к корневому файлу TLS CA, который используется для проверки TLS при подключении к агенту. При указании CA сертификата влючается mtls.
syslog.tlsCertFile Путь к файлу с сертификатом TLS для соответствующего -syslog.listenAddr.tcp, если задан соответствующий -syslog.tls.
syslog.tlsKeyFile Путь к файлу с ключом TLS для соответствующего -syslog.listenAddr.tcp, если задан соответствующий -syslog.tls.
syslog.tlsMinVersion Минимальная версия TLS, используемая для -syslog.listenAddr.tcp, если задан -syslog.tls.

3.5 vision_node_exporter#

Компонент Визиона: Агент Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал и /opt/skala-r/var/log/vision/agent/node_exporter/node_exporter.log Порт по умолчанию: 9101 Описание: Экспортер для сбора метрик узла УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: - Используемые сторонние УЗ: - Файлы конфигурации:

  • /etc/systemd/system/vision_node_exporter.service
  • /opt/skala-r/etc/vision/agent/node_exporter/web.yml
  • /opt/skala-r/etc/vision/agent/node_exporter/environment.env
  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/node_exporter.yml

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

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

Используемые ключи запуска#

Имя ключа Описание
web.listen-address Адрес для прослушивания входящих http-запросов.
web.config.file Путь к файлу веб-конфигурации, который позволяет включить TLS и/или аутентификацию.
logging.output Тип логирования. Допустимые значения: file, stdout, stderr (default “file”).
logging.filePath Путь к файлу записи логов.

3.6 vision_ipmi_exporter#

Компонент Визиона: Агент Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал Порт по умолчанию: 9290 Описание: Экспортер для BMC УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: - Используемые сторонние УЗ: доступ по IPMI к BMC узлов Файлы конфигурации:

  • /etc/systemd/system/vision_ipmi_exporter.service
  • /opt/skala-r/etc/vision/agent/ipmi_exporter/web.yml
  • /opt/skala-r/etc/vision/agent/ipmi_exporter/ipmi_exporter.yml
  • /opt/skala-r/etc/vision/agent/ipmi_exporter/environment.env
  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/ipmi_exporter.yml

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

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

Учетные данные для подключения по IPMI, используемые коллекторы и прочие параметры указываются в файле конфигурации ipmi_exporter.yml.

Используемые ключи запуска#

Имя ключа Описание
config.file Путь к файлу конфигурации экспортера.
web.listen-address Адрес для прослушивания входящих http-запросов.
web.config.file Путь к файлу веб-конфигурации, который позволяет включить TLS и/или аутентификацию.

3.7 vision_snmp_exporter#

Компонент Визиона: Агент Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал Порт по умолчанию: 9116 Описание: Экспортер для коммутаторов УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: - Используемые сторонние УЗ: публичный доступ по SNMP Файлы конфигурации:

  • /etc/systemd/system/vision_snmp_exporter.service
  • /opt/skala-r/etc/vision/agent/snmp_exporter/web.yml
  • /opt/skala-r/etc/vision/agent/snmp_exporter/snmp_exporter.yml
  • /opt/skala-r/etc/vision/agent/snmp_exporter/environment.env
  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/snmp_exporter.yml

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

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

Учетные данные для подключения по SNMP, используемые модули указываются в файле конфигурации snmp_exporter.yml.

Используемые ключи запуска#

Имя ключа Описание
config.file Путь к файлу конфигурации экспортера.
web.listen-address Адрес для прослушивания входящих http-запросов.
web.config.file Путь к файлу веб-конфигурации, который позволяет включить TLS и/или аутентификацию.

3.8 vision_utlz_exporter#

Компонент Визиона: Агент Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал и /opt/skala-r/var/log/vision/agent/utlz_exporter/utlz_exporter.log Порт по умолчанию: 9092 Описание: Экспортер для сбора метрик об утилизации сервера УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: - Используемые сторонние УЗ: - Файлы конфигурации:

  • /etc/systemd/system/vision_utlz_exporter.service
  • /opt/skala-r/etc/vision/agent/utlz_exporter/web.yml
  • /opt/skala-r/etc/vision/agent/utlz_exporter/environment.env
  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/utlz_exporter.yml

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

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

Используемые ключи запуска#

Имя ключа Описание
Имя ключа Описание
config.file Путь к файлу конфигурации экспортера.
web.listen-address Адрес для прослушивания входящих http-запросов.
web.config.file Путь к файлу веб-конфигурации, который позволяет включить TLS и/или аутентификацию.
common.use-dmidecode Использовать dmidecode для получения сведений о памяти.
common.config-fname Конфигурационный файл старого формата (только V0).
logging.output Место логирования, может быть одним из: file, stdout, stderr (default “file”)
logging.filePath Путь файла для логирования (используется при logging.output=file)
logging.level Уровень логирования (default “INFO”)

3.9 vision_utlz_exporter_v0#

Компонент Визиона: Агент Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал и /opt/skala-r/var/log/vision/agent/utlz_exporter_v0/utlz_exporter_v0.log Порт по умолчанию: 17070 Описание: Экспортер для сбора метрик об утилизации сервера УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: - Используемые сторонние УЗ: - Файлы конфигурации:

  • /etc/systemd/system/vision_utlz_exporter_v0.service
  • /opt/skala-r/etc/vision/agent/utlz_exporter_v0/web.yml
  • /opt/skala-r/etc/vision/agent/utlz_exporter_v0/environment.env
  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/utlz_exporter_v0.yml

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

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

Используемые ключи запуска аналогичны vision_utlz_exporter.

3.10 vision_one_exporter#

Компонент Визиона: Агент Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал Порт по умолчанию: 9621 Описание: Экспортер для OpenNebula УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: - Используемые сторонние УЗ: доступ к OpenNebula frontend Файлы конфигурации:

  • /etc/systemd/system/vision_one_exporter.service
  • /opt/skala-r/etc/vision/agent/one_exporter/one_exporter.yml
  • /opt/skala-r/etc/vision/agent/one_exporter/environment.env
  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/one_exporter.yml

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

Учетные данные для подключения к API Opennebula, параметры запуска сервера экспортера (адрес, порт) указываются в файле конфигурации one_exporter.yml.

Используемые ключи запуска#

Имя ключа Описание
config Путь к файлу конфигурации экспортера.

3.11 vision_ha_cluster_exporter#

Компонент Визиона: Агент Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал Порт по умолчанию: 9664 Описание: Экспортер для HAProxy УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: - Используемые сторонние УЗ: - Файлы конфигурации:

  • /etc/systemd/system/vision_ha_cluster_exporter.service
  • /opt/skala-r/etc/vision/agent/ha_cluster_exporter/web.yml
  • /opt/skala-r/etc/vision/agent/ha_cluster_exporter/environment.env
  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/ha_cluster_exporter.yml

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

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

Используемые ключи запуска#

Имя ключа Описание
web.listen-address Адрес для прослушивания входящих http-запросов.
web.config.file Путь к файлу веб-конфигурации, который позволяет включить TLS и/или аутентификацию.

3.12 vision_postgres_exporter_local#

Компонент Визиона: Агент Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал Порт по умолчанию: 9187 Описание: Экспортер для Postgresql УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: - Используемые сторонние УЗ: PostgreSQL Файлы конфигурации:

  • /etc/systemd/system/vision_postgres_exporter_agent.service
  • /opt/skala-r/etc/vision/agent/postgres_exporter_agent/web.yml
  • /opt/skala-r/etc/vision/agent/postgres_exporter_agent/environment.env
  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/postgres_exporter_agent.yml

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

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

Учетные данные для подключения к PostgreSQL указываются в файле конфигурации environment.env.

Используемые ключи запуска#

Имя ключа Описание
web.listen-address Адрес для прослушивания входящих http-запросов.
web.config.file Путь к файлу веб-конфигурации, который позволяет включить TLS и/или аутентификацию.
auto-discover-databases Следует ли динамически обнаруживать базы данных на сервере. (УСТАРЕЛО)

3.13 vision_postgres_exporter_multi#

Компонент Визиона: Агент Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал Порт по умолчанию: 9188 Описание: Экспортер для Postgresql УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: - Используемые сторонние УЗ: PostgreSQL Файлы конфигурации:

  • /etc/systemd/system/vision_postgres_exporter_multi.service
  • /opt/skala-r/etc/vision/agent/postgres_exporter_multi/web.yml
  • /opt/skala-r/etc/vision/agent/postgres_exporter_multi/postgres_exporter.yml
  • /opt/skala-r/etc/vision/agent/postgres_exporter_multi/environment.env
  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/postgres_exporter_multi.yml

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

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

Учетные данные для подключения к PostgreSQL указываются в файле конфигурации экспортера postgres_exporter.yml.

Используемые ключи запуска#

Имя ключа Описание
config.file Путь к файлу конфигурации экспортера.
web.listen-address Адрес для прослушивания входящих http-запросов.
web.config.file Путь к файлу веб-конфигурации, который позволяет включить TLS и/или аутентификацию.
auto-discover-databases Следует ли динамически обнаруживать базы данных на сервере. (УСТАРЕЛО)

3.14 vision_sql_exporter#

Компонент Визиона: Агент Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал Порт по умолчанию: 9399 Описание: Экспортер для Postgresql УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: - Используемые сторонние УЗ: PostgreSQL Файлы конфигурации:

  • /etc/systemd/system/vision_sql_exporter.service
  • /opt/skala-r/etc/vision/agent/sql_exporter/web.yml
  • /opt/skala-r/etc/vision/agent/sql_exporter/collectors/*
  • /opt/skala-r/etc/vision/agent/sql_exporter/sql_exporter.yml
  • /opt/skala-r/etc/vision/agent/sql_exporter/environment.env
  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/sql_exporter.yml

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

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

Учетные данные для подключения к PostgreSQL указываются в файле конфигурации экспортера sql_exporter.yml.

Директория collectors содержит параметры запросов экспортера к БД.

Используемые ключи запуска#

Имя ключа Описание
config.file Путь к файлу конфигурации экспортера.
web.listen-address Адрес для прослушивания входящих http-запросов.
web.config.file Путь к файлу веб-конфигурации, который позволяет включить TLS и/или аутентификацию.

3.15 vision_supv_exporter#

Компонент Визиона: Агент Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал и /opt/skala-r/var/log/vision/agent/supv_exporter/supv_exporter.log Порт по умолчанию: 9179 Описание: Экспортер для сервиса СУПВ УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: - Используемые сторонние УЗ: доступ к API Basis (СУПВ) Файлы конфигурации:

  • /etc/systemd/system/vision_supv_exporter.service
  • /opt/skala-r/etc/vision/agent/supv_exporter/web.yml
  • /opt/skala-r/etc/vision/agent/supv_exporter/supv_exporter.yml
  • /opt/skala-r/etc/vision/agent/supv_exporter/environment.env
  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/supv_exporter.yml

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

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

Учетные данные для подключения к СУПВ указываются в файле конфигурации экспортера supv_exporter.yml.

Используемые ключи запуска#

Имя ключа Описание
common.config-path Путь к файлу конфигурации экспортера.
web.listen-address Адрес для прослушивания входящих http-запросов.
web.config.file Путь к файлу веб-конфигурации, который позволяет включить TLS и/или аутентификацию.
logging.output Место логирования, может быть одним из: file, stdout, stderr (default “file”)
logging.filePath Путь файла для логирования (используется при logging.output=file)
logging.level Уровень логирования (default “INFO”)

3.16 vision_nginx_exporter#

Компонент Визиона: Агент Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал и /opt/skala-r/var/log/vision/agent/nginx_exporter/nginx_exporter.log Порт по умолчанию: 9113 Описание: Экспортер для Nginx УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: - Используемые сторонние УЗ: - Файлы конфигурации:

  • /etc/systemd/system/vision_nginx_exporter.service
  • /opt/skala-r/etc/vision/agent/nginx_exporter/web.yml
  • /opt/skala-r/etc/vision/agent/nginx_exporter/environment.env
  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/nginx_exporter.yml

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

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

Параметры для подключения к Nginx указываются в файле ключей запуска environment.env.

Используемые ключи запуска#

Имя ключа Описание
nginx.scrape-uri URI или путь к доменному сокету Unix для сбора метрик Nginx.
web.listen-address Адрес для прослушивания входящих http-запросов.
web.config.file Путь к файлу веб-конфигурации, который позволяет включить TLS и/или аутентификацию.
logging.output Место логирования, может быть одним из: file, stdout, stderr (default “file”).
logging.filePath Путь файла для логирования (используется при logging.output=file).
logging.level Уровень логирования (default “INFO”).

3.17 vision_exporter#

Компонент Визиона: Агент Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал и /opt/skala-r/var/log/vision/agent/vision_exporter/vision_exporter.log Порт по умолчанию: 7531 Описание: Экспортер для сервисов ОС УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: - Используемые сторонние УЗ: - Файлы конфигурации:

  • /etc/systemd/system/vision_exporter.service
  • /opt/skala-r/etc/vision/agent/vision_exporter/web.yml
  • /opt/skala-r/etc/vision/agent/vision_exporter/environment.env
  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/vision_exporter.yml

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

Все ключи запуска: vision_go/exporters/vision/README.md

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

Ключи запуска#

Имя ключа Описание
web.listen-address Адрес для прослушивания входящих http-запросов.
web.config.file Путь к конфигурационному файлу TLS и аутентификации
common.config-folder Папка с конфигурационными файлами используемых модулей
logging.fileMaxAge Максимальное число дней логирования в одном файле (используется при logging.output=file)
logging.fileMaxSize Максимальный размер одного файла логирования в МБ (используется при logging.output=file)
logging.filePath Путь файла для логирования (используется при logging.output=file)
logging.flags Вывод установленных флагов при запуске
logging.flags-table Вывод флагов компонента в виде таблицы
logging.level Уровень логирования
logging.output Место логирования, может быть одним из: file, stdout, stderr
module.eraraid.collect-period Период сбора метрик eraraid (в секундах)
module.eraraid.enable Включить сбор метрик eraraid
module.services.collect-period Период сбора метрик services (в секундах)
module.services.enable Включить сбор метрик services
module.session.collect-period Период сбора метрик session (в секундах)
module.session.enable Включить сбор метрик session
module.smart.collect-period Период сбора метрик smart (в секундах)
module.smart.enable Включить сбор метрик smart

3.18 kafka_exporter#

Компонент Визиона: Агент Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал Порт по умолчанию: 9308 Описание: Экспортер для сбора метрик c Apache Kafka УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: - Используемые сторонние УЗ: Apache Kafka Файлы конфигурации:

  • /etc/systemd/system/vision_kafka_exporter.service
  • /opt/skala-r/etc/vision/agent/kafka_exporter/web.yml
  • /opt/skala-r/etc/vision/agent/kafka_exporter/environment.env
  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/kafka_exporter.yml

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

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

Учетные данные для подключения к Kafka указываются в файле ключей запуска environment.env.

Используемые ключи запуска#

Имя ключа Описание
web.listen-address Адрес для прослушивания входящих http-запросов.
web.config.file Путь к конфигурационному файлу TLS и аутентификации.
audit.filePath Путь файла аудита (пустой - отключение аудита).
kafka.server Адрес (host:port) сервера Kafka (допустимо несколько ключей).
kafka.version Версия брокера Kafka.
topic.filter Регулярное выражение, определяющее, какие топики собирать.
topic.exclude Регулярное выражение, определяющее, какие топики исключить.
group.filter Регулярное выражение, определяющее, какие потребительские группы собирать.
group.exclude Регулярное выражение, определяющее, какие потребительские группы исключить.
[no-]sasl.enabled Подключение с использованием SASL/PLAIN, по умолчанию — выключено.
[no-]sasl.handshake Выключите, если используется SASL-прокси, не связанный с Kafka.
sasl.username Имя пользователя SASL.
sasl.password Пароль пользователя SASL (дополнительно зашифрован Визионом).
sasl.mechanism Механизм SASL: “scram-sha256”, “scram-sha512”, “gssapi” или “plain”.
sasl.service-name Имя сервиса при использовании аутентификации Kerberos. Используется только при sasl_mechanism=“gssapi”.
sasl.kerberos-config-path Путь к конфигурации Kerberos. Используется только при sasl_mechanism=“gssapi”.
sasl.realm Realm Kerberos. Используется только при sasl_mechanism=“gssapi”.
sasl.kerberos-auth-type Тип аутентификации Kerberos. Либо “keytabAuth”, либо “userAuth”. Используется только при sasl_mechanism=“gssapi”.
sasl.keytab-path Путь к файлу keytab для Kerberos. Используется только при sasl_mechanism=“gssapi” и sasl_kerberos_auth_type=“keytabAuth”.
[no-]sasl.disable-PA-FX-FAST Сконфигурировать клиент Kerberos без использования PA_FX_FAST, по умолчанию выключено. Используется только при sasl_mechanism=“gssapi”.
[no-]tls.enabled Подключение к Kafka с TLS, по умолчанию выключено.
tls.server-name Используется для проверки имени хоста в возвращаемых сертификатах, если не задан пропуск проверки сертификата. Должно быть указано имя сервера Kafka.
tls.ca-file Путь до CA файла для аутентификации клиента Kafka TLS (необязательно).
tls.cert-file Путь до файла сертификата для аутентификации клиента Kafka TLS (необязательно).
tls.key-file Путь до файла ключа сертификата для аутентификации клиента Kafka TLS (необязательно).
[no-]tls.insecure-skip-tls-verify Пропустить проверку сертификата.
[no-]use.consumelag.zookeeper Сбор текущей задержки (zookeeper) ConsumerGroup в топике/разделе.
zookeeper.server Адрес (хосты) zookeeper (допустимо несколько ключей).
refresh.metadata Интервал обновления метаданных.
[no-]offset.show-all Показывать смещение/задержку для всех групп потребителей. Если выключено, то показывать только подключенные группы потребителей.
topic.workers Количество параллельных потоков для обработки топиков.
[no-]kafka.allow-auto-topic-creation Разрешить автоматически создавать запрошенные топики, которые еще не существуют, по умолчанию выключено.

3.19 systemd_exporter#

Компонент Визиона: Агент Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал Порт по умолчанию: 9110 Описание: Экспортер для сбора метрик systemd юнитов УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: - Файлы конфигурации:

  • /etc/systemd/system/vision_systemd_exporter.service
  • /opt/skala-r/etc/vision/agent/systemd_exporter/web.yml
  • /opt/skala-r/etc/vision/agent/systemd_exporter/environment.env
  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/systemd_exporter.yml

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

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

Используемые ключи запуска#

Имя ключа Описание
web.listen-address Адрес для прослушивания входящих http-запросов.
web.config.file Путь к конфигурационному файлу TLS и аутентификации.
audit.filePath Путь файла аудита (пустой - отключение аудита).
systemd.collector.unit-include Фильтр для мониторинга только выбранных юнитов. Регулярное выражение RE2
systemd.collector.unit-exclude Фильтр для исключения из мониторинга выбранных юнитов. Регулярное выражение RE2

3.20 process_exporter#

Компонент Визиона: Агент Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал Порт по умолчанию: 9120 Описание: Экспортер для локального сбора метрик процессов ОС УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: - Файлы конфигурации:

  • /etc/systemd/system/vision_process_exporter.service
  • /opt/skala-r/etc/vision/agent/process_exporter/process_exporter.yml
  • /opt/skala-r/etc/vision/agent/process_exporter/web.yml
  • /opt/skala-r/etc/vision/agent/process_exporter/environment.env
  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/process_exporter.yml

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

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

Конфигурация мониторинга процессов в формате yaml хранится в process_exporter.yml.

Используемые ключи запуска#

Имя ключа Описание
web.listen-address Адрес для прослушивания входящих http-запросов.
web.config.file Путь к конфигурационному файлу TLS и аутентификации.
audit.filePath Путь файла аудита (пустой - отключение аудита).
config.path Конфигурация мониторинга процессов
children Обеспечивает, что любой процесс, который иначе не принадлежал бы к своей собственной группе, присоединяется к первой найденной группе
threads Показатели будут разбиты по названию потока, а также по названию группы.
recheck Пересмотр имен процессов при каждом сборе метрик, так как процессы могут изменять свои имена

3.21 kubernetes_exporter#

Компонент Визиона: Агент Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал Порт по умолчанию: 9130 Описание: Экспортер для локального сбора метрик Kubernetes УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: - Файлы конфигурации:

  • /etc/systemd/system/vision_kubernetes_exporter.service
  • /opt/skala-r/etc/vision/agent/kubernetes_exporter/web.yml
  • /opt/skala-r/etc/vision/agent/kubernetes_exporter/environment.env
  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/kubernetes_exporter.yml

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

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

Используемые ключи запуска#

Имя ключа Описание
web.listen-address Адрес для прослушивания входящих http-запросов.
web.config.file Путь к конфигурационному файлу TLS и аутентификации.
logging.output Тип логирования. Допустимые значения: file, stdout, stderr (default “file”).
logging.filePath Путь к файлу записи логов.
audit.filePath Путь файла аудита (пустой - отключение аудита).

3.22 r_virtualization_exporter#

Компонент Визиона: Агент Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал Порт по умолчанию: 9140 Описание: Экспортер для локального сбора c узлов вычисления и хранения МВ.С УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: - Файлы конфигурации:

  • /etc/systemd/system/vision_r_virtualization_exporter.service
  • /opt/skala-r/etc/vision/agent/vision_r_virtualization_exporter/web.yml
  • /opt/skala-r/etc/vision/agent/vision_r_virtualization_exporter/environment.env
  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/vision_r_virtualization_exporter.yml

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

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

Используемые ключи запуска#

Имя ключа Описание
web.listen-address Адрес для прослушивания входящих http-запросов.
web.config.file Путь к конфигурационному файлу TLS и аутентификации.
logging.output Тип логирования. Допустимые значения: file, stdout, stderr (default “file”).
logging.filePath Путь к файлу записи логов.
audit.filePath Путь файла аудита (пустой - отключение аудита).

3.23 r_vstorage_exporter#

Компонент Визиона: Агент Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал Порт по умолчанию: 17090 Описание: Экспортер для локального сбора метрик с узлов вычисления и хранения МВ.С УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: - Файлы конфигурации:

  • /etc/systemd/system/r_vstorage_exporter.service
  • /opt/skala-r/etc/vision/agent/r_vstorage_exporter/web.yml
  • /opt/skala-r/etc/vision/agent/r_vstorage_exporter/environment.env
  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/r_vstorage_exporter.yml

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

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

Используемые ключи запуска#

Имя ключа Описание
web.listen-address Адрес для прослушивания входящих http-запросов.
web.config.file Путь к конфигурационному файлу TLS и аутентификации.
logging.output Тип логирования. Допустимые значения: file, stdout, stderr (default “file”).
logging.filePath Путь к файлу записи логов.
audit.filePath Путь файла аудита (пустой - отключение аудита).

3.24 vcontrol_exporter#

Примечание
Ранее этот компонент назывался mvs_exporter.

Компонент Визиона: Агент. Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал. Порт по умолчанию: 17061. Описание: экспортер для сбора метрик через API vControl. УЗ ОС запуска сервиса: vision Используемые УЗ компонентов Визиона: - Файлы конфигурации:

  • /etc/systemd/system/vision_vcontrol_exporter.service
  • /opt/skala-r/etc/vision/agent/vcontrol_exporter/web.yml
  • /opt/skala-r/etc/vision/agent/vcontrol_exporter/environment.env
  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/vcontrol_exporter.yml

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

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

Учётные данные для подключения к API Базис.vControl указываются в файле ключей запуска environment.env.

Используемые ключи запуска#

Имя ключа Описание
audit.filePath Путь файла аудита (пустой — отключение аудита)
logging.filePath Путь к файлу записи логов
logging.output Тип логирования. Допустимые значения: file, stdout, stderr (default “file”)
vcontrol.address Адрес узла/вм Базис.vControl
vcontrol.login Имя пользователя Базис.vControl
vcontrol.password Пароль пользователя Базис.vControl
web.config.file Путь к конфигурационному файлу TLS и аутентификации
web.listen-address Адрес для прослушивания входящих HTTP-запросов

3.25 tatlin_storage_exporter#

Компонент Визиона: Агент. Способ установки: Интерфейс Визион.Сервера через plagent. Расположение журналов: системный журнал. Порт по умолчанию: 17110. Описание: Экспортер с дополнительными функциями мониторинга СХД Tatlin. УЗ ОС запуска сервиса: vision. Используемые УЗ компонентов Визиона: - Файлы конфигурации:

  • /etc/systemd/system/vision_tatlin_storage_exporter.service;
  • /opt/skala-r/etc/vision/agent/tatlin_storage_exporter/web.yml;
  • /opt/skala-r/etc/vision/agent/tatlin_storage_exporter/environment.env;
  • /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/tatlin_storage_exporter.yml.

Настройка параметров TLS и аутентификации для доступа к компоненту по HTTPS производится в файле веб-конфигурации web.yml.

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

Используемые ключи запуска#

| audit.fileMaxAge | Продолжительность хранения файлов аудита в днях | | audit.fileMaxSize | Максимальный размер одного файла аудита в МБ | | audit.filePath | Путь файла аудита (пустой — отключение аудита) | | common.scrape-timeout | Таймаут запроса метрик в секундах | | logging.fileMaxAge | Максимальное число дней логирования в одном файле (используется при logging.output=file) | | logging.fileMaxSize | Максимальный размер одного файла логирования в МБ (используется при logging.output=file) | | logging.filePath | Путь файла для логирования (используется при logging.output=file) | | logging.flags | Вывод установленных флагов при запуске | | logging.flags-table | Вывод флагов компонента в виде таблицы | | logging.level | Уровень логирования | | logging.output | Место логирования, может быть одним из: file, stdout, stderr | | version | Вывод версии компонента | | web.config.file | Путь к конфигурационному файлу TLS и аутентификации | | web.listen-address | Адрес для работы http сервера | | web.routes-table | Вывод роутов в виде таблицы | | web.telemetry-path | Путь для выдачи метрик |

4 Общие инструкции#

4.1 Веб-конфигурация компонентов: web.yml#

Следующие компоненты используют один и тот же формат файла веб-конфигурации web.yml

  • Визион.Сервер - файл генерируется дистрибутивом Визион.Сервера
    • alertmanager
    • snmp_notifier
    • vision_alertcollector
  • Визион.Агент - файл генерируется после управляющих воздействий в интерфейсе Визион.Сервера через plagent:
    • vision_exporter
    • vision_nginx_exporter
    • vision_supv_exporter
    • vision_sql_exporter
    • vision_postgres_exporter_multi
    • vision_postgres_exporter_local
    • vision_ha_cluster_exporter
    • vision_utlz_exporter_v0
    • vision_utlz_exporter
    • vision_snmp_exporter
    • vision_ipmi_exporter
    • vision_bash_exporter
    • vision_systemd_exporter
    • vision_process_exporter
    • vision_kafka_exporter
    • vision_kubernetes_exporter
    • vision_r_virtualization_exporter
    • vision_r_vstorage_exporter
    • vision_mvs_exporter

Ключ запуска компонента –web.config.file, используется чтобы указать, какой файл веб-конфигурации следует использовать.

Файл конфигурации экспортеров генерируется vision_core и записывается в формате YAML, определенной схемой, описанной ниже.

tls_server_config:
  cert_file: <filename>
  key_file: <filename>
  min_version: TLS13

basic_auth_users:
  [ <string>: <secret> ... ]

В интерфейсе Визиона в конфигурации экземпляра плагина-экспортера вы можете задать следующие параметры данного файла конфигурации

  • Basic Auth Username и Basic Auth Password - имя и пароль пользователя, который имеет полный доступ к веб-серверу экспортера посредством BasicAuth. Пароли хешируются с помощью bcrypt.
  • Tls Cert File и Tls Key File - пути на узле до сертификатов и ключей, которые веб-сервер экспортера будет использовать для аутентификации клиента.

Также данные параметры в итоге используются в /opt/skala-r/etc/vision/agent/vmagent_agent/jobs/*_exporter.yml для сбора метрик компонентом vmagent_agent с экспортера.

4.2 Изменение УЗ компонентов Визион.Сервера#

Компоненты Визион.Сервера устанавливаются из дистрибутива Визиона. После установки вы можете изменить необходимые параметры компонентов в их файлах конфигурации. Обратите внимание, что часть файлов конфигурации генерирует vision_core в процессе своей работы и действий пользователя в UI, что отмечено в описании компонентов. Для изменения параметров обратитесь к описанию необходимого компонента.

4.3 Изменение УЗ vmagent/vlagent (Прокси, Агент)#

Компоненты vmagent_agent, vmagent_proxy, vlagent_agent и vlagent_proxy устанавливается на узел из интерфейса Визиона компонентом vision_core с параметрами указанными в конфигурационном файле vision_core/config.yml в разделе remote_components в ключах metric_agent, mteric_proxy, log_agent, log_proxy. Данные параметры глобальны для всех агентов, после их изменения рекомендуется переустановить все агенты Визиона.

4.4 Изменение УЗ компонентов устанавливаемых через плагины в интерфейсе Визиона#

Интерфейс Визиона позволяет использовать плагины для установки экспортеров и скреперов сбора метрик., а также предоставляет их детальную настройку. Обратитесь к описанию плагинов.

5 Приложения#

5.1 Документация сторонних продуктов#

Ключи запуска victoriametrics

Ключи запуска snmp_notifier

Go template