Установка ЕдиногоАгента на Windows

Материал из Документация Ключ-АСТРОМ

Требования к файлам и дисковому пространству ЕдиногоАгента в Windows

На этой странице представлена ​​информация о структуре директории ЕдиногоАгента и требованиях к дисковому пространству для установки ЕдиногоАгента full-stack и обновлений. Обратите внимание, что точные значения могут различаться в зависимости от версии ЕдиногоАгента.

Режим полного стека и мониторинга инфраструктуры

Требования к дисковому пространству одинаковы для режимов мониторинга Full-stack и Infrastructure.

Директории ЕдиногоАгента и их размеры

Директория по умолчанию Возможность изменения
Размер установки (с удаленными временными файлами установки) ~775 МБ %PROGRAMFILES%\astromkey\oneagent Да 1
Постоянная конфигурация ~10 МБ %PROGRAMDATA%\astromkey\oneagent\agent\config Нет
Временные файлы, конфигурация времени выполнения 200 МБ %PROGRAMDATA%\astromkey\oneagent\agent\runtime Нет
Логи 1 ГБ %PROGRAMDATA%\astromkey\oneagent\log Да 2
Отчеты о сбоях, дампы памяти 3 ГБ %PROGRAMDATA%\astromkey\oneagent\datastorage Да 3
Файл сохранения повторной передачи логов EEC 600 МБ + 1,5 ГБ резерва %PROGRAMDATA%\astromkey\oneagent\agent\runtime\extensions\persistence Да 4 5
Дополнительное место для обновлений ~3,4 ГБ См. Необходимое место для обновлений (ниже)
Всего ~10,5 ГБ

1 Используйте параметр установки INSTALL_PATH.

2 Используйте параметр установки LOG_PATH.

3 Используйте параметр установки DATA_STORAGE.

4 Применимо только если вы используете расширения Ключ-АСТРОМ, которые определяют метрики логов, события или добавляют собственные правила обработки логов. Можно изменить с помощью запроса в службу поддержки.

5 Механизм надежности не работает, если требование не выполняется.

Полный список файлов и директорий, добавленных в вашу систему ЕдиногоАгента, см. в разделе Безопасность ЕдиногоАгента в Windows (ниже).

Механизм устаревания файлов ЕдиногоАгента

ЕдиныйАгент в режиме мониторинга полного стека использует встроенный механизм устаревания, чтобы гарантировать, что файлы ЕдиногоАгента, включая файлы логов и данные времени выполнения, поддерживаются в разумных пределах. Для получения дополнительной информации см. Механизм устаревания файлов ЕдиногоАгента.

Необходимое место для обновлений

При расчете необходимого для обновлений пространства мы учитываем размер сжатого EXE-файла установщика, извлеченного MSI-пакета и размер процесса установки (пространство, необходимое для развертывания файлов ЕдиногоАгента).

Размер Описание Удаляется после Устанавливается с Путь
1 ~130 МБ Установщик EXE, загруженный AutoUpdate Перезапуск OneAgent или установка следующей версии 1 Автообновление %PROGRAMDATA%\astromkey\oneagent
2 ~750 МБ Извлеченный установщик MSI Конец установки Установка ЕдиногоАгента %PROGRAMDATA%\astromkey\oneagent
3 ~750 МБ Дополнительное хранилище для временных установочных файлов Конец установки Установка ЕдиногоАгента %APPDATA%
4 ~750 МБ Копия установщика MSI, сохраненная Windows Установка следующей версии Установщик Windows %WINDIR%\Installer
5 ~750 МБ Установленные файлы Установка следующей версии Установка Windows [Installation path]
Σ ~3130 МБ

1 Если вы загрузите EXE-установщик вручную, процесс установки не удалит его.

Дополнительное пространство, необходимое для установки и обновлений, рассчитывается с учетом 10% запаса :

(size of the installation process [2+3+4+5] + installer files size [1]) * 1.1

Требуемое дисковое пространство для установки и обновления ЕдиногоАгента на одном диске составляет ~3,4 ГБ, рассчитанное по этой формуле.

Обратите внимание, что установщик EXE сжат, что объясняет разницу в размере по сравнению с установщиком MSI.

С точки зрения требований к пространству, нет никакой реальной разницы между ручной установкой новой версии (когда старая версия уже установлена), автоматическим обновлением и обновлениями, которые запускаются путем перезапуска контейнера ЕдиногоАгента. Во всех этих случаях процесс установки выполняется абсолютно одинаково. Отличается лишь метод, с помощью которого запускается обновление.

Подробности сохранения

Механизм надежности обеспечивает сохранение логов Extension Execution Controller (EEC) в случае недоступности АктивногоШлюза или ЕдиногоАгента, возникновения сетевых проблем или перегрузки EEC при приеме данных. Благодаря механизму надежности мы можем минимизировать пробелы в покрытии логов.

Общая информация

  • сохранение работает по умолчанию, если соблюдено требование к объему - 2136 МБ
    • 600 МБ свободного дискового пространства для использования механизмом надежности
    • дополнительно 1,5 ГБ свободного места на диске в качестве буфера (не используется механизмом обеспечения надежности)
  • требование периодически проверяется, и если оно не выполняется, сохранение будет отключено — прием логов будет передан без механизма обеспечения надежности
  • объем используется пропорционально
  • Если требование не может быть выполнено на хосте, можно скорректировать конфигурацию сохранения логов

Конфигурация

Файл конфигурации Windows : C:\ProgramData\astromkey\remotepluginmodule\agent\conf\extensionsuser.conf

Файл конфигурации Linux : /var/lib/astromkey/remotepluginmodule/agent/conf/extensionsuser.conf

Переменная Описание
persistence.reliable_mode true- включен надежный режим; логи SFM генерируются, если требования к пространству не выполняются

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

persistence.total_limit_kb Максимальный предел объема для Extensions Log Persistence в килобайтах. По умолчанию: 600 МБ Может быть изменен вручную, если требование не может быть выполнено на хосте.

Безопасность ЕдиногоАгента в Windows

Для полной автоматизации мониторинга ваших операционных систем, процессов и сетевых интерфейсов Ключ-АСТРОМ требуется привилегированный доступ к вашей операционной системе как во время установки, так и во время работы.

