Установщик для дистрибутивов Linux можно использовать с параметрами командной строки, если вы не можете использовать параметры по умолчанию. Обратите внимание, что все параметры, перечисленные ниже, являются необязательными.
Передача параметров установки
Чтобы передать параметры, добавьте их к команде установщика и разделите пробелами.
Например:
OneAgent-Linux.sh --set-host-group=my_host_group --set-infra-only=true
Удаленные параметры установки
Преобразуйте в более новые параметры --set-param=<value>
. Эквивалентные параметры PARAM=<value>
не поддерживаются программой установки ЕдиногоАгента, начиная с версии 1.213.
Удален параметр PARAM=<value> Новый параметр --set-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
|
DISABLE_SYSTEM_LOGS_ACCESS
|
--set-system-logs-access-enabled
|
INFRA_ONLY
|
--set-infra-only
|
Если вы смешиваете эквивалентные параметры PARAM=<value>
и --set-param=<value>
, параметр --set-param=<value>
переопределяет параметр PARAM=<value>
.
Конечная точка связи
Значение по умолчанию: зависит от среды
Адрес конечной точки связи ЕдиногоАгента, которая является компонентом АппОптима, на который ЕдиныйАгент отправляет данные. В зависимости от вашего развертывания это может быть кластер АппОптима или АктивныйШлюз. Если вы устанавливаете ЕдиныйАгент с помощью страницы развертывания АппОптима, для него уже установлено правильное значение. Чтобы изменить его, используйте IP-адрес или имя. Добавьте номер порта после двоеточия.
Чтобы установить конечную точку связи, передайте ее как значение параметра:
--set-server=https://100.20.10.1:443
ЕдиныйАгент и АппОптима Cluster автоматически поддерживают рабочее соединение. Если детали конечной точки изменяются, кластер уведомляет ЕдиныйАгент об изменении, и ЕдиныйАгент автоматически обновляет конечную точку, которую вы установили с помощью --set-server, до нового рабочего значения.
Если вам нужно изменить конечную точку после установки, используйте --set-server в интерфейсе командной строки ЕдиныйАгент.
Идентификатор среды
Значение по умолчанию: зависит от среды
Идентификатор среды АппОптима, который вы получили по электронной почте с активацией. Если вы устанавливаете ЕдиныйАгент с помощью страницы развертывания АппОптима, для него уже установлено правильное значение. Если вы продаете услуги на основе АппОптима, используйте этот параметр, чтобы установить идентификаторы ваших клиентов из пула идентификаторов, приобретенных вами у АппОптима.
Чтобы установить идентификатор среды, передайте его в качестве значения параметра:
--set-tenant=mySampleEnv
Если вам нужно изменить арендатора после установки, используйте --set-tenant
в интерфейсе командной строки ЕдиногоАгента.
Токен
Значение по умолчанию: зависит от среды
Маркер клиента, который используется для проверки подлинности, когда ЕдиныйАгента подключается к конечной точке связи для отправки данных. Если вы устанавливаете ЕдиныйАгент с помощью страницы развертывания АппОптима, для него уже установлено правильное значение.
Чтобы установить токен, передайте его как значение параметра:
--set-tenant-token=abcdefghij123456
См. Токены доступа, чтобы узнать, как получить токен.
Если вам нужно изменить токен клиента после установки, используйте --set-tenant-token
в интерфейсе командной строки ЕдиногоАгента.
Сетевые зоны
Значение по умолчанию: не установлено
Чтобы узнать о правилах именования сетевых зон и другую справочную информацию, см. раздел Сетевые зоны.
Используйте параметр --set-network-zone, чтобы указать ЕдиномуАгенту обмениваться данными через указанную сетевую зону:
--set-network-zone=ваша.сетевая.зона
Если вам нужно изменить назначение сетевой зоны после установки, используйте --set-network-zone в интерфейсе командной строки ЕдиногоАгента.
Прокси
Значение по умолчанию: не установлено
Адрес прокси-сервера. Используйте IP-адрес или имя и добавьте номер порта после двоеточия. Для прокси-сервера с проверкой подлинности вы можете указать имя пользователя и пароль, например имя пользователя: пароль@172.1.1.128:8080, где имя пользователя и пароль должны быть указаны в URL-адресе.
Чтобы установить прокси, передайте его как значение параметра:
--set-proxy=172.1.1.128:8080
АппОптима также поддерживает адреса IPv6.
Если вам нужно изменить адрес прокси-сервера после установки, используйте --set-proxy в интерфейсе командной строки ЕдиногоАгента.
Диапазон портов
Значение по умолчанию: 50000:50100
Используйте параметр --set-watchdog-portrange=<arg>
, чтобы изменить диапазон портов прослушивания на <arg>
. <arg>
должен содержать два номера порта, разделенных двоеточием (:). Например 50000:50100
. Максимальный поддерживаемый диапазон портов — от 1024 до 65535. Диапазон портов должен охватывать не менее 4 портов. Номер порта, начиная с диапазона, должен быть меньше. Например:
--set-watchdog-portrange=50000:50100
Если вам нужно изменить диапазон портов после установки, используйте --set-watchdog-portrange в интерфейсе командной строки ЕдиногоАгента.
Группа хостов
Значение по умолчанию: не установлено
Имя группы, к которой вы хотите привязать хост. Дополнительные сведения см. в разделе Организация среды с помощью групп хостов. Требования к строке группы хостов:
- Может содержать только буквенно-цифровые символы, дефисы, символы подчеркивания и точки.
- Не должен начинаться с
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-host-name
, чтобы переопределить автоматически обнаруженное имя хоста. Значение имени хоста не должно содержать символы <
, >
, &
, 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.
Особенно важно сохранять статический идентификатор хоста в динамических виртуальных средах, где хосты воссоздаются ежедневно.
Чтобы определить источник для генерации идентификатора хоста, используйте --set-host-id-source
и установите для него одно из предопределенных значений:
auto
— разрешить АппОптима автоматически генерировать идентификатор хоста.ip-addresses
— Генерировать идентификатор хоста на основе IP-адреса хостаmac-address
— Генерировать идентификатор хоста на основе MAC-адреса сетевой карты хоста.fqdn
— Генерировать идентификатор узла на основе полного доменного имени узла (FQDN) в форматеhost.domain
. Если полное доменное имя не содержит символа точки, вместо него используется MAC-адрес сетевой карты.- Если вы отслеживаете несколько сред, вы можете разделить узлы с одинаковыми IP-адресами, MAC-адресами или полными доменными именами, используя разные пространства имен для каждой среды. Пространство имен может содержать только буквенно-цифровые символы, дефисы, символы подчеркивания и точки; максимальная длина 256 символов:
ip-адреса;namespace=<пространство имен>
mac-адреса;namespace=<пространство имен>
fqdn;namespace=<пространство имен>
Например, чтобы задать в качестве источника идентификатора узла IP-адреса
и назначить его пространству имен с именем test
, запустите программу установки ЕдиногоАгента со следующим параметром:
--set-host-id-source="ip-addresses;namespace=test"
Мониторинг журнала
Значение по умолчанию: true
Если установлено значение true
, ЕдиныйАгент получает доступ к файлам журналов для мониторинга журналов. Допустимые значения: (true
, false
) или (1
, 0
). В качестве альтернативы эту опцию можно включить/отключить через веб-интерфейс.
Например: --set-app-log-content-access=true
Если вам нужно включить или отключить мониторинг журналов после установки, используйте -set-app-log-content-access
в интерфейсе командной строки ЕдиногоАгента.
Прием локальных метрик
ЕдиныйАгент версии 1.201
Значение по умолчанию: 14449
Вы можете использовать параметр --set-extensions-ingest-port=<arg>
, чтобы изменить порт связи по умолчанию, используемый для локального приема метрик. Порт используется следующими модулями: ЕдиныйАгент REST API, интеграции сценариев и Telegraf.
Дополнительные сведения см. в разделе Прием метрик.
Загрузка показателей StatsD
ЕдиныйАгент версии 1.201
Значение по умолчанию: 18125
Вы можете использовать параметр --set-extensions-statsd-port=<arg>
, чтобы изменить порт прослушивания UDP АппОптимаStatsD по умолчанию.
Дополнительные сведения см. в разделе Прием метрик.
Путь установки
Значение по умолчанию: /opt/<namespace>/oneagent
Необходимое условие: использование этого параметра при включенном SELinux требует, чтобы в вашей системе была доступна утилита semanage.
Параметр INSTALL_PATH
разрешает установку в другой каталог. Например:
/bin/sh OneAgent-AIX-1.0.0.sh INSTALL_PATH=/data/<namespace>/agent
Программа установки создает символическую ссылку /opt/<namespace>/oneagent
> /data/<namespace>/agent
, и файлы установки ЕдиногоАгента будут помещены в указанный каталог (в данном примере /data/<namespace>/agent
). Обратите внимание, что эту символическую ссылку необходимо удалить вручную после удаления ЕдиногоАгента.
Примечание. Параметр INSTALL_PATH не управляет каталогами журналов и файлов конфигурации ЕдиногоАгента. Чтобы настроить путь журнала, используйте параметр LOG_PATH.
Требования к пользовательскому каталогу
Ваш пользовательский каталог установки должен соответствовать следующим требованиям:
- Каталог должен быть предназначен только для целей ЕдиногоАгента. Никакое другое программное обеспечение не может иметь к нему доступ. Одна причина — безопасность, а другая — автоматическая очистка, периодически выполняемая ЕдинымАгентом, которая может удалять файлы, созданные другими приложениями.
- Вы не должны совместно использовать или вкладывать друг в друга каталоги установки, хранения и журналов.
- Значение должно быть абсолютным путем и не должно указывать на корневой каталог тома.
- Значение не должно быть уже существующей символической ссылкой.
- Значение не должно быть дочерним каталогом
/var/lib/<namespace>
.
Путь журнала
Значение по умолчанию: /var/log/<namespace>/oneagent
Необходимое условие: использование этого параметра при включенном SELinux требует, чтобы в вашей системе была доступна утилита semanage.
Параметр LOG_PATH позволяет настроить каталог журналов ЕдиногоАгента. Например:
/bin/sh OneAgent-Linux-1.0.0.sh LOG_PATH=/data/<namespace>/logs
Требования к пользовательскому каталогу
Путь к пользовательскому журналу должен соответствовать следующим требованиям:
- Каталог должен быть предназначен только для целей ЕдиногоАгента. Никакое другое программное обеспечение не может иметь к нему доступ. Одна причина — безопасность, а другая — автоматическая очистка, периодически выполняемая ЕдинымАгентом, которая может удалять файлы, созданные другими приложениями.
- Вы не должны совместно использовать или вкладывать друг в друга каталоги установки, хранения и журналов.
- Значение должно быть абсолютным путем и не должно указывать на корневой каталог тома.
- Значение не должно быть уже существующей символической ссылкой.
- Значение не должно быть дочерним каталогом
/var/lib/<namespace>
. - Значение не должно указывать на
/opt/<namespace>/oneagent/log
, который является расположением журнала по умолчанию для версий ЕдиногоАгента до 1.203.
Изменение местоположения
Если вы используете параметр для изменения местоположения уже установленного ЕдиногоАгента:
- Существующие файлы не переносятся в новое место
- После того, как вы установите или измените параметр
LOG_PATH
, вы должны перезапустить процессы с глубоким мониторингом, чтобы контролирующие их экземпляры ЕдиногоАгента могли выбрать новый путь для хранения журналов. Вы будете уведомлены о перезапуске соответствующего процесса на странице обзора процессов.
Хранилище данных
ЕдиныйАгент версии 1.199
Значение по умолчанию: /var/lib/<namespace>/oneagent/datastorage
Необходимое условие: использование этого параметра при включенном SELinux требует, чтобы в вашей системе была доступна утилита semanage.
Параметр DATA_STORAGE
позволяет определить каталог, предназначенный для хранения больших данных во время выполнения, созданных ЕдинымАгентом в режиме мониторинга полного стека, таких как отчеты о сбоях или дампы памяти. Например:
/bin/sh OneAgent-Linux.sh DATA_STORAGE=/data/<namespace>/runtime
Требования к пользовательскому каталогу
Ваш собственный каталог хранилища данных должен соответствовать следующим требованиям:
- Каталог должен быть предназначен только для целей ЕдиногоАгента. Никакое другое программное обеспечение не может иметь к нему доступ. Одна причина — безопасность, а другая — автоматическая очистка, периодически выполняемая ЕдинымАгентом, которая может удалять файлы, созданные другими приложениями.
- Вы не должны совместно использовать или вкладывать друг в друга каталоги установки, хранения и журналов.
- Значение должно быть абсолютным путем и не должно указывать на корневой каталог тома.
- Значение не должно быть уже существующей символической ссылкой.
- Значение не должно быть дочерним каталогом
/var/lib/<namespace>
.
Изменение местоположения
Если вы используете параметр для изменения местоположения уже установленного ЕдиногоАгента:
- Существующие файлы не переносятся в новое место
- После того, как вы установите или измените параметр
DATA_STORAGE
, вы должны перезапустить процессы с глубоким мониторингом, чтобы контролирующие их экземпляры ЕдиногоАгента могли выбрать новый путь для хранения данных среды выполнения. В противном случае дампы памяти и другие данные времени выполнения не будут сохранены. Вы будете уведомлены о перезапуске соответствующего процесса на странице обзора процесса.
Доступ к системным журналам
Значение по умолчанию: true
ЕдиныйАгент загружает системные журналы Linux для диагностики проблем, которые могут быть вызваны условиями в вашей среде. Дополнительные сведения см. в разделе Системные журналы, загружаемые ЕдинымАгентом.
Чтобы отключить доступ к журналам:
--set-system-logs-access-enabled=false
Чтобы разрешить доступ к журналам:
--set-system-logs-access-enabled=true
Если вам нужно изменить этот доступ после установки, используйте интерфейс командной строки ЕдиногоАгента:
Обратите внимание, что это параметр самодиагностики, не связанный с мониторингом журналов.
Непривилегированный режим
NON_ROOT_MODE
Значение по умолчанию: 1
(версия ЕдиногоАгента 1.193+. Для более ранних версий 0
).
При установке ЕдиногоАгента для работы в непривилегированном режиме, вам нужно один раз предоставить повышенные привилегии ЕдиномуАгенту во время установки. Повышенные привилегии сбрасываются сразу после установки ЕдиногоАгента.
Начиная с версии 1.193, ЕдиныйАгент по умолчанию устанавливается в непривилегированном режиме. Существующие установки не переключаются в непривилегированный режим.
Чтобы переключить установленный ЕдиныйАгент в непривилегированный режим, вам необходимо вручную добавить параметр NON_ROOT_MODE=1
к команде установки. Пример: sudo /bin/sh Agent-Linux-1.0.0.sh NON_ROOT_MODE=1
Чтобы переключить установщик обратно в режим по умолчанию для последовательных обновлений, запустите его с NON_ROOT_MODE=0
.
Обратите внимание, что для непривилегированного режима требуются возможности ядра Linux, доступные в следующих версиях:
- Ядро Linux версии 2.6.26+ для установки ЕдиногоАгента без привилегий root.
- Ядро Linux версии 4.3+ (рекомендуется версия systemd 221+) для автоматических обновлений ЕдиногоАгента и полноценной работы без привилегий root. Для получения дополнительной информации см. непривилегированный режим Linux.
DISABLE_ROOT_FALLBACK
Значение по умолчанию: 0
Используется вместе с параметром NON_ROOT_MODE
для блокировки уровня разрешений суперпользователя для запуска ЕдиногоАгента в непривилегированном режиме. Привилегии суперпользователя требуются для автоматических обновлений и отдельных операций с версиями ядра между 2.6.26 и 4.3, то есть версиями без поддержки Linux ambient capabilities.
sudo /bin/sh OneAgent-Linux-1.0.0.sh NON_ROOT_MODE=1 DISABLE_ROOT_FALLBACK=1
Чтобы переключить установщик обратно на использование уровня разрешений суперпользователя для последующих обновлений, запустите его с параметром DISABLE_ROOT_FALLBACK=0
.
Дополнительные сведения см. в требованиях к разрешениям для установки и работы ЕдиногоАгента в Linux.
Примечания:
- Процесс удаления не удаляет непривилегированного пользователя из системы (независимо от того, является ли он
dtuser
или задан при помощиUSER parameter
). - Непривилегированное имя пользователя сохраняется во время обновления, если во время обновления не указано новое имя пользователя.
Изменение непривилегированного пользователя и группы
USER
Значение по умолчанию: dtuser
Данный параметр определяет имя непривилегированного пользователя, которое используется непривилегированными процессами ЕдиногоАгента. Непривилегированные процессы — это процессы, которым не нужны привилегии root. Эти процессы в Linux называются Network ЕдиныйАгент и Plugin ЕдиныйАгент.
- По умолчанию программа установки АппОптима использует
dtuser
в качестве имени непривилегированного пользователя. - Если указан параметр
USER=<username>
, программа установки использует<username>
в качестве имени непривилегированного пользователя.
В любом случае программа установки АппОптима проверяет, существует ли уже в системе требуемый пользователь (dtuser
или пользователь, указанный в параметре USER).
- Если пользователь и группа с одинаковым именем существуют, и эта группа установлена для этого пользователя в качестве основной, пользователь используется для запуска сетевых и подключаемых модулей ЕдиногоАгента.
- Если пользователь не существует, программа установки АппОптима создает этого пользователя и группу, а затем запускает непривилегированные процессы с этим новым пользователем.
- Если пользователь существует в системе, но не имеет группы с тем же именем, что и основная, установка прерывается — чтобы использовать группу с другим именем, необходимо использовать параметр
GROUP
.
Требования к строке USER
:
- Может содержать только буквенно-цифровые символы, дефис
-
, подчеркивание_
и точку.
- Минимальная длина 3 символа
- Максимальная длина – 32 символа
- Не может быть строкой идентификатора пользователя
GROUP
Значение по умолчанию: dtuser
Может использоваться только в сочетании с параметром USER
и используется для указания основной группы для пользователя, переданного через параметр USER
. Если вы не укажете параметр GROUP
, программа установки предполагает, что он такой же, как и USER
, как для существующих, так и для несуществующих пользователей. Если вы указываете группу с помощью параметра GROUP
, а пользователя не существует, программа установки создает пользователя и назначает его в указанную группу. Вы также используете параметр GROUP
, чтобы указать непривилегированного пользователя, принадлежащего к определенной группе, с именем, отличным от имени пользователя. Чтобы усилить безопасность вашей системы, мы настоятельно рекомендуем использовать выделенную группу пользователей для запуска процессов ЕдиногоАгента.
Требования к строке GROUP
:
- Может содержать только буквенно-цифровые символы, дефис
-
, подчеркивание_
и точку.
- Минимальная длина 3 символа
- Максимальная длина – 32 символа.
- Не может быть строкой идентификатора группы