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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Начиная с версии 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`
`INFRA_ONLY`	`--set-infra-only`

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

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

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

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

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

Например:

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

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

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

Требования к пользовательскому каталогу

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

Каталог должен быть выделен только для целей одного агента. Никакое другое программное обеспечение не может иметь к нему доступа. Одной из причин является безопасность, а другой - автоматическая очистка, периодически выполняемая одним агентом, которая может удалять файлы, созданные другими приложениями.
Вы не должны совместно использовать или вкладывать друг в друга каталоги установки, хранения и журнала.
Значение должно быть абсолютным путем и не должно указывать на каталог корневого тома.
Значение не должно быть дочерним каталогом %PROGRAMDATA%\key-astrom.

Путь к журналу

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

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

Например:

.\Key-Astrom-OneAgent-Windows.exe LOG_PATH=C:\key-astrom\logs

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

Требования к пользовательскому каталогу

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

Каталог должен быть выделен только для целей одного агента. Никакое другое программное обеспечение не может иметь к нему доступа. Одной из причин является безопасность, а другой - автоматическая очистка, периодически выполняемая одним агентом, которая может удалять файлы, созданные другими приложениями.
Вы не должны совместно использовать или вкладывать друг в друга каталоги установки, хранения и журнала.
Значение должно быть абсолютным путем и не должно указывать на каталог корневого тома.
Значение не должно быть дочерним каталогом %PROGRAMDATA%\key-astrom.

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

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

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

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

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

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

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

Для примера:

.\Key-Astrom-OneAgent-Windows.exe DATA_STORAGE=D:\data\key-astom\runtime

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

Требования к пользовательскому каталогу

Каталог должен быть выделен только для целей одного агента. Никакое другое программное обеспечение не может иметь к нему доступа. Одной из причин является безопасность, а другой - автоматическая очистка, периодически выполняемая одним агентом, которая может удалять файлы, созданные другими приложениями.
Вы не должны совместно использовать или вкладывать друг в друга каталоги установки, хранения и журнала.
Значение должно быть абсолютным путем и не должно указывать на каталог корневого тома.
Значение не должно быть дочерним каталогом %PROGRAMDATA%\key-astrom.

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

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

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

Адрес конечной точки связи

Значение по умолчанию: зависит от окружения

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

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

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

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

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

Идентификатор окружения

Значение по умолчанию: зависит от окружения

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

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

--set-tenant=mySampleEnv

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

Токен

Значение по умолчанию: зависит от окружения

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

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

--set-tenant-token=abcdefghij123456

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

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

Сетевые зоны

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

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

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

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

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

Прокси

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

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

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

--set-proxy=172.1.1.128:8080

АппОптима также поддерживает IPv6-адреса.

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

Диапазон портов

Значения по умолчанию: 50000:50100

Используйте параметр --set-watchdog-port range=<arg>, чтобы изменить диапазон прослушиваемых портов watchdog на <arg>. <arg> должен содержать два номера портов, разделенных двоеточием (:). Например, 50000:50100. Максимальный поддерживаемый диапазон портов составляет от 1024 до 65535. Диапазон портов должен охватывать не менее 4 портов. Номер порта, с которого начинается диапазон, должен быть ниже. Например:

--set-watchdog-portrange=50000:50100

Если вам нужно изменить диапазон портов после установки, используйте --set-watchdog-portrange в интерфейсе командной строки ЕдиногоАгента.

Автоматическое обновление

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

--set-auto-update-enabled=true

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

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

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

Имя группы, которой вы хотите назначить хост. Дополнительные сведения см. в разделе Организация среды с помощью групп хостов. Требования к строкам группы хостов:

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

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

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

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

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

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

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

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

--set-infra-only=true

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

--set-infra-only=false

Если вам нужно изменить, включить или отключить режим мониторинга инфраструктуры после установки, используйте --set-infra-only в интерфейсе командной строки ЕдиногоАгента или установите его на странице настроек хоста.

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

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

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

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

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

--set-host-name=myhostname

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

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

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

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

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

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

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

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

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

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

После настройки теги отображаются в верхней части раздела Свойств и тегов страницы обзора хоста. Значения свойств не должны содержать символов = (кроме разделителя ключ-значение) и пробелов. Максимальная длина - 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.

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

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

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

ip-addresses;namespace=<namespace>
mac-addresses;namespace=<namespace>
fqdn;namespace=<namespace>

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

--set-host-id-source="ip-addresses;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 в интерфейсе командной строки ЕдиногоАгента.

Автоматическая инъекция

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

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

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

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

Прием локальных метрик

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

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

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

Дополнительные сведения см. в разделе Прием метрик.

Получение метрик StatsD

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

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

Вы можете использовать параметр --set-extensions-statsd-port=<arg>, чтобы изменить порт прослушивания UDP по умолчанию.

Дополнительные сведения см. в разделе Прием метрик.

Пользователь расширения ЕдиныйАгент

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

Используйте параметр USER, чтобы указать пользователя, запускающего процесс, отвечающий за функциональность расширений АппОптима ЕдиныйАгент. Например:

.\Key-Astrom-OneAgent-Windows.exe USER=LocalService

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

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

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

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

Рекомендуемое LocalSystem — это учетная запись пользователя по умолчанию, используемая для запуска расширений ЕдиногоАгента, начиная с версии 1.195. Применяется автоматически, если параметр USER не используется. Это значение параметра заставляет ЕдиныйАгент использовать привилегированную системную учетную запись NT AUTHORITY\SYSTEM для запуска расширений ЕдиногоАгента. По сути, локальная учетная запись пользователя не создается. В результате все модули ЕдиногоАгента, включая все расширения, полностью функциональны. Это рекомендуемый параметр для всех установок ЕдиногоАгента Windows, начиная с версии 1.191.
LocalService: этот параметр заставляет ЕдиныйАгент использовать системную учетную запись NT AUTHORITY\LOCAL SERVICE для запуска расширений ЕдиногоАгента. Хотя этого ограниченного набора привилегий достаточно для работы большинства расширений, есть некоторые, которые не смогут эффективно создавать данные (а именно, расширения, которые собирают счетчики системного монитора, такие как расширения MS SQL или .NET). Если вы не уверены, какие расширения вы можете использовать, лучше вместо этого использовать значение параметра LocalSystem.
Устарело no_create отключал создание пользователей при установке ЕдиногоАгента до версии 1.209. Начиная с версии 1.209, при использовании параметра no_create программа установки ЕдиногоАгента применяет параметр LocalSystem без предупреждения. Параметр no_create не преобразуется в LocalSystem для существующих установок при запуске обновления. Для преобразования необходимо переустановить ЕдиныйАгент, задав для параметра USER новое значение.
Устарело dtuser был учетной записью пользователя по умолчанию, которая использовалась для запуска расширений ЕдиногоАгента до версии 1.195. Это заставляло установщика создавать локальную учетную запись пользователя с таким же именем в системе. Начиная с версии 1.209, при использовании параметра dtuser программа установки ЕдиногоАгента применяет параметр LocalSystem без предупреждения. Начиная с версии 1.239, параметр dtuser преобразуется в LocalSystem для существующих установок при запуске обновления.

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

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

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

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

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

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

Command shell

msiexec /i C:\some\path\Key-Astrom-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\Key-Astrom-OneAgent-Windows.msi --% ADDITIONAL_CONFIGURATION="--set-server=https://someserver.com --set-tenant=xxx --set-tenant-token=xxx --set-host-group=myGroup" /quiet /qn

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

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

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

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

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

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

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

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

npcap — установить драйвер Npcap. Эта опция удалит любую существующую установку Npcap или WinPcap.

winpcap — установить драйвер WinPcap. Эта опция НЕ удалит и не перекроет любую существующую установку Npcap или WinPcap.

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

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

Например:

.\Key-Astrom-OneAgent-Windows.exe PCAP_DRIVER=npcap

Примечание:

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

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