ЕдиныйАгент тщательно протестирован, чтобы гарантировать минимальное влияние на производительность вашей системы и соответствие самым высоким стандартам безопасности .

Разрешения

Для установки и работы ЕдиногоАгента требуются права администратора в Windows.

Установка

Установщику ЕдиногоАгента требуются права администратора для:

  • Создания службы ЕдиногоАгента.
  • Изменения определенных ключей реестра.
  • Установки драйвера захвата пакетов (Npcap или WinPcap) для сбора метрик сети.
  • Установки устройства oneagentmon.

Операции

ЕдиныйАгент требует права администратора для:

  • Перечислить все процессы.
  • Получить статистику памяти для всех процессов.
  • Прочитать каждую командную строку процесса и среду.
  • Просмотреть описания исполняемых файлов.
  • Прочитать конфигурации приложения для Apache и IIS
  • Просмотреть список библиотек, загруженных для каждого процесса.
  • Прочитать ключи реестра Windows.
  • Прочитать раздел «Домен приложения .NET» для .NET 2.0, 3.0 и 3.5.
  • Начать мониторинг сетевого трафика.
  • Анализировать исполняемых файлов для Go Discovery.
  • Собирать данные мониторинга, связанные с контейнерами Docker.

Изменения операционной системы

ЕдиныйАгент вносит следующие изменения в вашу систему:

Установка

Установщик ЕдиногоАгента изменяет следующие аспекты вашей системы:

  • Начиная с версии 1.195, для запуска расширений ЕдиногоАгента не создается учетная запись пользователя. Вместо этого используется привилегированная системная учетная запись NT AUTHORITY\SYSTEM.
  • Саздание службы astromkey OneAgent.
  • Программа Ключ-АСТРОМ ЕдиныйАгент зарегистрирована в установщике Windows.
  • Драйвер oneagentmon установлен и устройство OneAgentMon создано. Требуется для включения автоматического внедрения в процессы.
  • Создаются подреестры:
    • HKEY_LOCAL_MACHINE\SOFTWARE\astromkey\OneAgent
    • HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\oneagentmon
    • HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\astromkey OneAgent
    • HKEY_LOCAL_MACHINE\SOFTWARE\Caphyon\Advanced Installer
  • Устранение неполадок: сбой инициализации сетевого агента в Windows
  • Драйвер Npcap устанавливается с установленным флагом /admin_only, который ограничивает чтение и запись пакетов Npcap только пользователями с привилегиями администратора. Непривилегированные пользователи не могут получить доступ к функциональным возможностям Npcap на контролируемом хосте. Обратите внимание, что WinPcap не предлагает такого ограничения. Для получения дополнительной информации см. раздел Настройка установки OneAgent в Windows (ниже). Убедитесь, что эти операции Npcap и WinPcap разрешены в настройках безопасности вашей системы:
    • Npcap: Запись значений реестра в SYSTEM\CurrentControlSet\Services\npcap
    • Npcap: Чтение и запись значений реестра в SOFTWARE\WOW6432Node\Microsoft\Windows\CurrentVersion\Uninstall\NpcapInst
    • Winpcap: Чтение и запись значений реестра SOFTWARE\WOW6432Node\Microsoft\Windows\CurrentVersion\Uninstall\WinPcapInstвSOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\WinPcapInst
    • Npcap и Winpcap: Загрузка wpcap.dll и packet.dll расположенных в C:\WINDOWS\system32\Npcap/C:\WINDOWS\system32\WinPcap
    • Npcap и Winpcap: Чтение значений реестра, касающихся текущих сетевых интерфейсов в *SYSTEM\CurrentControlSet\Control\Network\{Network-Service-GUID}

Добавленные файлы

Установка

Установщик ЕдиногоАгента добавляет в вашу систему следующие файлы:

  • Двоичные файлы и файлы конфигурации ЕдиногоАгента сохраняются в %PROGRAMFILES%\astromkey\oneagent. Обратите внимание, что вы можете изменить местоположение с помощью параметра INSTALL_PATH.
  • Временные файлы установщика сохраняются в C:\AI_RecycleBin. Папка удаляется после завершения установки.

Операция

  • Временные файлы ЕдиногоАгента и конфигурация среды выполнения сохраняются в формате %PROGRAMDATA%\astromkey\oneagent\runtime.
  • Постоянная конфигурация ЕдиногоАгента сохраняется в файле %PROGRAMDATA%\astromkey\oneagent\config.
  • Большие данные времени выполнения, такие как дампы памяти, сохраняются в %PROGRAMDATA%\astromkey\oneagent\datastorage. Обратите внимание, что вы можете изменить расположение больших данных времени выполнения с помощью параметра DATA_STORAGE.

Системные логи, загружаемые ЕдинымАгентом

ЕдиныйАгент загружает системные логи Security, System и Application за последние 14 дней, чтобы Ключ-АСТРОМ мог диагностировать проблемы, которые могут быть вызваны условиями в вашей среде. Чаще всего такие проблемы связаны с глубоким мониторингом или автоматическими обновлениями.

Отзыв доступа к системным логам

Чтобы отменить доступ к системным логам, используйте команду oneagentctl с параметром --set-system-logs-access-enabled, установленным на false.

Глобально доступные для записи директории

Структура директорий ЕдиногоАгента содержит глобально доступные для записи каталоги (директории Everyone, в которых группа пользователей может писать, изменять или выполнять). Изменение этих разрешений пользователями не поддерживается.

Механизм внедрения ЕдиногоАгента

Такие разрешения на выбранный набор директорий необходимы для успешного внедрения ЕдиногоАгента в процессы на контролируемых хостах. Когда ЕдиныйАгент внедряется в процесс, модуль кода, отвечающий за внедрение, запускается в контексте исходного внедренного процесса. Следовательно, пользователи, под которыми запускаются эти процессы, должны иметь разрешение на запись в структуру директорий ЕдиногоАгента, что является причиной глобальных разрешений на запись, которые это разрешают.

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

Безопасность системы

