Skip to main content

Конфигурирование

Конфигурация в Windows осуществляется через файл .env. Конфигуряция в Linux осуществляетв через файл .env ИЛИ через переменные среды (файл .env имеет больший приоритет).

Файл .env должен располагаться в одном каталоге с запускаемым файлом агента. В файле .env задаются параметры агента в формате ИМЯ_ПАРАМЕТРА=ЗНАЧЕНИЕ_ПАРАМЕТРА. Каждый параметр должен быть описан в отдельной строке (1 параметр - 1 строка).

Параметры агента:

  • CFG_API_PORT - порт на котором запускается агент. По умолчанию - 8080

  • CFG_RPC_PORT - порт на котором запускается сервер управления агентом. По умолчанию - 8090

  • CFG_AGENT_DEVICES_LOGS_ENABLED - Флаг сбора логов у устройств (devices_logs)

  • CFG_RPC_COMMAND_TIMEOUT - таймаут в секундах для команд на сервер управления агентом. По умолчанию - 60

  • CFG_LOGGING_LEVEL - уровень логирования агента. По умолчанию - INFO

  • CFG_COLLECTOR_SERVICE_BASE - адрес публикации сервиса интеграции (общий порт). По умолчанию - http://127.0.0.1:8080

  • CFG_COLLECTOR_SERVICE_DATA - адрес публикации сервиса интеграции (порт для метрик). По умолчанию - http://127.0.0.1:8084

  • CFG_AGENT_CHECK_CRON - "cron" расписание для отправки состояния агента и получения команд. По умолчанию - */5 * * * *

  • CFG_AGENT_METRICS_UPLOAD_CRON - "cron" расписание для загрузки метрик в сервис интеграции. По умолчанию - 5,20,35,50 * * * *

  • CFG_AGENT_METRICS_UPLOAD_LIMIT - максимальное кол-во передаваемых метрик в запросе в сервис интеграции. По умолчанию - 100

  • CFG_AGENT_METRICS_COLLECT_PASSIVE - "cron" расписание для опроса пассивных устройств. По умолчанию - 0 */1 * * *

  • CFG_AGENT_DEVICES_CRON - "cron" расписание для обновления информации об устройствах от сервиса интеграции. По умолчанию - 0 */1 * * *

  • CFG_AGENT_TOKEN - токен авторизации агента (получение токена агента описано ниже). Значение по умолчанию не задано;

  • CFG_AGENT_HOST_ALIASES - алиасы агента (агентов) для настройки на устройствах: external - адрес, устанавливаемый на устройстве. По умолчанию - []

  • CFG_AGENT_UPGRADE_AUTO - флаг автоматического обновления агента (только windows сборка). По умолчанию - 1

  • CFG_AGENT_UPGRADE_AUTO_CRON - "cron" расписание для автоматического обновления агента. По умолчанию - */30 1-6 * * *

  • CFG_AGENT_UPGRADE_FTP_HOST - адрес фтп сервера для автоматического обновления агента. По умолчанию - localhost:21

  • CFG_AGENT_UPGRADE_FTP_USER - имя пользователя фтп сервера для автоматического обновления агента. По умолчанию не задано

  • CFG_AGENT_UPGRADE_FTP_PASSWORD - пароль фтп сервера для автоматического обновления агента. По умолчанию не задано

  • CFG_AGENT_UPGRADE_FTP_PATH - путь директории на фтп сервере для автоматического обновления агента. По умолчанию - /

  • CFG_AGENT_PERCENT_INCORRECT_DEVICES_FOR_ERROR - процент неактивных устройств, при котором агент отчитается сервису об ошибке. По умолчанию - 50

  • CFG_AGENT_MAX_DEVICE_INACTIVITY_TIMEOUT - максимальное время бездействия активного устройства. По умолчанию - 60

  • CFG_INSTANCE_ID - Опциональный параметр,  Id запущенного агента, необходимо при использовании нескольких экземпляров агента (может быть строкой, не использовать кириллицу и пробелы). Важно заполнять этот параметр ДО установки экземпляра агента.
  • CFG_INSTANCE_DESCRIPTION - Опциональный параметр,  дополнение к описанию запущенного агента (Отображается в службах, не использовать кириллицу)

 

При конфигурировании .env файла по дефолту будет использоваться СУБД sqlite, но есть возможность использовать Postgres

  • CFG_POSTGRES_MODE - активация использования СУБД PostgreSQL (1 - активно, 0 - используем sqlite)

     

  • CFG_POSTGRES_DB - имя БД
  • CFG_POSTGRES_USER - имя пользователя БД
  • CFG_POSTGRES_PASSWORD - пароль от БД
  • CFG_POSTGRES_PORT - порт для подключения
  • CFG_POSTGRES_HOST - хост

Также дополнительные параметры настройки postgres описаны тут

При возникновении следующей ошибки следует проверить логин, пароль и имя самой БД
Screenshot from 2024-08-16 12-06-33.png

Для конфигурации режима прокси в .env файле необходимо добавить параметры:

  • CFG_PROXY_CRON  -  */20 * * * * (Раз в какой тайминг перезапускать все соединения)
  • CFG_PROXY_HOST - host
  • CFG_PROXY_MODE - 1
  • CFG_PROXY_PATH - /app/agent.data/key (ssh ключ агента)
  • CFG_PROXY_USER - user

 

Возможна конфигурация агента через веб интерфейс. Такой вид конфигурации доступен только на запущенном агенте.

Для запуска конфигурации необходимо зайти на страницу http://127.0.0.1:CFG_API_PORT/config

Где CFG_API_PORT - это порт на котором запущен агент.

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

http://127.0.0.1:CFG_API_PORT/config?full_config=true

Агент принимает запросы только локальные запросы (из той же системы на которой сам установлен)

 

No Comments
Back to top