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

Конфигурационный файл /opt/skala-r/etc/vision/server/vision_core/config.yml содержит настройки, управляющие поведением Визион и его взаимодействием с другими компонентами.

Значение некоторых параметров защищены с помощью Ansible Vault . Вместо фактического значения в config.yml указывается ссылка на запись в файле /opt/skala-r/vision/.secrets_vault. Для изменения таких параметров воспользуйтесь соответствующей инструкцией.

alertcollector#

Раздел alertcollector содержит настройки взаимодействия с AlertCollector.

alertcollector.api_firing_path

Путь к API для отправки алертов от vmalert.
alertcollector.api_health_postfix

Маршрут для проверки состояния компонента.
alertcollector.basic_auth_password

Пароль BasicAuth для HTTP-запросов к компоненту.

Значение хранится в Ansible Vault.
alertcollector.basic_auth_username

Имя пользователя BasicAuth для HTTP-запросов к компоненту.
alertcollector.component_name

Название компонента.
alertcollector.config_files.env_filepath

Путь к файлу с переменными, управляющими работой компонента.
alertcollector.config_files.web_config_filepath

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

Адрес для HTTP-запросов к компоненту.
alertcollector.logging.audit_log_filepath

Путь к файлу журнала аудита.
alertcollector.logging.logging_filepath

Путь к файлу журнала компонента.

Значение этого параметра используется при alertcollector.logging.logging_output=file.
alertcollector.logging.logging_output

Тип журналирования работы компонента.

Возможные значения:
- file;
- stderr;
- stdout.
alertcollector.port

Порт для HTTP-запросов к компоненту.
alertcollector.protocol

Протокол HTTP-сервера компонента.
alertcollector.request_timeout

Таймаут HTTP-запросов к компоненту в секундах.
alertcollector.route_prefix

Префикс для HTTP-запросов к компоненту.
alertcollector.systemd_service

Название сервиса systemd компонента.
alertcollector.tls_ca_file

Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту.
alertcollector.tls_cert_file

Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
alertcollector.tls_insecure_skip_verify

Пропуск проверки TLS при HTTP-запросах к компоненту.
alertcollector.tls_key_file

Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
alertcollector.version

Версия компонента.

alertmanager#

Раздел alertmanager содержит настройки взаимодействия с AlertManager.

alertmanager.api_firing_path

Путь к API для отправки алертов от vmalert.
alertmanager.api_health_postfix

Маршрут для проверки состояния компонента.
alertmanager.basic_auth_password

Пароль BasicAuth для HTTP-запросов к компоненту.

Значение хранится в Ansible Vault.
alertmanager.basic_auth_username

Имя пользователя BasicAuth для HTTP-запросов к компоненту.
alertmanager.component_name

Название компонента.
alertmanager.config_files

Пути к конфигурационным файлам компонента.
alertmanager.config_files.config_filepath

Путь к конфигурационному файлу компонента.
alertmanager.config_files.env_filepath

Путь к файлу с переменными, управляющими работой компонента.
alertmanager.config_files.web_config_filepath

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

URL, который указывается в рассылке.
alertmanager.host

Адрес для HTTP-запросов к компоненту.
alertmanager.port

Порт для HTTP-запросов к компоненту.
alertmanager.protocol

Протокол HTTP-сервера компонента.
alertmanager.request_timeout

Таймаут HTTP-запросов к компоненту в секундах.
alertmanager.route

Параметры маршрутов.
alertmanager.route.group_by

Список признаков для группировки уведомлений.
alertmanager.route.group_interval

Время ожидания в секундах перед отправкой повторных уведомлений для группы алертов, уведомления о которых уже были отправлены. Уведомления о новых или изменившихся алертах будут отправлены только по истечении указанного периода.
alertmanager.route.group_wait

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

Время ожидания в секундах перед отправкой повторных уведомлений для группы алертов. Уведомления будут отправлены в том случае, если по истечении указанного периода времени алерты будут всё ещё активны.
alertmanager.route_prefix

Префикс для HTTP-запросов к компоненту.
alertmanager.systemd_service

Название сервиса systemd компонента.
alertmanager.templates