Мы знаем, что глобальные разрешения на чтение и запись в директорий ЕдиногоАгента помечаются в сканировании безопасности, но мы можем заверить вас, что они полностью защищены.

  • Мы стараемся максимально ограничить количество директорий, доступных для глобальной записи.
  • Мы используем расширенные права доступа к файлам Creator Owner и используем их для ограничения доступа к файлам.

Подписи установщика

Установщик ЕдиногоАгента подписан одним или несколькими корневыми сертификатами DigiCert. Для регулярно обслуживаемых систем Windows проверяет, что установщик ЕдиногоАгента был опубликован проверенным издателем.

Если ваша система на базе Windows была отключена с марта 2021 года или дольше, Windows не сможет проверить установщик, а издатель установщика ЕдиногоАгента будет отображаться как Неизвестный издатель при попытке установки или обновления. В таком случае вам необходимо загрузить последний сертификат из корневых сертификатов DigiCert и добавить его в свою систему. Среди всех сертификатов DigiCert обязательным для успешной проверки установщика ЕдиногоАгента является DigiCert Global Root G3.

Windows 2008 R2

Начиная с версии ЕдиногоАгента 1.225, установщик подписан с использованием алгоритма SHA-2. Следовательно, хосты Windows 2008 R2 должны иметь установленную поддержку подписи кода SHA-2. Если вы используете Центр обновления Windows, обновления были предложены вам автоматически (KB4474419 и KB4490628). Однако, если ваша система Windows 2008 R2 не поддерживает проверку установщиков, подписанных SHA-2, автоматическое обновление и установка ЕдиногоАгента не будут работать, если настроена блокировка неизвестных издателей Applocker и/или могут отображаться предупреждения безопасности. Для получения дополнительной информации см. Требование поддержки подписи кода SHA-2 Microsoft 2019 для Windows и объявление WSUS.

Установка ЕдиногоАгента на Windows

На этой странице описывается, как загрузить и установить Ключ-АСТРОМ ЕдиныйАгент в Windows.

  • Если вы являетесь клиентом Ключ-АСТРОМ SaaS, перейдите на сайт Ключ-АСТРОМ, войдите в систему, используя имя пользователя и пароль, полученные от Ключ-АСТРОМ в электронном письме с подтверждением регистрации.
  • Если вы являетесь клиентом Ключ-АСТРОМ Managed, откройте консоль управления кластером и выберите среду, которую вы хотите отслеживать.

Затем продолжите установку, следуя инструкциям ниже.

Требования и предустановка

  • Вам потребуются права администратора для серверов, на которых будет установлен ЕдиныйАгент, а также для изменения настроек брандмауэра (необходимо только в том случае, если ваша внутренняя политика маршрутизации может помешать программному обеспечению Ключ-АСТРОМ выйти в Интернет).
  • Для перезапуска всех служб приложений вам потребуются разрешения и учетные данные.
  • Вам также необходимо проверить требования к свободному месту на диске.
  • Хост, на котором устанавливается ЕдиныйАгент, должен иметь не менее 200 МБ оперативной памяти.
  • Установка ЕдиногоАгента не поддерживается в точках монтирования сетевых хранилищ, которые управляются такими стандартами, как NFS или iSCSI.
  • Все хосты, которые должны отслеживаться, должны иметь возможность отправлять данные в кластер Ключ-АСТРОМ. В зависимости от того, развернут ли ваш Ключ-АСТРОМ на SaaS или в управляемой среде, а также от вашей сетевой структуры и настроек безопасности, вы можете либо предоставить прямой доступ к кластеру Ключ-АСТРОМ, либо настроить АктивныйШлюз .
  • Для ЕдиногоАгента версии 1.253 и более ранних версий мы рекомендуем вам удалить все существующие драйверы WinPcap, чтобы разрешить установку Npcap — сделайте это во всех версиях Windows, кроме Windows Server 2019 build 1809 without hotfix KB4571748.
    Для ЕдиногоАгента версии 1.255+ Npcap устанавливается по умолчанию и может вызвать сбой сети на Windows Server 2016, Windows Server 2019 build 1809и Windows Server 2019 build 1809 without hotfix KB4571748. Чтобы предотвратить это, обновите свои хосты с помощью исправления KB4571748 или используйте другие задокументированные варианты .

Разрешить соединения через брандмауэр

Убедитесь, что настройки вашего брандмауэра разрешают связь с Ключ-АСТРОМ.

В зависимости от политики вашего брандмауэра вам может потребоваться разрешить определенные исходящие соединения. Удаленные адреса Ключ-АСТРОМ для добавления в список разрешенных указаны на странице установки ЕдиногоАгента.

Удалите драйвер WinPcap, чтобы разрешить установку Npcap.

Если у вас установлен драйвер WinPcap, мы рекомендуем вам удалить его перед установкой ЕдиногоАгента и позволить установщику ЕдиногоАгента установить соответствующий драйвер захвата пакетов, входящий в комплект установщика ЕдиногоАгента: Npcap— рекомендуемый драйвер захвата пакетов для ЕдиногоАгента.

Npcap является преемником WinPcap и лучше всего подходит для сетевого анализа Ключ-АСТРОМ. Драйвер Npcap, предоставляемый вместе с установщиком ЕдиногоАгента, упакован таким образом, что его файлы библиотеки DLL интегрируются с программным обеспечением Ключ-АСТРОМ, что позволяет выполнять обновления без вмешательства оператора.

Более подробную информацию см. здесь:

  • Безопасность ЕдиногоАгента в Windows (выше)
  • Настройте установку OneAgent в Windows (ниже)

Во время обновления с WinPcap до Npcap вы можете столкнуться с сетевыми сбоями, которые можно устранить, обновив версию Windows Server и/или отключив Microsoft Network Monitor Driver. Для получения более подробной информации см. Возможные сетевые сбои во время установки ЕдиногоАгента в Windows (ниже)

Переустановка или восстановление установки

Установщик ЕдиногоАгента для Windows не поддерживает операции modify и repair. Вы не можете переустановить ЕдиныйАгент, используя ту же версию установщика, которая использовалась для установки текущего установленного ЕдиногоАгента. Чтобы переустановить ЕдиныйАгент, сначала удалите его или просто установите более новую версию.

Установка

  1. В Ключ-АСТРОМ выберите Установить мониторинг.
  2. Выберите Загрузить установщик > Windows.
  3. Предоставьте токен PaaS. Токен необходим для загрузки установщика ЕдиногоАгента из вашей среды. Если у вас нет токена PaaS, вы можете сгенерировать его прямо в пользовательском интерфейсе. Токен автоматически добавляется к команде загрузки, которую вы будете использовать позже.
  4. Загрузите установщик. Есть два варианта:
    • Выберите Скачать установщик ЕдиногоАгента, чтобы загрузить установщик для Windows (EXE-файл) для установки на одном сервере.
    • Загрузите через командную строку Windows. Скопируйте и выполните команду powershell. Она генерируется автоматически при предоставлении токена PaaS.
      Эта команда будет работать только с PowerShell 3.0 и TLS 1.2 (или более поздней версией).
  5. необязательный Настройте свою установку На этом этапе пользовательский интерфейс Ключ-АСТРОМ позволяет вам настроить установку ЕдиногоАгента: Вы можете указать ряд настроек интерактивно на экране. На основе ваших записей будет сгенерирована и отображена команда установки для использования на следующем этапе установки (см. ниже). Вы можете:
    • Установите сетевую зону для этого хоста.
    • Если ваша среда сегментирована (например, на разработку и производство), организуйте хосты в группы хостов .
    • Переопределить автоматически обнаруженное имя хоста. Это полезно в больших и динамических средах, где определенные имена хостов могут быть неинтуитивными или могут часто меняться.
    • Применяйте теги к хосту, чтобы осмысленно организовать контролируемые среды.
    • Измените режим ЕдиногоАгента на Infrastructure Monitoring или Discovery вместо Full-Stack Monitoring.
    • Отключить мониторинг логов.
      Если требуются дополнительные настройки, вы можете указать дополнительные параметры в командной строке .
  6. Если вы не указали никаких пользовательских параметров, просто запустите исполняемый файл и следуйте инструкциям, как показано. Если вы указали пользовательские параметры выше, используйте сгенерированную команду и запустите ее из директории загрузки. Команда будет содержать все параметры установки, отражающие указанные вами пользовательские настройки.
  7. Перезапустите все процессы, которые вы хотите отслеживать. Вам будет предложен список процессов, которые необходимо перезапустить. Обратите внимание, что вы можете перезапустить свои процессы в любое время, даже во время следующего запланированного периода обслуживания вашей организации. Хотя до тех пор, пока все процессы не будут перезапущены, вы увидите только ограниченный набор метрик, например, потребление ЦП или памяти.

Получение пакета MSI

Если вы хотите использовать групповую политику для автоматического распространения ЕдиногоАгента на ваши хосты Windows, вам понадобится пакет MSI вместе с пакетным файлом. Чтобы получить пакет MSI:

  1. Загрузите установщик ЕдиногоАгента, предоставленный в виде EXE-файла.
  2. Запустите его с параметром --unpack-msi. Это извлечет пакет MSI и установочный пакетный файл. При желании вы можете указать существующий путь. Если вы пропустите путь, файлы будут сохранены в рабочем каталоге. Например: C:\Downloads\astromkey-OneAgent-Windows.exe --unpack-msi "C:\installers"

При использовании параметра --unpack-msi не допускаются никакие другие параметры установки. Добавьте параметр --quiet для запуска извлечения пакета MSI в тихом режиме. Используйте параметр --help для отображения всплывающего окна со списком доступных параметров.

Скопируйте и вставьте пакет MSI и пакетный файл при настройке групповой политики для установки Ключ-АСТРОМ. Установка по умолчанию должна работать в большинстве случаев, но если вам нужно настроить ее, вы можете изменить параметры установки. Затем вам нужно создать точку распространения, назначить пакет (пакет MSI ЕдиныйАгент с параметрами), указать команду для установки пакета MSI в режиме тихой установки и опубликовать свою политику.

Что происходит во время установки?

ЕдиныйАгент — это набор специализированных служб, которые были настроены специально для вашей среды мониторинга. Роль этих служб заключается в мониторинге различных аспектов ваших хостов, включая оборудование, операционную систему и процессы приложений.

В процессе установки установщик:

  • Устанавливает исполняемый код и библиотеки, используемые ЕдинымАгентом.
  • Создает записи в реестре Windows, которые запускают ЕдиныйАгент как службу SYSTEM. Кроме того, устройство oneagentmon и (опционально) Npcap или WinPcap устанавливаются для лучшей интеграции с операционной системой и для облегчения сбора сетевой статистики.
  • Проверяет глобальные настройки прокси-сервера системы.
  • Проверяет наличие соединения с Ключ-АСТРОМ Server или АктивнымШлюзом (если вы установили АктивныйШлюз и загрузили установщик ЕдиногоАгента после подключения АктивногоШлюза к Ключ-АСТРОМ).
  • ЕдиныйАгент версии 1.193 и более ранних Создает собственного пользователя (dtuser) для запуска расширений ЕдиногоАгента. Этот пользователь является членом группы Performance Monitoring Users и может входить в систему только как служба. Пароль генерируется случайным образом во время установки и хранится в зашифрованном виде. Вы не можете изменить пароль. В целях безопасности dtuser не разрешается:
    • Доступ к компьютеру из сети.
    • Войдите в систему как пакетное задание.
    • Войдите в систему локально.
    • Войдите через Remote Desktop Services.
      dtuser требуется для правильной работы Ключ-АСТРОМ, поэтому его нельзя удалять. Если по какой-то причине dtuser был удален, следующее обновление его воссоздаст.
  • ЕдиныйАгент версии 1.195+ Для новых установок ЕдиногоАгента 1.195+ по умолчанию используется запуск расширений ЕдиногоАгента LocalSystem account. Для краткого обзора изменений, внесенных в вашу систему установкой ЕдиногоАгента, см. Безопасность ЕдиногоАгента в Windows (выше).

Настройка установки ЕдиногоАгента в Windows

Установщик ЕдиногоАгента для Windows предоставляется и используется как самораспаковывающийся EXE-файл. Установщик также может быть извлечен и использован напрямую — как пакет MSI.