Список путей к файлам, из которых загружаются определения пользовательских шаблонов уведомлений AlertManager. Последний компонент пути может содержать шаблон с подстановкой, например, templates/*.tmpl.
alertmanager.tls_ca_file

Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту.
alertmanager.tls_cert_file

Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
alertmanager.tls_insecure_skip_verify

Пропуск проверки TLS при HTTP-запросах к компоненту.
alertmanager.tls_key_file

Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
alertmanager.version

Версия компонента.

auth#

Раздел auth содержит настройки аутентификации при работе с API vision_core.

auth.admin_role_codes

Параметры сопоставления ролей администраторов Визион с ролями IAM.
auth.admin_role_codes.inventory

Название роли администратора инвентаря в IAM.
auth.admin_role_codes.obj_model

Название роли администратора объектной модели в IAM.
auth.admin_role_codes.role_model

Название роли администратора информационной модели в IAM.
auth.admin_role_codes.vsn_config

Название роли администратора объектов мониторинга в IAM.
auth.admin_server

URL административной части провайдера OAuth2.

В случае пустой строки будет использоваться значение параметра auth_server.
auth.auth_server

URL провайдера OAuth2.
auth.auth_type

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

Идентификатор клиента, предоставленный приложением OAuth2.
auth.client_secret

Секрет клиента, предоставленный приложением OAuth2.

Значение хранится в Ansible Vault.
auth.enabled

Использование аутентификации OAuth2.
auth.realm

Имя realm провайдера OAuth2.
auth.request_timeout

Таймаут HTTP-запросов в секундах.
auth.tls_insecure_skip_verify

Пропуск проверки TLS при HTTP-запросах.

backup#

Раздел backup содержит настройки взаимодействия с компонентом резервного копирования.

backup.api_health_postfix

Маршрут для проверки состояния компонента.
backup.backup_directory

Директория для хранения резервных копий.
backup.basic_auth_password

Пароль BasicAuth для HTTP-запросов к компоненту.

Значение хранится в Ansible Vault.
backup.basic_auth_username

Имя пользователя BasicAuth для HTTP-запросов к компоненту.
backup.component_name

Название компонента.
backup.config_files

Пути к конфигурационным файлам.
backup.config_files.config_filepath

Путь к конфигурационном файлу компонента.
backup.config_files.env_filepath

Путь к файлу с переменными, управляющими работой компонента.
backup.config.web_config_filepath

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

Путь к файлу шаблона, на основе которого создаётся конфигурационный файл компонента.
backup.host

Адрес для HTTP-запросов к компоненту.
backup.internal_timeout

Внутренний таймаут на выполнение операций.
backup.port

Порт для HTTP-запросов к компоненту.
backup.protocol

Протокол HTTP-сервера компонента.
backup.request_timeout

Таймаут HTTP-запросов к компоненту в секундах.
backup.route_prefix

Префикс для добавления ко всем путям, обрабатываемым HTTP-сервером.
backup.schedule

Настройки запуска заданий по расписанию.
backup.schedule.enabled

Включение запуска заданий по расписанию.
backup.schedule.interval

Периодичность запуска заданий в часах.
backup.schedule.start_at

Начальные дата и время запуска заданий по расписанию.
backup.systemd_service

Название сервиса systemd компонента.
backup.tls_ca_file

Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту.
backup.tls_cert_file

Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
backup.tls_insecure_skip_verify

Пропуск проверки TLS при HTTP-запросах к компоненту.
backup.tls_key_file

Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
backup.version

Версия компонента.

database#

Раздел database содержит настройки подключения к служебной БД.

database.component_name

Название компонента.
database.dsn

Параметры подключения к служебной БД.

Значение хранится в Ansible Vault.
database.version

Версия компонента.

foliage_api#

Раздел foliage_api содержит настройки доступа к Foliage API.

foliage_api.basic_auth_password

Пароль BasicAuth для HTTP-запросов к компоненту.

Значение хранится в Ansible Vault.
foliage_api.basic_auth_username

Имя пользователя BasicAuth для HTTP-запросов к компоненту.
foliage_api.component_name

Название компонента.
foliage_api.host

Адрес для HTTP-запросов к компоненту.
foliage_api.port

Порт для HTTP-запросов к компоненту.
foliage_api.protocol

Протокол HTTP-сервера компонента.
foliage_api.request_timeout

Таймаут HTTP-запросов к компоненту в секундах.
foliage_api.route_prefix

Префикс для HTTP-запросов к компоненту.
foliage_api.tls_ca_file

Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту.
foliage_api.tls_cert_file

Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
foliage_api.tls_insecure_skip_verify

Пропуск проверки TLS при HTTP-запросах к компоненту.
foliage_api.tls_key_file

Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
foliage_api.version

Версия компонента.

foliage_ui#

Раздел foliage_ui содержит настройки доступа к графическому интерфейсу Foliage.

foliage_ui.basic_auth_password

Пароль BasicAuth для HTTP-запросов к компоненту.

Значение хранится в Ansible Vault.
foliage_ui.basic_auth_username

Имя пользователя BasicAuth для HTTP-запросов к компоненту.
foliage_ui.component_name

Название компонента.
foliage_ui.host

Адрес для HTTP-запросов к компоненту.
foliage_ui.port

Порт для HTTP-запросов к компоненту.
foliage_ui.protocol

Протокол HTTP-сервера компонента.
foliage_ui.request_timeout

Таймаут HTTP-запросов к компоненту в секундах.
foliage_ui.route_prefix

Префикс для HTTP-запросов к компоненту.
foliage_ui.tls_ca_file

Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту.
foliage_ui.tls_cert_file

Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
foliage_ui.tls_insecure_skip_verify

Пропуск проверки TLS при HTTP-запросах к компоненту.
foliage_ui.tls_key_file

Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
foliage_ui.version

Версия компонента.

general#

Раздел general содержит основные настройки vision_core.

general.agent_audit_directory

Директория хранения логов аудита Мониторинг.Агента.
general.agent_directory

Директория Мониторинг.Агента.
general.agent_etc_directory

Директория с файлами конфигурации Мониторинг.Агента.
general.agent_log_directory

Директория хранения логов Мониторинг.Агента.
general.cookie_secret_key

Секретный ключ для cookies.

Значение хранится в Ansible Vault.
general.is_demo_stand

Запуск Мониторинг.Сервер в режиме демо-стенда.
general.plugins_directory

Директория с плагинами мониторинга.
general.product_type

Тип продукта.

Возможные значения:
- genom;
- vision.
general.proxy_directory

Директория Мониторинг.Прокси.
general.proxy_etc_directory

Директория с файлами конфигурации Мониторинг.Прокси.
general.proxy_log_directory

Директория хранения логов Мониторинг.Прокси.
general.python_filepath

Путь к интерпретатору Python, используемому в Vision Core.
general.query_validator_bin_filepath

Путь к исполняемому файлу vmagent на Мониторинг.Сервере.
general.request_timeout

Глобальный параметр, устанавливающий таймаут HTTP-запросов в секундах.
general.verify_ssl

Глобальный параметр, устанавливающий необходимость проверки сертификата при HTTPS-запросах.
general.vision_version_path

Путь к файлу с версией мониторинга.

grafana#

Раздел grafana содержит настройки взаимодействия с Grafana.

grafana.admin_password

Пароль администратора Grafana.

Значение хранится в Ansible Vault.
grafana.admin_username

Имя администратора Grafana.
grafana.api_health_postfix

Маршрут для проверки состояния компонента.
grafana.binary_filepath

Полный путь к исполняемому файлу Grafana.
grafana.component_name

Название компонента.
grafana.config_ini_filepath

Путь к INI-файлу конфигурации Grafana.
grafana.config_yaml_filepath

Путь к YAML-файлу, на основе которого создаётся INI-файл конфигурации Grafana.
grafana.datasources_filepath

Путь к YAML-файлу с описанием источников данных Grafana.
grafana.host

Адрес для HTTP-запросов к компоненту.
grafana.metrics_basic_auth_password

Пароль BasicAuth для HTTP-запросов на получение метрик.

Значение хранится в Ansible Vault.
grafana.metrics_basic_auth_username

Имя пользователя BasicAuth для HTTP-запросов на получение метрик.
grafana.port

Порт для HTTP-запросов к компоненту.
grafana.protocol

Протокол HTTP-сервера компонента.
grafana.request_timeout

Таймаут HTTP-запросов к компоненту в секундах.
grafana.route_prefix

Префикс для HTTP-запросов к компоненту.
grafana.systemd_service

Название сервиса systemd компонента.
grafana.tls_ca_file

Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту.
grafana.tls_cert_file

Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
grafana.tls_insecure_skip_verify

Пропуск проверки TLS при HTTP-запросах к компоненту.
grafana.tls_key_file

Путь к файлу ключа сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
grafana.user_cache_maxsize

Ограничение на количество записей в кеше.
grafana.user_cache_ttl

Время жизни в секундах записей в кеше.
grafana.var_filepath

Полный путь к директории для хранения временных файлов Grafana.
grafana.version

Версия компонента.

iamsyncer#

Раздел iamsyncer содержит настройки взаимодействия с IAMSyncer — компонентом, отвечающим за синхронизацию данных о ролях и пользователях между IAM и vision_core.

iamsyncer.api_health_postfix

Маршрут для проверки состояния компонента.
iamsyncer.basic_auth_password

Пароль BasicAuth для HTTP-запросов к компоненту.

Значение хранится в Ansible Vault.
iamsyncer.basic_auth_username

Имя пользователя BasicAuth для HTTP-запросов к компоненту.
iamsyncer.component_name

Название компонента.
iamsyncer.env_filepath

Путь к файлу с переменными, управляющими работой компонента.
iamsyncer.fetch_interval

Периодичность запроса получателей из IAM, в секундах.
iamsyncer.host

Адрес для HTTP-запросов к компоненту.
iamsyncer.port

Порт для HTTP-запросов к компоненту.
iamsyncer.protocol

Протокол HTTP-сервера компонента.
iamsyncer.request_timeout

Таймаут HTTP-запросов к компоненту в секундах.
iamsyncer.route_prefix

Префикс для добавления ко всем путям, обрабатываемым HTTP-сервером.
iamsyncer.systemd_service

Название сервиса systemd компонента.
iamsyncer.tech_auth_client_id

Идентификатор технического клиента, предоставленный приложением OAuth2.
iamsyncer.tech_auth_client_secret

Секрет технического клиента, предоставленный приложением OAuth2.

Значение хранится в Ansible Vault.
iamsyncer.tech_auth_password

Пароль технической учётной записи IAM.

Значение хранится в Ansible Vault.
iamsyncer.tech_auth_username

Имя технической учётной записи IAM.
iamsyncer.tls_ca_file

Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту.
iamsyncer.tls_cert_file

Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
iamsyncer.tls_insecure_skip_verify

Пропуск проверки TLS при HTTP-запросах к компоненту.
iamsyncer.tls_key_file

Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
iamsyncer.user_update_enabled

Включает механизм синхронизации пользователей/получателей с IAM.
iamsyncer.version

Версия компонента.
iamsyncer.web_config_file

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

migration#

Раздел migration содержит настройки миграции служебной БД Визион.

migration.last

Имя файла с командами миграции.

Возможные значения:
1. 000-000_initial.py;
2. 000-001_config_pg_dsn.py;
3. 000-002_vision_backup_config_dsn.py.

platform_agent#

Раздел platform_agent содержит настройки взаимодействия с агентом платформы (plagent).

platform_agent.component_name

Название компонента.
platform_agent.port

Порт для HTTP-запросов к компоненту.
platform_agent.protocol

Порт для HTTP-запросов к компоненту.
platform_agent.tls_insecure_skip_verify

Пропуск проверки TLS при HTTP-запросах.
platform_agent.token

Токен аутентификации для HTTP-запросов к компоненту.

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

platform_ui#

Раздел platform_ui содержит настройки графического интерфейса платформы.

platform_ui.dashboards.interval_bound

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

Значение записывается одной строкой с символом | в качестве разделителя, например:
```
3600|10800|21600|43200|86400
```
ВАЖНО: Количество периодов должно совпадать с количеством названий, указанных в значении параметра platform_ui.dashboards.interval_title.
platform_ui.dashboards.interval_title

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

Значение записывается одной строкой с символом | в качестве разделителя, например:
```
1ч|3ч|6ч|12ч|24ч
```
ВАЖНО: Количество названий должно совпадать с количеством периодов, указанных в значении параметра platform_ui.dashboards.interval_bound.

remote_components#

Раздел remote_components содержит параметры взаимодействия с удалёнными агентами и прокси.

log_agent#

Раздел remote_components.log_agent содержит настройки взаимодействия с агентами логов.

remote_components.log_agent.audit_component_name

Название агента логов, используемое в журнале аудита.
remote_components.log_agent.audit_filepath

Путь к файлу аудита агента логов.
remote_components.log_agent.basic_auth_password

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

Значение хранится в Ansible Vault.
remote_components.log_agent.basic_auth_username

Имя пользователя BasicAuth для доступа к агенту логов.
remote_components.log_agent.component_name

Название компонента агента логов.
remote_components.log_agent.log_filepath

Путь к файлу журнала агента логов.
remote_components.log_agent.port

Порт для доступа к агенту логов.
remote_components.log_agent.protocol

Протокол для доступа к агенту логов.
remote_components.log_agent.remote_bin_filepath

Путь для размещения исполняемого файла агента логов на удалённом узле.
remote_components.log_agent.repo_bin_filepath

Путь к исполняемому файлу агента логов на сервере.
remote_components.log_agent.route_prefix

Префикс URL для доступа к агенту логов.
remote_components.log_agent.syslog_tcp_listen_port

Порт, который агент должен использовать для отправки логов в syslog.
remote_components.log_agent.systemd_service

Название сервиса systemd агента логов.
remote_components.log_agent.tls_ca_file

Путь к файлу TLS CA, который будет использоваться для проверки подключений к агенту логов.
remote_components.log_agent.tls_cert_file

Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к агенту логов.
remote_components.log_agent.tls_insecure_skip_verify

Пропуск проверки TLS при HTTP-запросах к агенту логов.
remote_components.log_agent.tls_key_file

Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к агенту логов.
remote_components.log_agent.tls_min_version

Минимальная версия TSL, необходимая для подключения к агенту логов.

log_proxy#

Раздел remote_components.log_proxy содержит настройки взаимодействия с прокси логов.

remote_components.log_proxy.audit_component_name

Название прокси логов, используемое в журнале аудита.
remote_components.log_proxy.audit_filepath

Путь к файлу аудита прокси логов.
remote_components.log_proxy.basic_auth_password

Пароль BasicAuth для доступа к прокси логов.

Значение хранится в Ansible Vault.
remote_components.log_proxy.basic_auth_username

Имя пользователя BasicAuth для доступа к прокси логов.
remote_components.log_proxy.component_name

Название компонента прокси логов.
remote_components.log_proxy.log_filepath

Путь к файлу журнала прокси логов.
remote_components.log_proxy.port

Порт для доступа к прокси логов.
remote_components.log_proxy.protocol

Протокол для доступа к прокси логов.
remote_components.log_proxy.remote_bin_filepath

Путь для размещения исполняемого файла агента логов на удалённом узле.
remote_components.log_proxy.repo_bin_filepath

Путь к исполняемому файлу агента логов на сервере.
remote_components.log_proxy.route_prefix

Префикс URL для доступа к прокси логов.
remote_components.log_proxy.systemd_service

Название сервиса systemd прокси логов.
remote_components.log_proxy.tls_ca_file

Путь к файлу TLS CA, который будет использоваться для проверки подключений к агенту логов.
remote_components.log_proxy.tls_cert_file

Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к агенту логов.
remote_components.log_proxy.tls_insecure_skip_verify

Пропуск проверки TLS при HTTP-запросах к компоненту.
remote_components.log_proxy.tls_key_file

Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к прокси логов.
remote_components.log_proxy.tls_min_version

Минимальная версия TLS, необходимая для подключения к прокси логов.

metric_agent#

Раздел remote_components.metric_agent содержит настройки взаимодействия с агентами метрик.

remote_components.metric_agent.audit_component_name

Название агента метрик, используемое в журнале аудита.
remote_components.metric_agent.audit_filepath

Путь к файлу аудита агента метрик.
remote_components.metric_agent.basic_auth_password

Пароль BasicAuth для доступа к агенту метрик.

Значение хранится в Ansible Vault.
remote_components.metric_agent.basic_auth_username

Имя пользователя BasicAuth для доступа к агенту метрик.
remote_components.metric_agent.component_name

Название компонента агента метрик.
remote_components.metric_agent.log_filepath

Путь к файлу журнала агента метрик.
remote_components.metric_agent.port

Порт для доступа к агенту метрик.
remote_components.metric_agent.promscrape_max_scrape_size

Максимальный объём данных, которые могут быть получены за один сбор метрик c таргета.

Значением параметра указывайте по шаблону:
```
<number><size>
```
Здесь:
- <number> — числовое значение;
- <size> — размерность:
  - K — килобайты;
  - M — мегабайты;
  - G — гигабайты.
remote_components.metric_agent.protocol

Протокол для доступа к агенту метрик.
remote_components.metric_agent.remote_bin_filepath

Путь для размещения исполняемого файла агента метрик на удалённом узле.
remote_components.metric_agent.repo_bin_filepath

Путь к исполняемому файлу агента метрик на сервере.
remote_components.metric_agent.route_prefix

Префикс URL для доступа к агенту метрик.
remote_components.metric_agent.systemd_service

Название сервиса systemd агента метрик.
remote_components.metric_agent.tls_ca_file

Путь к файлу TLS CA, который будет использоваться для проверки подключений к агенту метрик.
remote_components.metric_agent.tls_cert_file

Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к агенту метрик.
remote_components.metric_agent.tls_insecure_skip_verify

Пропуск проверки TLS при HTTP-запросах к агенту метрик.
remote_components.metric_agent.tls_key_file

Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к агенту метрик.
remote_components.metric_agent.tls_min_version

Минимальная версия TLS, необходимая для подключения к агенту метрик.

metric_proxy#

Раздел remote_components.metric_proxy содержит настройки взаимодействия с прокси метрик.

remote_components.metric_proxy.audit_component_name

Название прокси метрик, используемое в журнале аудита.
remote_components.metric_proxy.audit_filepath

Путь к файлу аудита прокси метрик.
remote_components.metric_proxy.basic_auth_password

Пароль BasicAuth для доступа к прокси метрик.

Значение хранится в Ansible Vault.
remote_components.metric_proxy.basic_auth_username

Имя пользователя BasicAuth для доступа к прокси метрик.
remote_components.metric_proxy.component_name

Название компонента прокси метрик.
remote_components.metric_proxy.log_filepath

Путь к файлу журнала прокси метрик.
remote_components.metric_proxy.port

Порт для доступа к прокси метрик.
remote_components.metric_proxy.protocol

Протокол для доступа к прокси метрик.
remote_components.metric_proxy.remote_bin_filepath

Путь для размещения исполняемого файла прокси метрик на удалённом узле.
remote_components.metric_proxy.repo_bin_filepath

Путь к исполняемому файлу прокси метрик на сервере.
remote_components.metric_proxy.route_prefix

Префикс URL для доступа к прокси метрик.
remote_components.metric_proxy.systemd_service

Название сервиса systemd прокси метрик.
remote_components.metric_proxy.tls_ca_file

Путь к файлу TLS CA, который будет использоваться для проверки подключений к агенту метрик.
remote_components.metric_proxy.tls_cert_file

Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к прокси метрик.
remote_components.metric_proxy.tls_insecure_skip_verify

Пропуск проверки TLS при HTTP-запросах к прокси метрик.
remote_components.metric_proxy.tls_key_file

Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к прокси метрик.
remote_components.metric_proxy.tls_min_version

Минимальная версия TLS, необходимая для подключения к прокси метрик.

smtp_config#

Раздел smtp_config содержит настройки взаимодействия с SMTP-шлюзом.

smtp_config.default_receiver_email

Email для отправки уведомлений без получателя, согласно параметрам групп получателей в интерфейсе подсистемы мониторинга.
smtp_config.smtp_auth_password

Пароль пользователя для подключения к SMTP-серверу (LOGIN и PLAIN).

Если авторизация не требуется, используйте значение null.

Значение хранится в Ansible Vault.
smtp_config.smtp_auth_username

Имя пользователя для подключения к SMTP-серверу (LOGIN и PLAIN).

Если авторизация не требуется, используйте значение null.
smtp_config.smtp_from

Email отправителя сообщений для поля заголовка SMTP From.
smtp_config.smtp_host

Хост SMTP, используемый для отправки уведомлений.
smtp_config.smtp_port

Порт SMTP-сервера.
smtp_config.smtp_require_tls

Защита подключения к SMTP-серверу с помощью TLS.
smtp_config.smtp_test_timeout

Таймаут отправки тестового письма к SMTP-серверу.

snmp_notifier_config#

Раздел snmp_notifier_config содержит настройки взаимодействия с SnmpNotifier.

smtp_notifier.api_health_postfix

Маршрут для проверки состояния компонента.
smtp_notifier.basic_auth_password

Пароль BasicAuth для HTTP-запросов к компоненту.

Значение хранится в Ansible Vault.
smtp_notifier.basic_auth_username

Имя пользователя BasicAuth для HTTP-запросов к компоненту.
smtp_notifier.component_name

Название компонента.
smtp_notifier.env_file

Путь к файлу переменными, управляющими работой SnmpNotifier.
smtp_notifier.host

Адрес для HTTP-запросов к компоненту.
smtp_notifier.port

Порт для HTTP-запросов к компоненту.
smtp_notifier.protocol

Протокол HTTP-сервера компонента.
smtp_notifier.request_timeout

Таймаут HTTP-запросов к компоненту в секундах.
smtp_notifier.route_prefix

Префикс для HTTP-запросов к компоненту.
smtp_notifier.snmp_authentication_password

Пароль аутентификации SNMP (только для V3). Значение секрета задаётся через API.

Значение хранится в Ansible Vault.
smtp_notifier.snmp_authentication_protocol

Протокол шифрования пароля (только V3).

Возможные значения:
- MD5;
- SHA.
Значение задаётся через API.
smtp_notifier.snmp_authentication_username

Имя пользователя аутентификации SNMP (только V3).

Это поле обязательно для заполнения, если заполнено поле snmp_authentication_protocol.

Значение задаётся через API.
smtp_notifier.snmp_community

Комьюнити SNMP (только V2c).

Значение задаётся через API.
smtp_notifier.snmp_context_engine_id

Идентификатор механизма контекста (только V3).

Значение задаётся через API.
smtp_notifier.snmp_context_name

Имя контекста (только V3).

Значение задаётся через API.
smtp_notifier.snmp_destination

Адресат сообщений.

Значение задаётся через API.
smtp_notifier.snmp_private_password

Пароль шифрования SNMP (только для V3).

Значение секрета задаётся через API.

Значение хранится в Ansible Vault.
smtp_notifier.snmp_private_protocol

Протокол передачи данных SNMP (только V3).

Возможные значения:
- AES;
- DES.
Значение задаётся через API.
smtp_notifier.snmp_retries

Количество повторных посылок сообщения SNMP.

Значение задаётся через API.
smtp_notifier.snmp_security_engine_id

ID механизма безопасности SNMP (только V3).

Значение задаётся через API.
smtp_notifier.snmp_timeout_sec

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

Значение задаётся через API.
smtp_notifier.snmp_trap_default_oid

OID ловушки, если он не найден в метках сработавшего правила.

Значение задаётся через API.
smtp_notifier.snmp_trap_description_template

Путь к файлу шаблона сообщения SNMP.
smtp_notifier.snmp_trap_oid_label

Метка, содержащая OID ловушки.
smtp_notifier.snmp_version

Версия SNMP.

Возможные значения:
- V2c;
- V3.
Значение задаётся через API.
smtp_notifier.systemd_service

Название сервиса systemd компонента.
smtp_notifier.tls_ca_file

Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту.
smtp_notifier.tls_cert_file

Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
smtp_notifier.tls_insecure_skip_verify

Пропуск проверки TLS при HTTP-запросах к компоненту.
smtp_notifier.tls_key_file

Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
smtp_notifier.version

Версия компонента.
smtp_notifier.web_config_file

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

task_daemon#

Раздел task_daemon содержит настройки взаимодействия с TaskDaemon.

task_daemon.component_name

Название компонента.
task_daemon.http_request_executor_timeout

Таймаут в секундах HTTP-запросов при выполнении задач http_request TaskDaemon.
task_daemon.systemd_service

Название сервиса systemd компонента.
task_daemon.tasks_check_period_sec

Периодичность проверки TaskDaemon наличия новых задач.
task_daemon.version

Версия компонента.

utilizer#

Раздел utilizer содержит настройки взаимодействия с utilizer.

utilizer.api_health_postfix

Маршрут для проверки состояния компонента.
utilizer.basic_auth_password

Пароль BasicAuth для HTTP-запросов к компоненту.

Значение хранится в Ansible Vault.
utilizer.basic_auth_username

Имя пользователя BasicAuth для HTTP-запросов к компоненту.
utilizer.component_name

Название компонента.
utilizer.config_filepath

Путь к файлу конфигурации компонента.
utilizer.env_filepath

Путь к файлу с переменными, управляющими работой компонента.
utilizer.host

Адрес для HTTP-запросов к компоненту.
utilizer.port

Порт для HTTP-запросов к компоненту.
utilizer.protocol

Протокол HTTP-сервера компонента.
utilizer.request_timeout

Таймаут HTTP-запросов к компоненту в секундах.
utilizer.route_prefix

Префикс для добавления ко всем путям, обрабатываемым HTTP-сервером.
utilizer.systemd_service

Название сервиса systemd компонента.
utilizer.tls_ca_file

Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту.
utilizer.tls_cert_file

Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
utilizer.tls_insecure_skip_verify

Пропуск проверки TLS при HTTP-запросах к компоненту.
utilizer.tls_key_file

Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
utilizer.version

Версия компонента.
utilizer.web_config_file

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

victorialogs#

Раздел victorialogs содержит настройки взаимодействия с VictoriaLogs.

victorialogs.api_health_postfix

Маршрут для проверки состояния компонента.
victorialogs.basic_auth_password

Пароль BasicAuth для HTTP-запросов к компоненту.

Значение хранится в Ansible Vault.
victorialogs.basic_auth_username

Имя пользователя BasicAuth для HTTP-запросов к компоненту.
victorialogs.component_name

Название компонента.
victorialogs.host

Адрес для HTTP-запросов к компоненту.
victorialogs.internal

Размещение сервера VictoriaLogs:
- true – используется сервер, развёрнутый средствами платформы;
- false – используется внешний сервер.
victorialogs.internal_port

Порт для подключения к серверу VictoriaLogs, развёрнутому средствами платформы.
victorialogs.port

Порт для внешних HTTP-запросов к компоненту.
victorialogs.protocol

Протокол HTTP-сервера компонента.
victorialogs.request_timeout

Таймаут HTTP-запросов к компоненту в секундах.
victorialogs.route_prefix

Префикс для HTTP-запросов к компоненту.
victorialogs.syslog_port

Порт для подключения к rsyslog.
victorialogs.systemd_service

Название сервиса systemd компонента.
victorialogs.tls_ca_file

Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту.
victorialogs.tls_cert_file

Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
victorialogs.tls_insecure_skip_verify

Пропуск проверки TLS при HTTP-запросах к компоненту.
victorialogs.tls_key_file

Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
victorialogs.version

Версия компонента.

victoriametrics#

Раздел victoriametrics содержит настройки взаимодействия с VictoriaMetrics.

victoriametrics.api_health_postfix

Маршрут для проверки состояния компонента.
victoriametrics.basic_auth_password

Пароль BasicAuth для HTTP-запросов к компоненту.

Значение хранится в Ansible Vault.
victoriametrics.basic_auth_username

Имя пользователя BasicAuth для HTTP-запросов к компоненту.
victoriametrics.binary_filepath

Полный путь к исполняемому файлу VictoriaMetrics (не используется).
victoriametrics.component_name

Название компонента.
victoriametrics.config_filepath

Путь к файлу конфигурации VictoriaMetrics.
victoriametrics.env_filepath

Путь к файлу с переменными, управляющими работой компонента.
victoriametrics.host

Адрес для HTTP-запросов к компоненту.
victoriametrics.internal

Размещение сервера VictoriaMetrics:
- true — используется сервер, развёрнутый средствами платформы;
- false — используется внешний сервер.
victoriametrics.internal_port

Порт для подключения к серверу VictoriaMetrics, развёрнутому средствами платформы.
victoriametrics.paks_config_dirpath

Путь к директории с файлами таргетов объектов ПАК (узлы, ВМ) для опроса plagent’а VictoriaMetrics.
victoriametrics.port

Порт для внешних HTTP-запросов к компоненту.
victoriametrics.protocol

HTTP-протокол для взаимодействия с компонентом.
victoriametrics.query_max_series

Максимально допустимое количество серий в запросе к VictoriaMetrics через эндпоинт /vision/api/v1/query_range, используемый конструктором выражений в интерфейсе.
victoriametrics.request_timeout

Таймаут HTTP-запросов к компоненту в секундах.
victoriametrics.retention_period

Срок хранения данных.
victoriametrics.route_prefix

Префикс для HTTP-запросов к компоненту.
victoriametrics.systemd_service

Название сервиса systemd компонента.
victoriametrics.tls_ca_file

Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту.
victoriametrics.tls_cert_file

Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
victoriametrics.tls_insecure_skip_verify

Пропуск проверки TLS при HTTP-запросах к компоненту.
victoriametrics.tls_key_file

Путь к файлу ключа сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
victoriametrics.version

Версия компонента.

vision_api#

Раздел vision_api содержит настройки взаимодействия с API vision_core.

vision_api.component_name

Название компонента.
vision_api.config_filepath

Путь к файлу конфигурации Vision Core.
vision_api.host

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

Порт для прослушивания входящих HTTP-запросов.
vision_api.protocol

Протокол запуска сервера.
vision_api.reload

Авто перезагрузка Uvicorn.
vision_api.route_prefix

Префикс для добавления ко всем путям, обрабатываемым HTTP-сервером.
vision_api.systemd_service

Название сервиса systemd.
vision_api.task_completion_postfix

API URL для уведомлений от TaskDaemon о завершенных задачах.
vision_api.tls_ca_file

Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту.
vision_api.tls_cert_file

Путь к файлу с сертификатом TLS сервера.
vision_api.tls_key_file

Путь к файлу с ключом TLS сервера.

vmalert#

Раздел vmalert содержит настройки взаимодействия с vmalert_st.

vmalert.alerting_rules_filename

Первая часть имени файла для правил оповещения.
vmalert.api_health_postfix

Маршрут для проверки состояния компонента.
vmalert.api_reload_postfix

Маршрут перезагрузки компонента.
vmalert.basic_auth_password

Пароль BasicAuth для HTTP-запросов к компоненту.

Значение хранится в Ansible Vault.
vmalert.basic_auth_username

Имя пользователя BasicAuth для HTTP-запросов к компоненту.
vmalert.binary_filepath

Путь к исполняемому файлу VMAlert.
vmalert.component_name

Название компонента.
vmalert.config_files.env_filepath

Путь к файлу с переменными, управляющими работой компонента.
vmalert.config_files.notifier_config_filepath

Путь к YAML-файлу с настройками отправки уведомлений.
vmalert.evaluation_interval

Интервал оценки правил в секундах.
vmalert.host

Адрес для HTTP-запросов к компоненту.
vmalert.logging.audit_log_filepath

Путь к файлу аудита компонента.
vmalert.port

Порт для HTTP-запросов к компоненту.
vmalert.protocol

Протокол HTTP-сервера компонента.
vmalert.recording_rules_filename

Первая часть имени файла для правил записи.
vmalert.request_timeout

Таймаут HTTP-запросов к компоненту в секундах.
vmalert.route_prefix

Префикс для HTTP-запросов к компоненту.
vmalert.rules_dir

Директория с файлами правил записи и оповещения VMAlert.
vmalert.systemd_service

Название сервиса systemd компонента.
vmalert.tls_ca_file

Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту.
vmalert.tls_cert_file

Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
vmalert.tls_insecure_skip_verify

Пропуск проверки TLS при HTTP-запросах к компоненту.
vmalert.tls_key_file

Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
vmalert.version

Версия компонента.

vmalert_external_integration#

Раздел vmalert_external_integration содержит настройки интеграции с внешним vmalert.

vmalert_external_integration.auth.password

Пароль для подключения к vmalert.

Значение хранится в Ansible Vault.
vmalert_external_integration.auth.type

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

Значение disabled отключает аутентификации.
vmalert_external_integration.auth.username

Имя пользователя для подключения к vmalert.
vmalert_external_integration.enabled

Использование внешней интеграции vmalert.
vmalert_external_integration.tls.ca_file

Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту.
vmalert_external_integration.tls.cert_file

Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
vmalert_external_integration.tls.enabled

Использование TLS для защиты подключения к компоненту.
vmalert_external_integration.tls.key_file

Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
vmalert_external_integration.tls.server_name

Доменное имя сервера, используемое при проверке TLS-сертификата.
vmalert_external_integration.tls.skip_verify

Пропуск проверки TLS при HTTP-запросах к компоненту.
vmalert_external_integration.url

Полный URL для отправки оповещений до эндпоинта API v2 Alertmanager (или аналогичного), например:
```
https://127.0.0.1:9999/vision/alertmanager/api/v2/alerts
```

vmalert_vl#

Раздел vmalert_vl содержит настройки взаимодействия с VMAlert_VL.

vmalert_vl.alerting_rules_filename

Первая часть имени файла для правил оповещения.
vmalert_vl.api_health_postfix

Маршрут для проверки состояния компонента.
vmalert_vl.api_reload_postfix

Маршрут перезагрузки компонента.
vmalert_vl.basic_auth_password

Пароль BasicAuth для HTTP-запросов к компоненту.

Значение хранится в Ansible Vault.
vmalert_vl.basic_auth_username

Имя пользователя BasicAuth для HTTP-запросов к компоненту.
vmalert_vl.binary_filepath

Путь к исполняемому файлу VMAlert_VL.
vmalert_vl.component_name

Название компонента.
vmalert_vl.config_files.env_filepath

Путь к файлу с переменными, управляющими работой компонента.
vmalert_vl.config_files.notifier_config_filepath

Путь к YAML-файлу с настройками отправки уведомлений.
vmalert_vl.evaluation_interval

Интервал оценки правил в секундах.
vmalert_vl.host

Адрес для HTTP-запросов к компоненту.
vmalert_vl.logging.audit_log_filepath

Путь к файлу аудита компонента.
vmalert_vl.port

Порт для HTTP-запросов к компоненту.
vmalert_vl.protocol

Протокол HTTP-сервера компонента.
vmalert_vl.recording_rules_filename

Первая часть имени файла для правил записи.
vmalert_vl.request_timeout

Таймаут HTTP-запросов к компоненту в секундах.
vmalert_vl.route_prefix

Префикс для HTTP-запросов к компоненту.
vmalert_vl.rules_dir

Путь к директории с правилами записи и оповещения VMAlert_VL.
vmalert_vl.systemd_service

Название сервиса systemd компонента.
vmalert_vl.tls_ca_file

Путь к файлу TLS CA, который будет использоваться для проверки подключений к компоненту.
vmalert_vl.tls_cert_file

Путь к файлу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
vmalert_vl.tls_insecure_skip_verify

Пропуск проверки TLS при HTTP-запросах к компоненту.
vmalert_vl.tls_key_file

Путь к ключу сертификата TLS на стороне клиента, который будет использоваться при подключении к компоненту.
vmalert_vl.version

Версия компонента.