Вы можете настроить установку, указав параметры командной строки для выбранных настроек, или вы можете положиться на настройки по умолчанию. Однако обратите внимание, что параметры, отмеченные ниже как environment-specific — то есть параметры, которые задают конечную точку связи, идентификатор среды и токен — это:

  • обязательные
  • предварительно настроены только для EXE-версии установщика. Поэтому при использовании установщика как и MSI-пакета необходимо указать эти параметры.

Передача параметров установки

Командная строка

Чтобы передать параметры, добавьте их к команде установщика и разделите пробелами.

Например, для EXE-версии установщика:

.\astromkey-OneAgent-Windows.exe --set-host-group=my_host_group --set-monitoring-mode=infra-only INSTALL_PATH="C:\installdir"

При использовании установщика в качестве пакета MSI можно напрямую добавлять только параметры INSTALL_PATH, LOG_PATH, DATA_STORAGE, PCAP_DRIVER, USER, и SKIP_OS_SUPPORT_CHECK. Параметры --set-param=<value> должны быть помещены внутрь ADDITIONAL_CONFIGURATION (ADDITIONAL_CONFIGURATION="--set-param=<value>").

Для получения дополнительной информации о синтаксисе командной строки см. раздел Тихая установка (ниже).

Пользовательский интерфейс установщика

Вы также можете добавить параметры --set-param=<value> на экране установки Настройка параметров ЕдиногоАгента.

2000.png

Параметры, поддерживаемые пользовательским интерфейсом установщика

Пользовательский интерфейс установщика ЕдиногоАгента для Windows поддерживает только параметры --set-param=<value>.

Следующие параметры НЕ поддерживаются пользовательским интерфейсом установщика: INSTALL_PATH, LOG_PATH, DATA_STORAGE, PCAP_DRIVER, USER и SKIP_OS_SUPPORT_CHECK.

Удаленные параметры установки

Начиная с версии 1.213, следующие параметры принимаются только если указаны --set-param=<value> с использованием синтаксиса. Для этих конкретных параметров PARAM=<value> эквивалентный синтаксис больше не поддерживается:

Удалённый параметр PARAM=<value> Новый параметр --set-param=<value>
SERVER --set-server
TENANT --set-tenant
TENANT_TOKEN --set-tenant-token
PROXY --set-proxy
HOST_GROUP --set-host-group
APP_LOG_CONTENT_ACCESS --set-app-log-content-access

Параметры установки MSI

INSTALL_PATH, LOG_PATH, DATA_STORAGE, PCAP_DRIVER и USER являются особым видом параметров, соответствующих синтаксису общедоступных свойств MSI. Они не будут заменены эквивалентными параметрами --set-param=<value>. Вы можете использовать их только в командной строке установщика, но не в пользовательском интерфейсе установщика.

Путь установки

Значение по умолчанию : %PROGRAMFILES%\astromkey\oneagent

Параметр INSTALL_PATH позволяет установить ЕдиныйАгент в директорию по вашему выбору.

Например:

.\astromkey-OneAgent-Windows.exe INSTALL_PATH="C:\test dir"

Этот параметр не поддерживается пользовательским интерфейсом установщика.

Параметр INSTALL_PATH не управляет директориями файлов логов и конфигурации ЕдиногоАгента. Чтобы настроить путь к логам, используйте параметр LOG_PATH.

Требования к пользовательской директории

Убедитесь, что ваш пользовательский путь установки соответствует следующим требованиям:

  • Директория должна быть предназначен только для ЕдиногоАгента. Никакое другое программное обеспечение не должно иметь к нему доступа. Одна из причин — безопасность, а другая — автоматическая очистка, периодически выполняемая ЕдинымАгентом, которая может удалить файлы, созданные другими приложениями.
  • Запрещается совместно использовать или вкладывать друг в друга директории установки, хранения и логов.
  • Значение должно быть абсолютным путем и не должно указывать на корневую директорию тома.
  • Значение не должно быть дочерней директорией %PROGRAMDATA%\astromkey.

Путь логов

Значение по умолчанию : %PROGRAMDATA%\astromkey\oneagent\log

Параметр LOG_PATH позволяет вам настроить директорию логов ЕдиногоАгента.

Например:

.\astromkey-OneAgent-Windows.exe LOG_PATH=C:\astromkey\logs

Этот параметр не поддерживается пользовательским интерфейсом установщика.

Требования к пользовательской директории

Убедитесь, что ваш пользовательский путь к логам соответствует следующим требованиям:

  • Директория должна быть предназначен только для ЕдиногоАгента. Никакое другое программное обеспечение не должно иметь к нему доступа. Одна из причин — безопасность, а другая — автоматическая очистка, периодически выполняемая ЕдинымАгентом, которая может удалить файлы, созданные другими приложениями.
  • Запрещается совместно использовать или вкладывать друг в друга директории установки, хранения и логов.
  • Значение должно быть абсолютным путем и не должно указывать на корневую директорию тома.
  • Значение не должно быть дочерней директорией %PROGRAMDATA%\astromkey.

Изменение местоположения

Если вы используете параметр для изменения местоположения уже установленного ЕдиногоАгента:

  • Существующие файлы не переносятся в новое место.
  • После установки или изменения параметра LOG_PATH необходимо перезапустить контролируемые процессы, чтобы ЕдиныйАгент, отслеживающий их, мог выбрать новый путь для хранения логов. Вам будет предложено перезапустить соответствующий процесс на странице обзора процессов.

Хранение данных

ЕдиныйАгент версии 1.199

Значение по умолчанию : %PROGRAMDATA%\astromkey\oneagent\datastorage

Параметр DATA_STORAGE позволяет определить директорию, предназначенную для хранения больших объемов данных времени выполнения, создаваемых ЕдинымАгентом в режиме мониторинга полного стека, например отчетов о сбоях или дампов памяти.

Например:

.\astromkey-OneAgent-Windows.exe DATA_STORAGE=D:\data\astromkey\runtime

Этот параметр не поддерживается пользовательским интерфейсом установщика.

Требования к пользовательской директории

Убедитесь, что ваш путь хранения данных соответствует следующим требованиям:

  • Директория должна быть предназначен только для ЕдиногоАгента. Никакое другое программное обеспечение не должно иметь к нему доступа. Одна из причин — безопасность, а другая — автоматическая очистка, периодически выполняемая ЕдинымАгентом, которая может удалить файлы, созданные другими приложениями.
  • Запрещается совместно использовать или вкладывать друг в друга директории установки, хранения и логов.
  • Значение должно быть абсолютным путем и не должно указывать на корневую директорию тома.
  • Значение не должно быть дочерней директорией %PROGRAMDATA%\astromkey.

Изменение местоположения

Если вы используете параметр для изменения местоположения уже установленного ЕдиногоАгента:

  • Существующие файлы не переносятся в новое место.
  • После установки или изменения параметра DATA_STORAGE необходимо перезапустить контролируемые процессы, чтобы ЕдиныйАгент, отслеживающий их, мог выбрать новый путь для хранения данных времени выполнения. В противном случае дампы памяти и другие данные времени выполнения не будут сохранены. Вам будет предложено перезапустить соответствующий процесс на странице обзора процессов.

Конечная точка связи

Значение по умолчанию : environment specific

Адрес конечной точки связи ЕдиногоАгента, которая является компонентом Ключ-АСТРОМ, на который ЕдиныйАгент отправляет данные. В зависимости от вашего развертывания это может быть кластер Ключ-АСТРОМ или АктивныйШлюз. Если вы устанавливаете ЕдиныйАгент с помощью страницы развертывания Ключ-АСТРОМ, это уже установлено на правильное значение. Чтобы изменить его, используйте IP-адрес или имя. Добавьте номер порта после двоеточия.

Чтобы задать конечную точку связи, передайте ее как значение параметра:

--set-server=https://100.20.10.1:443

ЕдиныйАгент и Ключ-АСТРОМ Cluster автоматически поддерживают рабочее соединение. Если изменяется информация о конечной точке, кластер уведомляет ЕдиныйАгент об изменении, и ЕдиныйАгент автоматически обновляет конечную точку, которую вы установили с помощью , --set-server на новое рабочее значение.

Чтобы изменить конечную точку после установки, используйте --set-server в интерфейсе командной строки ЕдиногоАгента.

Идентификатор среды

Значение по умолчанию : environment specific

Идентификатор среды Ключ-АСТРОМ, который вы получили в письме активации. Если вы устанавливаете ЕдиныйАгент с помощью страницы Ключ-АСТРОМ, это уже установлено на правильное значение.

Чтобы задать идентификатор среды, передайте его как значение параметра:

--set-tenant=mySampleEnv

Чтобы изменить идентификатор после установки, используйте --set-tenant в интерфейсе командной строки ЕдиногоАгента.

Токен

Значение по умолчанию : environment specific

Токен клиента, который используется для аутентификации, когда ЕдиныйАгент подключается к конечной точке связи для отправки данных. Если вы устанавливаете ЕдиныйАгент с помощью страницы Ключ-АСТРОМ, это уже установлено на правильное значение.

Чтобы установить токен, передайте его как значение параметра:

--set-tenant-token=abcdefghij123456

Чтобы узнать, как получить токен, см. раздел Токены доступа.

Чтобы изменить токен клиента после установки, используйте --set-tenant-token в интерфейсе командной строки ЕдиногоАгента.

Сетевые зоны

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

Информацию о правилах именования сетевых зон и другую справочную информацию см. в разделе Сетевые зоны.

Используйте параметр --set-network-zone, чтобы указать ЕдиномуАгенту на необходимость связи через указанную сетевую зону:

--set-network-zone=your.network.zone

Чтобы изменить или очистить назначение сетевой зоны после установки, используйте удаленное управление конфигурацией (выберите действие Изменить сетевую зону).

В качестве альтернативы вы можете использовать --set-network-zone в интерфейсе командной строки ЕдиногоАгента.

Прокси

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

Адрес прокси-сервера. Используйте IP-адрес или имя и добавьте номер порта после двоеточия. Для аутентифицирующего прокси-сервера вы можете указать имя пользователя и пароль, например, так username:password@172.1.1.128:8080, где и имя пользователя, и пароль должны быть закодированы в URL.

Чтобы установить прокси, передайте его как значение параметра:

--set-proxy=172.1.1.128:8080

Ключ-АСТРОМ также поддерживает адреса IPv6.

Чтобы изменить или очистить адрес прокси-сервера после установки, используйте --set-proxy в интерфейсе командной строки ЕдиногоАгента.

Автообновление

Используйте --set-auto-update-enabled=<arg> для включения или отключения автоматического обновления ЕдиногоАгента. Например:

--set-auto-update-enabled=true

После установки параметра в значение false вы не сможете управлять автоматическими обновлениями ЕдиногоАгента с помощью веб-интерфейса Ключ-АСТРОМ в разделе Настройки > Обновления > Обновления ЕдиногоАгента.

Группы хостов

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

Имя группы, в которую вы хотите назначить хост. Требования к строке группы хостов:

  • Может содержать только буквенно-цифровые символы, дефисы, подчеркивания и точки.
  • Не должно начинаться с dt.
  • Максимальная длина — 100 символов.

Чтобы назначить хост в группу хостов, передайте имя группы хостов в качестве значения параметра:

--set-host-group=My.HostGroup_123-456

Чтобы удалить хост из группы, вам нужно удалить ЕдиныйАгент или передать пустое значение --set-host-group="" при запуске обновления ЕдиногоАгента. Вы не можете удалить хост из группы с помощью параметра HOST_GROUP при обновлении ЕдиногоАгента.

Чтобы изменить или очистить назначение группы хостов после установки, используйте удаленное управление конфигурацией (выберите действие Изменить группу хостов).

В качестве альтернативы вы можете использовать --set-host-group в интерфейсе командной строки ЕдиногоАгента.

Режим мониторинга

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

Активирует один из режимов мониторинга ЕдиногоАгента:

  • fullstack
  • infra-only
  • discovery

Чтобы включить определенный режим мониторинга, установите для параметра --set-monitoring-mode одно из следующих значений:

  • fullstack
  • infra-only
  • discovery

Например:

--set-monitoring-mode=infra-only

Чтобы изменить режим мониторинга после установки, используйте --set-monitoring-mode в интерфейсе командной строки ЕдиногоАгента или задайте его с помощью страницы настроек хоста.

Пользовательское имя хоста

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

Используйте --set-host-name для переопределения автоматически обнаруженного имени хоста. Значение имени хоста не должно содержать символы <, >, &, CR (возврат каретки) и LF (перевод строки), а максимальная длина составляет 256 символов.

Эта команда добавляет пользовательское имя хоста для отображения в пользовательском интерфейсе, но обнаруженное имя хоста не изменяется.

Чтобы задать имя хоста:

--set-host-name=myhostname

Чтобы изменить имя хоста после установки, используйте --set-host-name в интерфейсе командной строки ЕдиногоАгента.

Пользовательские метаданные хоста

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

После настройки пользовательские метаданные отображаются как набор свойств в нижней части раздела Свойства и теги страницы обзора хоста. Значения свойств не должны содержать символы = (кроме разделителя ключ-значение) и пробелы. Максимальная длина составляет 256 символов, включая разделитель ключ-значение.

Чтобы добавить или изменить свойства хоста:

--set-host-property=AppName --set-host-property=Environment=Dev

Вы можете добавить или изменить более одного свойства в одной команде.

Чтобы изменить метаданные хоста после установки, используйте удаленное управление конфигурацией (выберите действие Изменить свойства хоста).

В качестве альтернативы вы можете использовать --set-host-property в интерфейсе командной строки ЕдиногоАгента.

Пользовательские теги хоста

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

После настройки теги отображаются в верхней части раздела Свойства и теги на странице обзора хоста. Значения свойств не должны содержать символы = (кроме разделителя ключ-значение) и пробелы. Максимальная длина составляет 256 символов, включая разделитель ключ-значение.

Чтобы добавить или изменить теги хоста:

--set-host-tag=TestHost --set-host-tag=role=fallback --set-host-tag=Gdansk

Вы можете добавлять или изменять более одного тега в одной команде. Разрешается определять теги с одинаковым ключом, но разными значениями.

Чтобы изменить теги хоста после установки, используйте удаленное управление конфигурацией (выберите действие Изменить тег хоста).

В качестве альтернативы вы можете использовать --set-host-tag в интерфейсе командной строки ЕдиногоАгента.

Источник идентификатора хоста

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

Доступно на всех поддерживаемых платформах для ЕдиногоАгента версии 1.223+. Для ЕдиногоАгента версии 1.221 и более ранних версий эта функция поддерживается только для Citrix Virtual Apps and Desktops.

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

Чтобы определить источник для генерации идентификатора хоста , используйте --set-host-id-source и задайте для него одно из предопределенных значений:

  • auto— Позволяет Ключ-АСТРОМ автоматически сгенерировать идентификатор хоста
  • ip-addresses— Генерация идентификатора хоста на основе IP-адреса хоста
  • mac-addresses— Генерация идентификатора хоста на основе MAC-адреса сетевой карты хоста
  • fqdn— Генерация идентификатора хоста на основе полного доменного имени хоста (FQDN) в формате host.domain. Если FQDN не содержит символа точки, вместо него используется MAC-адрес сетевой карты.
  • Если вы отслеживаете несколько сред, вы можете разделить хосты с идентичными IP-адресами, MAC-адресами или FQDN, используя разные пространства имен для каждой среды. Пространство имен может содержать только буквенно-цифровые символы, дефисы, подчеркивания и точки; максимальная длина составляет 256 символов:
  • ip-addresses;namespace=<namespace>
  • mac-addresses;namespace=<namespace>
  • fqdn;namespace=<namespace>

Например, чтобы задать источник идентификатора хоста ip-addresses и назначить его пространству имен с именем test, запустите установщик ЕдиногоАгента со следующим параметром:

--set-host-id-source="ip-addresses;namespace=test"

Чтобы установить ЕдиныйАгент на хост Citrix, задайте источник идентификатора хоста следующим образом FQDN:

--set-host-id-source="fqdn;namespace=test"

Доступ к системным логам

ЕдиныйАгент может загружать системные логи с целью диагностики проблем, которые могут быть вызваны условиями в вашей среде. ЕдиныйАгент в настоящее время не загружает системные логи Windows, но это может измениться в будущих выпусках.

--set-system-logs-access-enabled=false отключает доступ к логам

--set-system-logs-access-enabled=true включает доступ к логам

Если вам необходимо изменить этот доступ после установки, используйте интерфейс командной строки ЕдиногоАгента.

Обратите внимание, что это настройка самодиагностики, которая не связана с мониторингом логов.

Мониторинг логов

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

Если установлено значение true, ЕдиныйАгент может получить доступ к файлам логов для мониторинга логов. Допустимые значения: (true, false) или (1, 0). Эту опцию можно также включить/отключить через веб-интерфейс .

Например: --set-app-log-content-access=true

Если вам необходимо включить или отключить мониторинг логов после установки, используйте -set-app-log-content-access в интерфейсе командной строки ЕдиногоАгента.

Автоматическое внедрение

Не устанавливайте этот параметр на true во время процесса установки.

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

Вы можете установить параметр --set-auto-injection-enabled=<arg> на true или false для отключения или включения автоматического внедрения ЕдиногоАгента.

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

Локальное использование метрики

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

Вы можете использовать параметр --set-extensions-ingest-port=<arg> для изменения порта связи по умолчанию, используемого для локального приема метрик. Порт используется ЕдинымАгентом REST API , Scripting integration (astromkey_ingest) и Telegraf.

Для получения дополнительной информации см. раздел Прием метрических данных.

Прием метрики StatsD

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

С помощью параметра --set-extensions-statsd-port=<arg> можно изменить порт UDP AstromkeyStatsD по умолчанию.

Для получения дополнительной информации см. раздел Прием метрических данных.

Пользователь расширения OneAgent

Значение по умолчанию : LocalSystem (ЕдиныйАгент версии 1.195+)

Используйте параметр USER для определения пользователя, запускающего процесс, ответственный за функциональность расширений Ключ-АСТРОМ ЕдиныйАгент.

Например:

.\astromkey-OneAgent-Windows.exe USER=LocalService

Этот параметр не поддерживается пользовательским интерфейсом установщика.

Если вы не добавляете параметр USER:

  • Для новых установок ЕдиногоАгента 1.195+ LocalSystem для запуска расширений ЕдиногоАгента будет использоваться учетная запись по умолчанию, но расширения Python будут созданы как LocalService.
  • Для новых развертываний ЕдиногоАгента до версии 1.195, ЕдиныйАгент будет использовать учетную запись dtuser.
  • Обновление ЕдиногоАгента сохраняет ранее настроенную учетную запись пользователя. Чтобы изменить ее, необходимо переустановить ЕдиныйАгент, установив параметр USER на новое значение.

Параметр USER может иметь одно из следующих значений:

  • рекомендуется LocalSystem— это учетная запись пользователя по умолчанию, используемая для запуска расширений ЕдиногоАгента, начиная с версии ЕдиногоАгента 1.195. Применяется автоматически, когда параметр USER не используется. Это значение параметра заставляет ЕдиныйАгент использовать привилегированную системную учетную запись NT AUTHORITY\SYSTEM для запуска расширений ЕдиногоАгента. Фактически, локальная учетная запись пользователя не создается. В результате все модули ЕдиногоАгента, включая все расширения, кроме расширений Python, полностью функциональны. Расширения Python будут работать как LocalService.
  • LocalService: Этот параметр заставляет ЕдиныйАгент использовать системную учетную запись NT AUTHORITY\LOCAL SERVICE для запуска расширений ЕдиногоАгента. Хотя этот сокращенный набор привилегий достаточен для работы большинства расширений, некоторые из них не смогут эффективно производить данные (а именно, расширения, собирающие счетчики Performance Monitor, такие как расширения MS SQL или .NET). Если вы не уверены в том, какие расширения следует использовать, лучше использовать LocalSystem вместо этого значение параметра.

При развертывании Ключ-АСТРОМ на контроллере домена Windows Server убедитесь, что параметр USER установлен в значение LocalSystem, или в качестве альтернативы LocalService, чтобы избежать распространения dtuser по всему домену, что может вызвать помехи для существующих учетных записей dtuser на хостах, на которых установлен Ключ-АСТРОМ.

Тихая установка

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

Параметры среды преднастроены только для EXE-версии установщика. При использовании установщика в виде пакета MSI все эти параметры необходимо указать самостоятельно.

Пакет MSI — тихая установка

Чтобы настроить автоматическую установку из командной строки при использовании пакета MSI, добавьте /quiet /qn, как в этих примерах:

Командная оболочка
msiexec /i C:\some\path\astromkey-OneAgent-Windows.msi ADDITIONAL_CONFIGURATION="--set-server=https://someserver.com --set-tenant=xxx --set-tenant-token=xxx --set-host-group=myGroup" /quiet /qn
PowerShell 3.0+
msiexec /i C:\some\path\astromkey-OneAgent-Windows.msi --% ADDITIONAL_CONFIGURATION="--set-server=https://someserver.com --set-tenant=xxx --set-tenant-token=xxx --set-host-group=myGroup" /quiet /qn

Обратите внимание на символ --% остановки анализа, используемый в команде PowerShell.

Установщик EXE — тихая установка

Чтобы настроить автоматическую установку из командной строки для EXE-версии установщика, добавьте --quiet, как в этом примере:

.\astromkey-OneAgent-Windows.exe --set-host-group="myGroup" --quiet

Драйвер захвата пакетов (pcap)

ЕдиныйАгент версии 1.229+

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

Пример:

.\astromkey-OneAgent-Windows.exe PCAP_DRIVER=npcap

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

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

Значение Описание
npcap PCAP_DRIVER=npcap устанавливает Npcap драйвер.

Эта опция удаляет любую установку WinPcap или устаревшего Npcap, ранее установленного ЕдинымАгентом. Однако, если вы установили WinPcap или Npcap вручную, вам придется удалить его самостоятельно.

winpcap PCAP_DRIVER=winpcap устанавливает WinPcap драйвер.

Эта опция НЕ удаляет и НЕ перезаписывает существующую установку Npcap или WinPcap.

auto Устаревшее с ЕдиногоАгента версии 1.255+

PCAP_DRIVER=auto автоматически определяет, какой драйвер установить. Эта опция НЕ удаляет и НЕ перекрывает существующую установку Npcap или WinPcap. Во время установки, если драйвер захвата пакетов не найден, Npcap устанавливается по умолчанию, за исключением Windows Server 2019 build 1809 without hotfix KB4571748, где, по соображениям совместимости, установлен WinPcap.

disabled Доступно с ЕдиногоАгента версии 1.249+

PCAP_DRIVER=disabled отключает установку любого драйвера захвата пакетов и отключает модуль сетевого мониторинга ЕдиногоАгента. Если какой-либо драйвер захвата пакетов уже установлен на хосте, вам нужно будет удалить его вручную.

  • Этот параметр не поддерживается веб-интерфейсом установщика.
  • Значение этого параметра сохраняется при обновлениях.
  • Если вы выполняете установку Npcap во время установки ЕдиногоАгента, установщик создает запланированную задачу с именем npcapwatchdog.
    • Эта задача обеспечивает корректную работу драйвера Npcap после обновления компонентов Windows. Задача выполняется в фоновом режиме и не влияет на производительность или функциональность системы.
    • Хотя эта задача npcapwatchdog призвана предотвратить проблемы с обновлениями Windows, вы можете удалить ее. Однако если ее удалить, может потребоваться переустановка драйвера Npcap, прежде чем его можно будет использовать снова.

Пропуск проверки поддержки операционной системы

Установка этого параметра в значение true позволит установить ЕдиныйАгент на иной неподдерживаемой платформе. Ключ-АСТРОМ не несет ответственности за такие установки.
Этот параметр не поддерживается пользовательским интерфейсом установщика.
Этот параметр не сохраняется при автоматических обновлениях.


Информацию о механизме автоматического обновления ЕдиногоАгента см. в разделе Обновление Ключ-АСТРОМ ЕдиногоАгента в Windows (выше).

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

Параметр SKIP_OS_SUPPORT_CHECK позволяет принудительно установить ЕдиныйАгент на неподдерживаемой платформе.

Например: .\astromkey-OneAgent-Windows.exe SKIP_OS_SUPPORT_CHECK=true

Информацию о поддерживаемых платформах см. в разделе Поддержка технологий.