OneAgent настройка через интерфейс командной строки: различия между версиями
Lobanov (обсуждение | вклад) (Новая страница: «Используйте интерфейс командной строки <code>oneagentctl</code> для выполнения некоторых настроек...») |
Lobanov (обсуждение | вклад) |
||
(не показаны 4 промежуточные версии 2 участников) | |||
Строка 1: | Строка 1: | ||
Используйте интерфейс командной строки <code>oneagentctl</code> для выполнения некоторых настроек | Используйте интерфейс командной строки <code>oneagentctl</code> для выполнения некоторых настроек OneAgent после установки на уровне отдельного хоста. | ||
==Расположение== | ==Расположение== | ||
Расположение инструмента зависит от того, настроили ли вы установку | Расположение инструмента зависит от того, настроили ли вы установку OneAgent с помощью параметра <code><INSTALL_PATH></code>: | ||
'''Linux''' или '''AIX''': | '''Linux''' или '''AIX''': | ||
Строка 26: | Строка 26: | ||
==Перезапуск OneAgent== | ==Перезапуск OneAgent== | ||
При использовании <code>set</code> параметров необходимо перезапустить службу | При использовании <code>set</code> параметров необходимо перезапустить службу OneAgent, чтобы изменения вступили в силу. Вы можете использовать параметр <code>--restart-service</code> с командой, которая автоматически запускает перезагрузку. В некоторых случаях вам также потребуется перезапустить отслеживаемые приложения. Вы также можете использовать параметр перезапуска сам по себе, без других параметров. См. пример команды ниже. | ||
'''Linux''' или '''AIX''': | '''Linux''' или '''AIX''': | ||
Строка 47: | Строка 47: | ||
<code>.\oneagentctl.exe --help</code> | <code>.\oneagentctl.exe --help</code> | ||
==Показать версию | ==Показать версию OneAgent== | ||
Используйте параметр <code>--version</code> для отображения версии | Используйте параметр <code>--version</code> для отображения версии OneAgent. | ||
'''Linux''' или '''AIX''': | '''Linux''' или '''AIX''': | ||
Строка 58: | Строка 58: | ||
<code>.\oneagentctl.exe --version</code> | <code>.\oneagentctl.exe --version</code> | ||
==Связь с | ==Связь с OneAgent== | ||
===Изменить настройки связи с | ===Изменить настройки связи с OneAgent=== | ||
<code> | <code>OneAgent версии 1.185</code> | ||
*Используйте параметр <code>--set-server</code>, чтобы задать конечную точку связи | *Используйте параметр <code>--set-server</code>, чтобы задать конечную точку связи OneAgent. Используйте IP-адрес или имя. В зависимости от вашего развертывания это может быть сервер Dynatrace, управляемый кластер Dynatrace или ActiveGate. | ||
*Используйте параметр <code>--set-tenant</code>, чтобы задать идентификатор среды. По умолчанию для него уже установлено правильное значение. Если вы продаете услуги на основе | *Используйте параметр <code>--set-tenant</code>, чтобы задать идентификатор среды. По умолчанию для него уже установлено правильное значение. Если вы продаете услуги на основе Dynatrace, используйте этот параметр, чтобы установить идентификаторы ваших клиентов из пула идентификаторов, приобретенных вами у Dynatrace. Всегда используйте в сочетании с параметром <code>--set-tenant-token</code>, который определяет токен клиента для внутренней проверки подлинности. | ||
*Используйте параметр <code>--set-tenant-token</code>, чтобы установить токен клиента, который используется для аутентификации связи с определенной конечной точкой. Всегда используйте в сочетании с <code>--set-tenant</code> | *Используйте параметр <code>--set-tenant-token</code>, чтобы установить токен клиента, который используется для аутентификации связи с определенной конечной точкой. Всегда используйте в сочетании с <code>--set-tenant</code> | ||
*Используйте параметр <code>--set-proxy</code> для установки прокси-сервера. | *Используйте параметр <code>--set-proxy</code> для установки прокси-сервера. | ||
Выполните следующую команду, чтобы настроить параметры подключения | Выполните следующую команду, чтобы настроить параметры подключения OneAgent: | ||
'''Linux''' или '''AIX''': | '''Linux''' или '''AIX''': | ||
Строка 78: | Строка 78: | ||
<code>.\oneagentctl.exe --set-server=<nowiki>https://my-server.com:443</nowiki> --set-tenant=abc123456 --set-tenant-token=abcdefg123456790 --set-proxy=my-proxy.com</code> | <code>.\oneagentctl.exe --set-server=<nowiki>https://my-server.com:443</nowiki> --set-tenant=abc123456 --set-tenant-token=abcdefg123456790 --set-proxy=my-proxy.com</code> | ||
Эти параметры требуют перезапуска | Эти параметры требуют перезапуска OneAgent, а также перезапуска всех приложений, отслеживаемых модулями глубокого кода. Добавьте <code>--restart-service</code> в команду для автоматического перезапуска OneAgent (версия 1.189+) или для остановки и запуска процесса OneAgent вручную. Инструкции для конкретных ОС см. в [[Остановить/перезапустить ЕдиныйАгент в Linux|Linux]], [[ЕдиныйАгент остановка/перезапуск в Windows|Windows]] или AIX. | ||
Эта команда немедленно изменит конечную точку подключения модуля ОС, но модули кода не смогут прочитать новую настройку до следующего перезапуска. | Эта команда немедленно изменит конечную точку подключения модуля ОС, но модули кода не смогут прочитать новую настройку до следующего перезапуска. | ||
OneAgent и Dynatrace Кластер автоматически поддерживают рабочее соединение. Если детали конечной точки изменяются, кластер уведомляет OneAgent об изменении, и OneAgent автоматически обновляет конечную точку, которую вы установили с помощью <code>--set-server</code>, до нового рабочего значения. | |||
===Показать текущие конечные точки связи=== | ===Показать текущие конечные точки связи=== | ||
<code> | <code>OneAgent версии 1.185</code> | ||
Используйте параметр <code>--get-server</code>, чтобы отобразить конечные точки, на которые | Используйте параметр <code>--get-server</code>, чтобы отобразить конечные точки, на которые OneAgent должен отправлять данные. Это может быть сервер Dynatrace, управляемый кластер Dynatrace или ActiveGate. | ||
'''Linux''' или '''AIX''': | '''Linux''' или '''AIX''': | ||
Строка 97: | Строка 97: | ||
<code>.\oneagentctl.exe --get-сервер</code> | <code>.\oneagentctl.exe --get-сервер</code> | ||
Начиная с | Начиная с OneAgent версии 1.207, конечные точки представляются в формате, в котором конечные точки с одинаковым приоритетом группируются с помощью фигурных скобок <code>({...})</code> и сортируются в соответствии с приоритетом подключения. Звездочка (<code>*</code>) указывает конечную точку, на которую OneAgent в данный момент отправляет данные. Конечные точки разделяются точкой с запятой (<code>;</code>). Например: | ||
{<nowiki>https://endpoint1.com/communication;https:/10.0.0.0/communication;*https://endpoint3.com/communication}{https://endpoint4.com:443/communication}</nowiki> | {<nowiki>https://endpoint1.com/communication;https:/10.0.0.0/communication;*https://endpoint3.com/communication}{https://endpoint4.com:443/communication}</nowiki> | ||
===Показать идентификатор среды=== | ===Показать идентификатор среды=== | ||
Идентификатор среды | Идентификатор среды Dynatrace, который вы получили по электронной почте с активацией. | ||
Используйте параметр <code>--get-tenant</code> для отображения идентификатора среды: | Используйте параметр <code>--get-tenant</code> для отображения идентификатора среды: | ||
Строка 125: | Строка 125: | ||
===Показать текущий прокси=== | ===Показать текущий прокси=== | ||
<code> | <code>OneAgent версии 1.185</code> | ||
Используйте параметр <code>--get-proxy</code>, чтобы отобразить текущий определенный прокси, через который | Используйте параметр <code>--get-proxy</code>, чтобы отобразить текущий определенный прокси, через который OneAgent подключается: | ||
'''Linux''' или '''AIX''': | '''Linux''' или '''AIX''': | ||
Строка 146: | Строка 146: | ||
'''Windows''': | '''Windows''': | ||
<code>.\oneagentctl.exe --set-proxy=</code> Перезапустите службу | <code>.\oneagentctl.exe --set-proxy=</code> Перезапустите службу OneAgent, чтобы изменения вступили в силу. | ||
===Проверить текущий диапазон портов=== | ===Проверить текущий диапазон портов=== | ||
OneAgent состоит из различных процессов, которые обмениваются данными через TCP-порт со сторожевым таймером. При запуске, сторожевой таймер OneAgent пытается открыть первый доступный порт между портами 50000 и 50100. В некоторых случаях вам может понадобиться этот порт для ваших собственных приложений, которые запускаются после OneAgent. | |||
Используйте параметр <code>--get-watchdog-portrange</code>, чтобы проверить текущий диапазон портов, определенный для сторожевого таймера. | Используйте параметр <code>--get-watchdog-portrange</code>, чтобы проверить текущий диапазон портов, определенный для сторожевого таймера. | ||
Строка 173: | Строка 173: | ||
==Автоматические обновления== | ==Автоматические обновления== | ||
<code> | <code>OneAgent версии 1.213</code> | ||
Дополнительные сведения см. в разделах по обновлению | Дополнительные сведения см. в разделах по обновлению OneAgent для [[Обновление ЕдиногоАгента в Linux|Linux]], [[Обновление ЕдиногоАгента КлючАстром в Windows|Windows]] и AIX. | ||
===Проверьте, включено ли автоматическое обновление=== | ===Проверьте, включено ли автоматическое обновление=== | ||
Используйте параметр <code>get-auto-update-enabled</code>, чтобы проверить, включено ли автоматическое обновление | Используйте параметр <code>get-auto-update-enabled</code>, чтобы проверить, включено ли автоматическое обновление OneAgent: | ||
'''Linux''' или '''AIX''': | '''Linux''' или '''AIX''': | ||
Строка 189: | Строка 189: | ||
===Включить или отключить автообновление=== | ===Включить или отключить автообновление=== | ||
Установите для параметра <code>--set-auto-update-enabled</code> значение <code>true</code> или <code>false</code>, чтобы отключить или включить автоматическое обновление | Установите для параметра <code>--set-auto-update-enabled</code> значение <code>true</code> или <code>false</code>, чтобы отключить или включить автоматическое обновление OneAgent: | ||
'''Linux''' или '''AIX''': | '''Linux''' или '''AIX''': | ||
Строка 199: | Строка 199: | ||
<code>.\oneagentctl.exe --set-auto-update-enabled=true</code> | <code>.\oneagentctl.exe --set-auto-update-enabled=true</code> | ||
'''Предупреждение''': после того, как вы используете эту команду для отключения автообновлений, вы не сможете управлять автоматическими обновлениями | '''Предупреждение''': после того, как вы используете эту команду для отключения автообновлений, вы не сможете управлять автоматическими обновлениями OneAgent с помощью веб-интерфейса Dynatrace в меню '''Настройки''' > '''Предпочтения''' > '''Обновления''' '''OneAgent'''. | ||
==Мониторинг логов== | ==Мониторинг логов== | ||
Строка 224: | Строка 224: | ||
'''Windows''': | '''Windows''': | ||
<code>.\oneagentctl.exe --set-app-log-content-access=true</code> Перезапустите службу | <code>.\oneagentctl.exe --set-app-log-content-access=true</code> Перезапустите службу OneAgent, чтобы применить изменения. | ||
==Создать архив поддержки== | ==Создать архив поддержки== | ||
<code> | <code>OneAgent версии 1.225+</code> | ||
Если у вас нет доступа к веб-интерфейсу | Если у вас нет доступа к веб-интерфейсу Dynatrace или вы хотите создать скрипт для сбора диагностических данных, вы можете использовать команду <code>oneagentctl</code> для сбора подмножества полных [[OneAgent диагностики|диагностических данных OneAgent]] прямо на хосте, где установлен OneAgent. С помощью диагностических данных, собранных для OneAgent, вы можете: | ||
*легко собирать диагностические данные для конкретного хоста | *легко собирать диагностические данные для конкретного хоста | ||
*напрямую предоставить службе поддержки | *напрямую предоставить службе поддержки Dynatrace детали, необходимые для диагностики проблемы | ||
Команда требует, чтобы служба | Команда требует, чтобы служба OneAgent была запущена. | ||
Чтобы создать архив поддержки с диагностическими данными, запустите <code>oneagentctl</code> с параметром <code>--create-support-archive</code>. По умолчанию архив поддержки содержит данные за 7-дневный период времени и создается в текущем рабочем каталоге. При желании вы можете установить собственный каталог и временной интервал с параметрами <code>каталога</code> и <code>дней</code>. Примечание: <code>onegentctl</code> не создает каталог; вы должны указать его на существующий каталог с относительным или абсолютным путем. Например: | Чтобы создать архив поддержки с диагностическими данными, запустите <code>oneagentctl</code> с параметром <code>--create-support-archive</code>. По умолчанию архив поддержки содержит данные за 7-дневный период времени и создается в текущем рабочем каталоге. При желании вы можете установить собственный каталог и временной интервал с параметрами <code>каталога</code> и <code>дней</code>. Примечание: <code>onegentctl</code> не создает каталог; вы должны указать его на существующий каталог с относительным или абсолютным путем. Например: | ||
Строка 253: | Строка 253: | ||
=== Содержание диагностических данных === | === Содержание диагностических данных === | ||
Все собранные диагностические данные сжимаются в архив <code>support_archive_agent_YYYY-MM-DD_hhmmss.zip</code>, который включает следующее подмножество полных диагностических данных | Все собранные диагностические данные сжимаются в архив <code>support_archive_agent_YYYY-MM-DD_hhmmss.zip</code>, который включает следующее подмножество полных диагностических данных OneAgent: | ||
{| class="wikitable" | {| class="wikitable" | ||
!Папка или файл | !Папка или файл | ||
Строка 259: | Строка 259: | ||
|- | |- | ||
|<code>support_archive</code> (ZIP) | |<code>support_archive</code> (ZIP) | ||
|Содержит локальную конфигурацию агента | |Содержит локальную конфигурацию агента OneAgent, установленного на узле или в процессе, в котором выполнялась процедура устранения неполадок, а также файлы журналов, связанные с OneAgent. | ||
|- | |- | ||
|<code>diagnostic_files</code> (ZIP) | |<code>diagnostic_files</code> (ZIP) | ||
|Содержит информацию об обнаружении группы процессов, проблемах автоматического внедрения и конфигурации расширения | |Содержит информацию об обнаружении группы процессов, проблемах автоматического внедрения и конфигурации расширения OneAgent. | ||
|} | |} | ||
== Доступ к системным журналам для проактивной поддержки == | == Доступ к системным журналам для проактивной поддержки == | ||
OneAgent загружает определенные системные журналы, чтобы Dynatrace мог диагностировать проблемы, которые могут быть вызваны условиями в вашей среде. Журналы также сохраняются в архиве поддержки. Чаще всего такие проблемы связаны с глубоким мониторингом или установками автоматического обновления. | |||
=== Проверьте, включен ли доступ к системным журналам. === | === Проверьте, включен ли доступ к системным журналам. === | ||
Строка 288: | Строка 288: | ||
'''Windows''': | '''Windows''': | ||
<code>.\oneagentctl.exe --set-system-logs-access-enabled=true</code> Перезапустите службу | <code>.\oneagentctl.exe --set-system-logs-access-enabled=true</code> Перезапустите службу OneAgent, чтобы изменения вступили в силу. | ||
Обратите внимание, что параметры --set-system-logs-access-enabled и --get-system-logs-access-enabled относятся к настройке самодиагностики и не связаны с мониторингом журналов. | Обратите внимание, что параметры --set-system-logs-access-enabled и --get-system-logs-access-enabled относятся к настройке самодиагностики и не связаны с мониторингом журналов. | ||
'''Примечание''': | '''Примечание''': | ||
Отключение доступа к системному журналу ограничивает наши возможности по упреждающей диагностике и устранению проблем. Если доступ к системным журналам закрыт, вам может потребоваться вручную предоставить | Отключение доступа к системному журналу ограничивает наши возможности по упреждающей диагностике и устранению проблем. Если доступ к системным журналам закрыт, вам может потребоваться вручную предоставить Dynatrace содержимое ваших системных журналов, чтобы мы могли диагностировать проблемы в вашей среде. | ||
== Идентификатор хоста == | |||
Dynatrace присваивает уникальный идентификатор каждому отслеживаемому узлу в вашей среде. Идентификаторы хостов можно использовать в качестве параметров в запросах Dynatrace API, например, Topology и Smartscape API — Hosts API. Идентификатор хоста также представляет собой URL-адрес страницы '''обзора хоста''', например, <code><nowiki>https://environment.org/#newhosts/hostdetails;id=HOST-6E56EE455C84E232</nowiki></code>. | |||
=== Показать свой идентификатор хоста === | |||
<code>OneAgent версии 1.197</code> | |||
Чтобы найти идентификатор хоста, используйте параметр <code>--get-host-id</code>. Например: | |||
'''Linux''' или '''AIX''': | |||
<code>./oneagentctl --get-host-id</code> | |||
'''Windows''': | |||
<code>.\oneagentctl.exe --get-host-id</code> | |||
=== Определите источник идентификатора хоста === | |||
Доступно на всех поддерживаемых платформах для OneAgent версии 1.223+. Для OneAgent версии 1.221 и более ранних эта функция поддерживается только для Citrix Virtual Apps and Desktops. | |||
Особенно важно сохранять статический идентификатор хоста в динамических виртуальных средах, где хосты воссоздаются ежедневно. | |||
Чтобы '''определить источник для генерации идентификатора хоста''', используйте <code>--set-host-id-source</code> и установите для него одно из предопределенных значений: | |||
* <code>auto</code> — разрешить Dynatrace автоматически генерировать идентификатор хоста. | |||
* <code>ip-addresses</code> — Сгенерируйте идентификатор хоста на основе IP-адреса хоста | |||
* <code>mac-addresses</code> — Сгенерируйте идентификатор хоста на основе MAC-адреса сетевого адаптера хоста. | |||
* <code>fqdn</code> — создание идентификатора узла на основе полного доменного имени узла (FQDN) в формате host.domain. Если полное доменное имя не содержит символа точки, вместо него используется MAC-адрес сетевой карты. | |||
* Если вы отслеживаете несколько сред, вы можете разделить узлы с одинаковыми IP-адресами, MAC-адресами или полными доменными именами, используя разные пространства имен для каждой среды. Пространство имен может содержать только буквенно-цифровые символы, дефисы, символы подчеркивания и точки; максимальная длина составляет 256 символов. | |||
** <code>ip-адреса;namespace=<пространство имен></code> | |||
** <code>mac-адреса; namespace=<пространство имен></code> | |||
** <code>fqdn;namespace=<пространство имен></code> | |||
Например, чтобы установить в качестве источника идентификатора хоста <code>ip-адреса</code> и назначить его пространству имен с именем <code>test</code>, запустите <code>oneagentctl</code> со следующим параметром: | |||
'''Linux''' или '''AIX''': | |||
<code>./oneagentctl --set-host-id-source="ip-addresses;namespace=test"</code> | |||
'''Windows''': | |||
<code>.\oneagentctl.exe --set-host-id-source="ip-addresses;namespace=test"</code> | |||
После изменения источника идентификатора хоста необходимо перезапустить все отслеживаемые приложения, а затем перезапустить службу OneAgent, чтобы создать новый объект хоста в вашей среде. Вы можете использовать параметр <code>--restart-service</code> с <code>oneagentctl</code> для автоматического перезапуска OneAgent или остановки и запуска процесса OneAgent вручную. Инструкции для конкретных ОС см. в [[Остановить/перезапустить ЕдиныйАгент в Linux|Linux]], [[ЕдиныйАгент остановка/перезапуск в Windows|Windows]] или AIX. | |||
Чтобы '''проверить источник идентификатора хоста''', используйте параметр <code>--get-host-id-source</code>: | |||
'''Linux''' или '''AIX''': | |||
<code>./oneagentctl --get-host-id-source</code> | |||
'''Windows''': | |||
<code>.\oneagentctl.exe --get-host-id-source</code> | |||
Для источника идентификатора хоста, заданного для <code>ip-адресов</code> и пространства имен <code>test</code>, команда вернет следующий результат: | |||
ip-addresses;namespace=test | |||
== Группы хостов == | |||
Обзор того, как использовать группы узлов, см. в разделе Организация среды с помощью групп узлов. | |||
=== Изменить назначение группы хостов === | |||
Используйте параметр <code>--set-host-group</code>, чтобы изменить назначение группы хостов. | |||
Чтобы назначить хост <code>MyHostGroup</code>: | |||
'''Linux''' или '''AIX''': | |||
<code>./oneagentctl --set-host-group=MyHostGroup</code> | |||
'''Windows''': | |||
<code>.\oneagentctl.exe --set-host-group=MyHostGroup</code> | |||
Требования к строке группы хостов: | |||
* Может содержать только буквенно-цифровые символы, дефисы, символы подчеркивания и точки. | |||
* Не должен начинаться с dt. | |||
* Максимальная длина – 100 символов. | |||
Использование <code>--set-host-group</code> требует перезапуска OneAgent, а также перезапуска всех отслеживаемых служб. Добавьте <code>--restart-service</code> в команду для автоматического перезапуска OneAgent (версия 1.189+) или для остановки и запуска процесса OneAgent вручную. Инструкции для конкретных ОС см. в [[Остановить/перезапустить ЕдиныйАгент в Linux|Linux]], [[ЕдиныйАгент остановка/перезапуск в Windows|Windows]] или AIX. | |||
=== Очистить назначение группы хостов === | |||
Используйте параметр <code>--set-host-group</code> с пустым значением, чтобы очистить назначение группы хостов: | |||
'''Linux''' или '''AIX''': | |||
<code>./oneagentctl --set-host-group=</code> | |||
'''Windows''': | |||
<code>.\oneagentctl.exe --set-host-group=</code> | |||
=== Показать назначение группы хостов === | |||
Используйте параметр <code>--get-host-group</code> для отображения текущего назначения группы хостов: | |||
'''Linux''' или '''AIX''': | |||
<code>./oneagentctl --get-host-group</code> | |||
'''Windows''': | |||
<code>.\oneagentctl.exe --get-host-group</code> | |||
== Теги хоста и метаданные == | |||
В динамических или больших средах ручная пометка узлов может оказаться нецелесообразной. Для динамических развертываний, включающих часто меняющиеся экземпляры и имена хостов (например, AWS или MS Azure), вы можете использовать выделенные параметры <code>oneagentctl</code> для применения пользовательских тегов, имен и метаданных к вашим хостам. | |||
Перечисленные ниже методы <code>oneagentctl</code> позволяют редактировать только метаданные, добавленные с помощью самого oneagentctl или ранее с помощью файлов конфигурации. Теги и метаданные, добавленные с помощью веб-интерфейса Dynatrace, а также извлеченные из контролируемой среды (например, теги AWS), не редактируются с помощью <code>oneagentctl</code> и не будут отображаться с помощью параметров<code>--get-host-tags</code> и <code>--get-host-properties</code>. | |||
=== Пользовательское имя хоста === | |||
Используйте инструмент командной строки <code>oneagentctl</code> с параметром <code>--set-host-name</code>, чтобы переопределить автоматически обнаруженное имя хоста. Имя хоста не должно содержать символы <code><</code>, <code>></code>, <code>&</code>, <code>CR</code> (возврат каретки) или <code>LF</code> (перевод строки). Максимальная длина 256 символов. | |||
'''Важно''': Эта команда добавляет пользовательское имя хоста для отображения в пользовательском интерфейсе, но обнаруженное имя хоста не изменяется. Дополнительные сведения см. в разделе Установка пользовательских имен хостов. | |||
Чтобы изменить имя хоста: | |||
'''Linux''' или '''AIX''': <code>./oneagentctl --set-host-name=myhostname</code> | |||
'''Windows''': <code>.\oneagentctl.exe --set-host-name=myhostname</code> | |||
Чтобы вернуться к автоматически определенному имени хоста, установите для параметра <code>--set-host-name</code> пустое значение, как в <code>--set-host-name=""</code>. Например: | |||
'''Linux''' или '''AIX''': <code>./oneagentctl --set-host-name=""</code> | |||
'''Windows''': <code>.\oneagentctl.exe --set-host-name=""</code> | |||
Изменение может не отображаться в веб-интерфейсе Dynatrace до 6 минут. | |||
Использование <code>--set-host-name</code> требует перезапуска OneAgent. Добавьте <code>--restart-service</code> в команду для автоматического перезапуска OneAgent (версия 1.189+) или для остановки и запуска процесса OneAgent вручную. Инструкции для конкретных ОС см. в [[Остановить/перезапустить ЕдиныйАгент в Linux|Linux]], [[ЕдиныйАгент остановка/перезапуск в Windows|Windows]] или AIX. | |||
Чтобы показать имя хоста: | |||
'''Linux''' или '''AIX''': | |||
<code>./oneagentctl --get-host-name</code> | |||
'''Windows''': | |||
<code>.\oneagentctl.exe --get-host-name</code> | |||
=== Пользовательские метаданные хоста === | |||
После настройки настраиваемые метаданные отображаются в виде набора свойств в нижней части раздела «'''Свойства и теги'''» на странице обзора хоста. Значения свойств не должны содержать символ <code>=</code> (если только он не используется в качестве разделителя значения ключа) или пробельные символы. Максимальная длина — 256 символов, включая разделитель «ключ-значение». Имя ключа не должно начинаться с символа <code>#</code>. | |||
Для версий до 1.189 используйте файл конфигурации метаданных хоста. | |||
Чтобы '''добавить или изменить свойства хоста''', выполните следующую команду: | |||
'''Linux''' или '''AIX''': | |||
<code>./oneagentctl --set-host-property=AppName --set-host-property=Environment=Dev</code> | |||
'''Windows''': | |||
<code>.\oneagentctl.exe --set-host-property=AppName --set-host-property Environment=Dev</code> | |||
Вы можете добавить или изменить более одного свойства в одной команде. | |||
Чтобы '''удалить свойства хоста''', выполните следующую команду: | |||
'''Linux''' или '''AIX''': | |||
<code>./oneagentctl --remove-host-property=AppName --remove-host-property=Environment=Dev</code> | |||
'''Windows''': | |||
<code>.\oneagentctl.exe --remove-host-property=AppName --remove-host-property=Environment=Dev</code> | |||
Вы можете удалить более одного свойства с помощью одной команды. Если ключ свойства, переданный в команду, не существует, будет возвращен ненулевой код выхода, но все существующие свойства, переданные в команде, будут удалены. После удаления свойств хоста они остаются видимыми в веб-интерфейсе Dynatrace до 7 часов. | |||
Чтобы <code>отобразить все свойства</code>, настроенные для хоста, выполните следующую команду: | |||
'''Linux''' или '''AIX''': | |||
<code>./oneagentctl --get-host-properties</code> | |||
'''Windows''': | |||
<code>.\oneagentctl.exe --get-host-properties</code> | |||
=== Пользовательские теги хоста === | |||
После настройки пользовательских тегов хоста они отображаются в верхней части раздела «'''Свойства и теги'''» на странице обзора хоста. Значение свойства не должно содержать <code>=</code> (если только оно не используется в качестве разделителя значений ключа) или пробельные символы. Максимальная длина — 256 символов, включая разделитель «ключ-значение». Имя ключа не должно начинаться с <code>#</code>. | |||
Чтобы '''добавить или изменить''' теги хоста, выполните следующую команду: | |||
'''Linux''' или '''AIX''': | |||
<code>./oneagentctl --set-host-tag=TestHost --set-host-tag=role=fallback --set-host-tag=Gdansk</code> | |||
'''Windows''': | |||
<code>.\oneagentctl.exe --set-host-tag=TestHost --set-host-tag=role=fallback --set-host-tag=Gdansk</code> | |||
Вы можете добавить или изменить более одного тега в одной команде. Допускается определение тегов с одним и тем же ключом, но разными значениями. | |||
Чтобы '''удалить теги''', выполните следующую команду: | |||
'''Linux''' или '''AIX''': | |||
<code>./oneagentctl --remove-host-tag=role=fallback --remove-host-tag=Gdansk</code> | |||
'''Windows''': | |||
<code>.\oneagentctl.exe --remove-host-tag=role=fallback --remove-host-tag=Gdansk</code> | |||
Вы можете удалить более одного тега с помощью одной и той же команды. Если тег, переданный в команде, не существует, возвращается ненулевой код выхода, но все существующие теги, переданные в команде, удаляются. После удаления теги остаются видимыми в веб-интерфейсе Dynatrace до 6 часов. | |||
Чтобы '''отобразить все теги''', настроенные для хоста, выполните следующую команду: | |||
'''Linux''' или '''AIX''': | |||
<code>./oneagentctl --get-host-tags</code> | |||
'''Windows''': | |||
<code>.\oneagentctl.exe --get-host-tags</code> | |||
== Мониторинг инфраструктуры == | |||
Используйте режим мониторинга инфраструктуры вместо режима мониторинга полного стека. При таком подходе вы получаете данные о работоспособности только инфраструктуры, без данных о производительности приложений или пользователей. Дополнительные сведения см. в разделе Мониторинг инфраструктуры. | |||
=== Проверьте, включен ли режим мониторинга инфраструктуры === | |||
Используйте параметр <code>--get-infra-only</code>, чтобы проверить, включен ли режим мониторинга инфраструктуры: | |||
'''Linux''' или '''AIX''': | |||
<code>./oneagentctl --get-infra-only</code> | |||
'''Windows''': | |||
<code>.\oneagentctl.exe --get-infra-only</code> | |||
=== Включить или отключить режим мониторинга инфраструктуры === | |||
Установите для параметра <code>--set-infra-only</code> значение <code>true</code> или <code>false</code>, чтобы включить или отключить режим мониторинга инфраструктуры. | |||
Чтобы включить режим мониторинга инфраструктуры: | |||
'''Linux''' или '''AIX''': | |||
<code>./oneagentctl --set-infra-only=true</code> | |||
'''Windows''': | |||
<code>.\oneagentctl.exe --set-infra-only=true</code> | |||
Изменение режима мониторинга инфраструктуры требует перезапуска OneAgent, а также перезапуска всех отслеживаемых служб. Добавьте <code>--restart-service</code> в команду для автоматического перезапуска OneAgent (версия 1.189+) или для остановки и запуска процесса OneAgent вручную. Инструкции для конкретных ОС см. в [[Остановить/перезапустить ЕдиныйАгент в Linux|Linux]], [[ЕдиныйАгент остановка/перезапуск в Windows|Windows]] или AIX. | |||
=== Автоматическая инъекция в мониторинге инфраструктуры === | |||
<code>OneAgent версии 1.213</code> | |||
Автоматическое внедрение OneAgent включено по умолчанию в режиме мониторинга инфраструктуры, чтобы получать и сообщать показатели JMX/PMI. | |||
Дополнительные сведения см. в разделе Режим мониторинга инфраструктуры. | |||
=== Проверьте, включена ли автоинъекция === | |||
Используйте параметр <code>get-auto-injection-enabled</code>, чтобы проверить, включено ли автоматическое внедрение OneAgent: | |||
'''Linux''' или '''AIX''': | |||
<code>./oneagentctl --get-auto-injection-enabled</code> | |||
'''Windows''': | |||
<code>.\oneagentctl.exe --get-auto-injection-enabled</code> | |||
=== Включить или отключить автоинъекцию === | |||
Установите для параметра <code>--set-auto-injection-enabled</code> значение <code>true</code> или <code>false</code>, чтобы включить или отключить автоматическую инъекцию OneAgent: | |||
Чтобы включить автоинъекции: | |||
'''Linux''' или '''AIX''': | |||
<code>./oneagentctl --set-auto-injection-enabled=true</code> | |||
'''Windows''': | |||
<code>.\oneagentctl.exe --set-auto-injection-enabled=true</code> | |||
Чтобы отключить автоинъекции: | |||
'''Linux''' или '''AIX''': | |||
<code>./oneagentctl --set-auto-injection-enabled=false</code> | |||
'''Windows''': | |||
<code>.\oneagentctl.exe --set-auto-injection-enabled=false</code> | |||
Дополнительные сведения см. в разделе Отключение автоматического внедрения. | |||
== Прием метрик == | |||
<code>OneAgent версии 1.201</code> | |||
Прием локальных метрик в настоящее время поддерживается только в Windows и Linux. | |||
Вы можете использовать команду <code>oneagentctl</code> для проверки или изменения портов связи, используемых для локального приема метрик, с помощью API метрик OneAgent, интеграции сценариев, Telegraf или Dynatrace Statsd. Для изменения порта приема метрик требуется перезапуск OneAgent. Добавьте <code>--restart-service</code> в команду для автоматического перезапуска OneAgent. | |||
Дополнительные сведения см. в разделе Прием метрик. | |||
=== API OneAgent, интеграция сценариев и Telegraf === | |||
Порт приема метрик по умолчанию — 14499. При необходимости вы можете использовать команду <code>oneagentctl</code>, чтобы проверить или изменить порт. Для изменения порта приема метрик требуется перезапуск OneAgent. Добавьте <code>--restart-service</code> в команду для автоматического перезапуска OneAgent. | |||
=== Проверьте порт приема === | |||
Используйте параметр <code>--get-extensions-ingest-port</code>, чтобы отобразить текущий локальный порт приема, по умолчанию <code>14499</code>. | |||
'''Linux''': <code>./oneagentctl --get-extensions-ingest-port</code> | |||
'''Windows''': <code>.\oneagentctl.exe --get-extensions-ingest-port</code> | |||
=== Установите собственный порт приема === | |||
Используйте параметр <code>--set-extensions-ingest-port=<arg></code>, чтобы задать собственный локальный порт приема. | |||
'''Linux''': <code>./oneagentctl --set-extensions-ingest-port=14499 --restart-service</code> | |||
'''Windows''': <code>.\oneagentctl.exe --set-extensions-ingest-port=14499 --restart-service</code> | |||
=== Настроить прокси === | |||
Настройте прокси-сервер хоста, чтобы разрешить трафику локального хоста идти на порт приема метрик, по умолчанию <code>14499</code>. | |||
=== StatsD === | |||
=== Прослушиватель OneAgent === | |||
Порт прослушивания UDP Dynatrace StatsD по умолчанию для прослушивателя OneAgent— <code>18125</code>. При необходимости можно использовать команду <code>oneagentctl</code>, чтобы проверить или изменить порт приема метрик. Изменение порта требует перезапуска OneAgent. Добавьте <code>--restart-service</code> в команду для автоматического перезапуска OneAgent. | |||
==== Проверьте порт приема ==== | |||
Используйте параметр <code>--get-extensions-statsd-port</code>, чтобы показать текущий порт прослушивания UDP Dynatrace StatsD (по умолчанию = <code>18125</code>). | |||
'''Linux''': <code>./oneagentctl --get-extensions-statsd-port</code> | |||
'''Windows''': <code>.\oneagentctl.exe --get-extensions-statsd-port</code> | |||
==== Установите собственный порт приема ==== | |||
Используйте параметр <code>--set-extensions-statsd-port=<arg></code>, чтобы установить собственный порт прослушивания UDP Dynatrace StatsD. | |||
'''Linux''': <code>./oneagentctl --set-extensions-statsd-port=18125 --restart-service</code> | |||
'''Windows''': <code>.\oneagentctl.exe --set-extensions-statsd-port=18125 --restart-service</code> | |||
=== Удаленная статистикаD === | |||
Порт прослушивания UDP Dynatrace StatsD по умолчанию для удаленного прослушивателя — <code>18126</code>. | |||
Чтобы изменить порт прослушивания по умолчанию <code>18126</code>, измените параметр <code>StatsdPort</code> в файле extensionsuser.conf ActiveGate: | |||
'''Linux''' <code>/var/lib/AstromKey/remotepluginmodule/agent/conf/extensionsuser.conf</code> | |||
'''Windows''' <code>C:\ProgramData\AstromKey\remotepluginmodule\agent\conf\extensionsuser.conf</code>: | |||
StatsdPort=18126 | |||
== Сетевые зоны == | |||
Чтобы узнать о правилах именования сетевых зон и другую справочную информацию, см. раздел [[Сетевые зоны]]. | |||
=== Установить сетевую зону === | |||
Используйте параметр <code>--set-network-zone</code>, чтобы указать OneAgent обмениваться данными через указанную сетевую зону. Имя сетевой зоны представляет собой строку буквенно-цифровых символов. Вы также можете использовать дефисы (<code>-</code>), символы подчеркивания (<code>_</code>) и точку (<code>.</code>) в качестве разделителя. Имя сетевой зоны не должно начинаться с точки. Длина строки ограничена 256 символами. Имена сетевых зон не чувствительны к регистру. Dynatrace хранит эти имена в нижнем регистре. Дополнительные сведения см. в разделе об именовании зон сети. | |||
В '''Linux''' или '''AIX''': | |||
<code>./oneagentctl --set-network-zone=<your.network.zone></code> | |||
В '''Windows''': | |||
<code>.\oneagentctl.exe --set-network-zone=<your.network.zone></code> | |||
==== Сбросить сетевую зону ==== | |||
Вы можете сбросить настройку сетевой зоны, передав пустое имя сетевой зоны: | |||
В '''Linux''' или '''AIX''': | |||
<code>./oneagentctl --set-network-zone=""</code> | |||
В '''Windows''': | |||
<code>.\oneagentctl.exe --set-network-zone=""</code> | |||
=== Показать настройки зоны сети === | |||
Используйте параметр <code>--get-network-zone</code> для отображения текущей конфигурации сетевой зоны: | |||
В '''Linux''' или '''AIX''': | |||
<code>./oneagentctl --get-network-zone</code> | |||
В '''Windows''': | |||
<code>.\oneagentctl.exe --get-network-zone</code> | |||
== Передача параметров конфигурации во время установки == | |||
Вы можете передать параметры <code>--set-*</code> во время установки. Параметры конфигурации применяются непосредственно перед запуском службы OneAgent, и нет необходимости перезапускать ее, чтобы применить вашу конфигурацию. | |||
=== Linux или AIX === | |||
Чтобы пройти через параметры конфигурации, просто добавьте параметр и поставьте перед значением знак равенства (<code>=</code>). Например: | |||
/bin/sh OneAgent-Linux.sh –-set-host-group=test_group | |||
=== Windows === | |||
==== EXE установщик ==== | |||
Чтобы передать параметры конфигурации с помощью установщика EXE, просто добавьте параметр и поставьте перед значением знак равенства (<code>=</code>). Например: | |||
OneAgent-Windows.exe --set-host-group=test_group | |||
==== MSI-пакет ==== | |||
Вы также можете передать параметры конфигурации с помощью пакета MSI. Однако на этот раз вы должны использовать дополнительный параметр <code>ADDITIONAL_CONFIGURATION</code>. Например: | |||
OneAgent-Windows.msi ADDITIONAL_CONFIGURATION="--set-host-group=test_group" | |||
== Криптографические алгоритмы FIPS 140 == | |||
<code>OneAgent версии 1.245+</code> | |||
OneAgent использует режим FIPS для обеспечения соответствия стандарту компьютерной безопасности FIPS 140-3. | |||
=== Проверьте, включен ли FIPS 140. === | |||
Используйте <code>--get-fips-enabled</code>, чтобы проверить, использует ли OneAgent проверенные криптографические алгоритмы FIPS 140. | |||
В '''Linux''' или '''AIX''' | |||
<code>./oneagentctl --get-fips-enabled</code> | |||
В '''Windows''' | |||
<code>./oneagentctl.exe --get-fips-enabled</code> | |||
=== Включить или отключить FIPS 140 === | |||
Установите для параметра <code>--set-fips-enabled</code> значение <code>true</code> или <code>false</code>, чтобы включить или отключить проверенные криптографические алгоритмы FIPS 140 в OneAgent. | |||
Чтобы включить режим FIPS: | |||
В '''Linux''' или '''AIX''' | |||
<code>./oneagentctl --set-fips-enabled=true</code> | |||
В '''Windows''' | |||
<code>./oneagentctl.exe --set-fips-enabled=true</code> | |||
Чтобы отключить режим FIPS: | |||
В '''Linux''' или '''AIX''' | |||
<code>/oneagentctl --set-fips-enabled=false</code> | |||
В '''Windows''' | |||
<code>./oneagentctl.exe --set-fips-enabled=false</code> | |||
Если вы хотите включить режим FIPS для развертывания только приложений, перейдите в <code>/paas/package/agent</code> и удалите <code>dt_fips_disabled.flag</code>. |
Текущая версия на 11:29, 22 января 2023
Используйте интерфейс командной строки oneagentctl
для выполнения некоторых настроек OneAgent после установки на уровне отдельного хоста.
Расположение
Расположение инструмента зависит от того, настроили ли вы установку OneAgent с помощью параметра <INSTALL_PATH>
:
Linux или AIX:
<INSTALL_PATH>/agent/tools
Вам нужны root-права.
Развертывание на основе Docker
<INSTALL_PATH>/agent/tools
Обратите внимание, что этот путь будет отличаться для развертывания на основе тома.
Windows:
<INSTALL_PATH>\agent\tools
Вам нужны права администратора. Если вы попытаетесь запустить oneagentctl
в консоли Windows без прав администратора, Windows отобразит всплывающее окно контроля учетных записей и завершится ошибкой.
Типы параметров
Команда oneagentctl
принимает параметр get
для проверки состояния или значения параметра и параметр set
для изменения параметра. Обратите внимание, что вы можете использовать несколько заданных параметров в одной команде.
Перезапуск OneAgent
При использовании set
параметров необходимо перезапустить службу OneAgent, чтобы изменения вступили в силу. Вы можете использовать параметр --restart-service
с командой, которая автоматически запускает перезагрузку. В некоторых случаях вам также потребуется перезапустить отслеживаемые приложения. Вы также можете использовать параметр перезапуска сам по себе, без других параметров. См. пример команды ниже.
Linux или AIX:
./oneagentctl --set-proxy=my-proxy.com --restart-service
Windows:
.\oneagentctl.exe --set-proxy=my-proxy.com --restart-service
Показать справку
Используйте параметр --help
для отображения всех поддерживаемых параметров.
Linux или AIX:
./oneagentctl --help
Windows:
.\oneagentctl.exe --help
Показать версию OneAgent
Используйте параметр --version
для отображения версии OneAgent.
Linux или AIX:
./oneagentctl --version
Windows:
.\oneagentctl.exe --version
Связь с OneAgent
Изменить настройки связи с OneAgent
OneAgent версии 1.185
- Используйте параметр
--set-server
, чтобы задать конечную точку связи OneAgent. Используйте IP-адрес или имя. В зависимости от вашего развертывания это может быть сервер Dynatrace, управляемый кластер Dynatrace или ActiveGate. - Используйте параметр
--set-tenant
, чтобы задать идентификатор среды. По умолчанию для него уже установлено правильное значение. Если вы продаете услуги на основе Dynatrace, используйте этот параметр, чтобы установить идентификаторы ваших клиентов из пула идентификаторов, приобретенных вами у Dynatrace. Всегда используйте в сочетании с параметром--set-tenant-token
, который определяет токен клиента для внутренней проверки подлинности. - Используйте параметр
--set-tenant-token
, чтобы установить токен клиента, который используется для аутентификации связи с определенной конечной точкой. Всегда используйте в сочетании с--set-tenant
- Используйте параметр
--set-proxy
для установки прокси-сервера.
Выполните следующую команду, чтобы настроить параметры подключения OneAgent:
Linux или AIX:
./oneagentctl --set-server=https://my-server.com:443 --set-tenant=abc123456 --set-tenant-token=abcdefg123456790 --set-proxy=my-proxy.com
Windows:
.\oneagentctl.exe --set-server=https://my-server.com:443 --set-tenant=abc123456 --set-tenant-token=abcdefg123456790 --set-proxy=my-proxy.com
Эти параметры требуют перезапуска OneAgent, а также перезапуска всех приложений, отслеживаемых модулями глубокого кода. Добавьте --restart-service
в команду для автоматического перезапуска OneAgent (версия 1.189+) или для остановки и запуска процесса OneAgent вручную. Инструкции для конкретных ОС см. в Linux, Windows или AIX.
Эта команда немедленно изменит конечную точку подключения модуля ОС, но модули кода не смогут прочитать новую настройку до следующего перезапуска.
OneAgent и Dynatrace Кластер автоматически поддерживают рабочее соединение. Если детали конечной точки изменяются, кластер уведомляет OneAgent об изменении, и OneAgent автоматически обновляет конечную точку, которую вы установили с помощью --set-server
, до нового рабочего значения.
Показать текущие конечные точки связи
OneAgent версии 1.185
Используйте параметр --get-server
, чтобы отобразить конечные точки, на которые OneAgent должен отправлять данные. Это может быть сервер Dynatrace, управляемый кластер Dynatrace или ActiveGate.
Linux или AIX:
./oneagentctl --get-server
Windows:
.\oneagentctl.exe --get-сервер
Начиная с OneAgent версии 1.207, конечные точки представляются в формате, в котором конечные точки с одинаковым приоритетом группируются с помощью фигурных скобок ({...})
и сортируются в соответствии с приоритетом подключения. Звездочка (*
) указывает конечную точку, на которую OneAgent в данный момент отправляет данные. Конечные точки разделяются точкой с запятой (;
). Например:
{https://endpoint1.com/communication;https:/10.0.0.0/communication;*https://endpoint3.com/communication}{https://endpoint4.com:443/communication}
Показать идентификатор среды
Идентификатор среды Dynatrace, который вы получили по электронной почте с активацией.
Используйте параметр --get-tenant
для отображения идентификатора среды:
Linux или AIX:
./oneagentctl --get-tenant
Windows:
.\oneagentctl.exe --get-tenant
Показать токен арендатора
Используйте параметр --get-tenant-token
для отображения текущего определенного токена:
Linux или AIX:
./oneagentctl --get-tenant-token
Windows:
.\oneagentctl.exe --get-tenant-token
Показать текущий прокси
OneAgent версии 1.185
Используйте параметр --get-proxy
, чтобы отобразить текущий определенный прокси, через который OneAgent подключается:
Linux или AIX:
./oneagentctl --get-proxy
Windows:
.\oneagentctl.exe --get-proxy
Очистить конфигурацию прокси
Используйте для параметра --set-proxy
пустое значение, чтобы очистить конфигурацию прокси:
Linux или AIX:
./oneagentctl --set-proxy=
Windows:
.\oneagentctl.exe --set-proxy=
Перезапустите службу OneAgent, чтобы изменения вступили в силу.
Проверить текущий диапазон портов
OneAgent состоит из различных процессов, которые обмениваются данными через TCP-порт со сторожевым таймером. При запуске, сторожевой таймер OneAgent пытается открыть первый доступный порт между портами 50000 и 50100. В некоторых случаях вам может понадобиться этот порт для ваших собственных приложений, которые запускаются после OneAgent.
Используйте параметр --get-watchdog-portrange
, чтобы проверить текущий диапазон портов, определенный для сторожевого таймера.
Linux или AIX:
./oneagentctl --get-watchdog-portrange
Windows:
.\oneagentctl.exe --get-watchdog-portrange
Установить новый диапазон портов
Используйте параметр --set-watchdog-portrange=arg
, чтобы изменить диапазон портов прослушивания сторожевого таймера на <arg>
. <arg>
должен содержать два номера порта, разделенных двоеточием (:
). Например 50000:50100
. Максимальный поддерживаемый диапазон портов — от 1024 до 65535. Диапазон портов должен охватывать не менее 4 портов. Номер порта, начиная с диапазона, должен быть меньше.
Linux или AIX:
./oneagentctl --set-watchdog-portrange=50000:50100
Windows:
.\oneagentctl.exe --set-watchdog-portrange=50000:50100
Автоматические обновления
OneAgent версии 1.213
Дополнительные сведения см. в разделах по обновлению OneAgent для Linux, Windows и AIX.
Проверьте, включено ли автоматическое обновление
Используйте параметр get-auto-update-enabled
, чтобы проверить, включено ли автоматическое обновление OneAgent:
Linux или AIX:
./oneagentctl --get-auto-update-enabled
Windows:
.\oneagentctl.exe --get-auto-update-enabled
Включить или отключить автообновление
Установите для параметра --set-auto-update-enabled
значение true
или false
, чтобы отключить или включить автоматическое обновление OneAgent:
Linux или AIX:
./oneagentctl --set-auto-update-enabled=true
Windows:
.\oneagentctl.exe --set-auto-update-enabled=true
Предупреждение: после того, как вы используете эту команду для отключения автообновлений, вы не сможете управлять автоматическими обновлениями OneAgent с помощью веб-интерфейса Dynatrace в меню Настройки > Предпочтения > Обновления OneAgent.
Мониторинг логов
Дополнительные сведения см. в разделе Мониторинг логов. Примечание. Мониторинг логов не поддерживается в AIX.
Проверьте, включен ли Мониторинг логов
Используйте параметр --get-app-log-content-access
, чтобы проверить, включен ли мониторинг журналов:
Linux:
./oneagentctl --get-app-log-content-access
Windows:
.\oneagentctl.exe --get-app-log-content-access
Включить или отключить мониторинг журналов
Установите для параметра --set-app-log-content-access
значение true
или false
, чтобы отключить или включить Мониторинг логов:
Linux:
./oneagentctl --set-app-log-content-access=true
Windows:
.\oneagentctl.exe --set-app-log-content-access=true
Перезапустите службу OneAgent, чтобы применить изменения.
Создать архив поддержки
OneAgent версии 1.225+
Если у вас нет доступа к веб-интерфейсу Dynatrace или вы хотите создать скрипт для сбора диагностических данных, вы можете использовать команду oneagentctl
для сбора подмножества полных диагностических данных OneAgent прямо на хосте, где установлен OneAgent. С помощью диагностических данных, собранных для OneAgent, вы можете:
- легко собирать диагностические данные для конкретного хоста
- напрямую предоставить службе поддержки Dynatrace детали, необходимые для диагностики проблемы
Команда требует, чтобы служба OneAgent была запущена.
Чтобы создать архив поддержки с диагностическими данными, запустите oneagentctl
с параметром --create-support-archive
. По умолчанию архив поддержки содержит данные за 7-дневный период времени и создается в текущем рабочем каталоге. При желании вы можете установить собственный каталог и временной интервал с параметрами каталога
и дней
. Примечание: onegentctl
не создает каталог; вы должны указать его на существующий каталог с относительным или абсолютным путем. Например:
Linux или AIX:
./oneagentctl --create-support-archive directory=/data/support-archive days=30
Windows:
.\oneagentctl.exe --create-support-archive directory=C:\data\support-archive days=30
Команда сохраняет архив как файл support_archive_agent_YYYY-MM-DD_hhmmss.zip
. Например:
Creating support archive from last 30 days in C:\data\support-archive Waiting 30s for archive request to be processed Processing archive, waiting up to 15m 0s Archive saved as C:\data\support-archive\support_archive_agent_2021-09-07_121619.zip
Содержание диагностических данных
Все собранные диагностические данные сжимаются в архив support_archive_agent_YYYY-MM-DD_hhmmss.zip
, который включает следующее подмножество полных диагностических данных OneAgent:
Папка или файл | Описание |
---|---|
support_archive (ZIP)
|
Содержит локальную конфигурацию агента OneAgent, установленного на узле или в процессе, в котором выполнялась процедура устранения неполадок, а также файлы журналов, связанные с OneAgent. |
diagnostic_files (ZIP)
|
Содержит информацию об обнаружении группы процессов, проблемах автоматического внедрения и конфигурации расширения OneAgent. |
Доступ к системным журналам для проактивной поддержки
OneAgent загружает определенные системные журналы, чтобы Dynatrace мог диагностировать проблемы, которые могут быть вызваны условиями в вашей среде. Журналы также сохраняются в архиве поддержки. Чаще всего такие проблемы связаны с глубоким мониторингом или установками автоматического обновления.
Проверьте, включен ли доступ к системным журналам.
Используйте параметр --get-system-logs-access-enabled
, чтобы проверить, включен ли доступ к системным журналам:
Linux или AIX:
./oneagentctl --get-system-logs-access-enabled
Windows:
.\oneagentctl.exe --get-system-logs-access-enabled
Включить или отключить доступ к системным журналам
Установите для параметра --set-system-logs-access-enabled
значение true
или false
, чтобы отключить или включить доступ к системным журналам:
Linux или AIX:
./oneagentctl --set-system-logs-access-enabled=true
Windows:
.\oneagentctl.exe --set-system-logs-access-enabled=true
Перезапустите службу OneAgent, чтобы изменения вступили в силу.
Обратите внимание, что параметры --set-system-logs-access-enabled и --get-system-logs-access-enabled относятся к настройке самодиагностики и не связаны с мониторингом журналов.
Примечание: Отключение доступа к системному журналу ограничивает наши возможности по упреждающей диагностике и устранению проблем. Если доступ к системным журналам закрыт, вам может потребоваться вручную предоставить Dynatrace содержимое ваших системных журналов, чтобы мы могли диагностировать проблемы в вашей среде.
Идентификатор хоста
Dynatrace присваивает уникальный идентификатор каждому отслеживаемому узлу в вашей среде. Идентификаторы хостов можно использовать в качестве параметров в запросах Dynatrace API, например, Topology и Smartscape API — Hosts API. Идентификатор хоста также представляет собой URL-адрес страницы обзора хоста, например, https://environment.org/#newhosts/hostdetails;id=HOST-6E56EE455C84E232
.
Показать свой идентификатор хоста
OneAgent версии 1.197
Чтобы найти идентификатор хоста, используйте параметр --get-host-id
. Например:
Linux или AIX:
./oneagentctl --get-host-id
Windows:
.\oneagentctl.exe --get-host-id
Определите источник идентификатора хоста
Доступно на всех поддерживаемых платформах для OneAgent версии 1.223+. Для OneAgent версии 1.221 и более ранних эта функция поддерживается только для Citrix Virtual Apps and Desktops.
Особенно важно сохранять статический идентификатор хоста в динамических виртуальных средах, где хосты воссоздаются ежедневно.
Чтобы определить источник для генерации идентификатора хоста, используйте --set-host-id-source
и установите для него одно из предопределенных значений:
auto
— разрешить Dynatrace автоматически генерировать идентификатор хоста.ip-addresses
— Сгенерируйте идентификатор хоста на основе IP-адреса хостаmac-addresses
— Сгенерируйте идентификатор хоста на основе MAC-адреса сетевого адаптера хоста.fqdn
— создание идентификатора узла на основе полного доменного имени узла (FQDN) в формате host.domain. Если полное доменное имя не содержит символа точки, вместо него используется MAC-адрес сетевой карты.- Если вы отслеживаете несколько сред, вы можете разделить узлы с одинаковыми IP-адресами, MAC-адресами или полными доменными именами, используя разные пространства имен для каждой среды. Пространство имен может содержать только буквенно-цифровые символы, дефисы, символы подчеркивания и точки; максимальная длина составляет 256 символов.
ip-адреса;namespace=<пространство имен>
mac-адреса; namespace=<пространство имен>
fqdn;namespace=<пространство имен>
Например, чтобы установить в качестве источника идентификатора хоста ip-адреса
и назначить его пространству имен с именем test
, запустите oneagentctl
со следующим параметром:
Linux или AIX:
./oneagentctl --set-host-id-source="ip-addresses;namespace=test"
Windows:
.\oneagentctl.exe --set-host-id-source="ip-addresses;namespace=test"
После изменения источника идентификатора хоста необходимо перезапустить все отслеживаемые приложения, а затем перезапустить службу OneAgent, чтобы создать новый объект хоста в вашей среде. Вы можете использовать параметр --restart-service
с oneagentctl
для автоматического перезапуска OneAgent или остановки и запуска процесса OneAgent вручную. Инструкции для конкретных ОС см. в Linux, Windows или AIX.
Чтобы проверить источник идентификатора хоста, используйте параметр --get-host-id-source
:
Linux или AIX:
./oneagentctl --get-host-id-source
Windows:
.\oneagentctl.exe --get-host-id-source
Для источника идентификатора хоста, заданного для ip-адресов
и пространства имен test
, команда вернет следующий результат:
ip-addresses;namespace=test
Группы хостов
Обзор того, как использовать группы узлов, см. в разделе Организация среды с помощью групп узлов.
Изменить назначение группы хостов
Используйте параметр --set-host-group
, чтобы изменить назначение группы хостов.
Чтобы назначить хост MyHostGroup
:
Linux или AIX:
./oneagentctl --set-host-group=MyHostGroup
Windows:
.\oneagentctl.exe --set-host-group=MyHostGroup
Требования к строке группы хостов:
- Может содержать только буквенно-цифровые символы, дефисы, символы подчеркивания и точки.
- Не должен начинаться с dt.
- Максимальная длина – 100 символов.
Использование --set-host-group
требует перезапуска OneAgent, а также перезапуска всех отслеживаемых служб. Добавьте --restart-service
в команду для автоматического перезапуска OneAgent (версия 1.189+) или для остановки и запуска процесса OneAgent вручную. Инструкции для конкретных ОС см. в Linux, Windows или AIX.
Очистить назначение группы хостов
Используйте параметр --set-host-group
с пустым значением, чтобы очистить назначение группы хостов:
Linux или AIX:
./oneagentctl --set-host-group=
Windows:
.\oneagentctl.exe --set-host-group=
Показать назначение группы хостов
Используйте параметр --get-host-group
для отображения текущего назначения группы хостов:
Linux или AIX:
./oneagentctl --get-host-group
Windows:
.\oneagentctl.exe --get-host-group
Теги хоста и метаданные
В динамических или больших средах ручная пометка узлов может оказаться нецелесообразной. Для динамических развертываний, включающих часто меняющиеся экземпляры и имена хостов (например, AWS или MS Azure), вы можете использовать выделенные параметры oneagentctl
для применения пользовательских тегов, имен и метаданных к вашим хостам.
Перечисленные ниже методы oneagentctl
позволяют редактировать только метаданные, добавленные с помощью самого oneagentctl или ранее с помощью файлов конфигурации. Теги и метаданные, добавленные с помощью веб-интерфейса Dynatrace, а также извлеченные из контролируемой среды (например, теги AWS), не редактируются с помощью oneagentctl
и не будут отображаться с помощью параметров--get-host-tags
и --get-host-properties
.
Пользовательское имя хоста
Используйте инструмент командной строки oneagentctl
с параметром --set-host-name
, чтобы переопределить автоматически обнаруженное имя хоста. Имя хоста не должно содержать символы <
, >
, &
, CR
(возврат каретки) или LF
(перевод строки). Максимальная длина 256 символов.
Важно: Эта команда добавляет пользовательское имя хоста для отображения в пользовательском интерфейсе, но обнаруженное имя хоста не изменяется. Дополнительные сведения см. в разделе Установка пользовательских имен хостов.
Чтобы изменить имя хоста:
Linux или AIX: ./oneagentctl --set-host-name=myhostname
Windows: .\oneagentctl.exe --set-host-name=myhostname
Чтобы вернуться к автоматически определенному имени хоста, установите для параметра --set-host-name
пустое значение, как в --set-host-name=""
. Например:
Linux или AIX: ./oneagentctl --set-host-name=""
Windows: .\oneagentctl.exe --set-host-name=""
Изменение может не отображаться в веб-интерфейсе Dynatrace до 6 минут.
Использование --set-host-name
требует перезапуска OneAgent. Добавьте --restart-service
в команду для автоматического перезапуска OneAgent (версия 1.189+) или для остановки и запуска процесса OneAgent вручную. Инструкции для конкретных ОС см. в Linux, Windows или AIX.
Чтобы показать имя хоста:
Linux или AIX:
./oneagentctl --get-host-name
Windows:
.\oneagentctl.exe --get-host-name
Пользовательские метаданные хоста
После настройки настраиваемые метаданные отображаются в виде набора свойств в нижней части раздела «Свойства и теги» на странице обзора хоста. Значения свойств не должны содержать символ =
(если только он не используется в качестве разделителя значения ключа) или пробельные символы. Максимальная длина — 256 символов, включая разделитель «ключ-значение». Имя ключа не должно начинаться с символа #
.
Для версий до 1.189 используйте файл конфигурации метаданных хоста.
Чтобы добавить или изменить свойства хоста, выполните следующую команду:
Linux или AIX:
./oneagentctl --set-host-property=AppName --set-host-property=Environment=Dev
Windows:
.\oneagentctl.exe --set-host-property=AppName --set-host-property Environment=Dev
Вы можете добавить или изменить более одного свойства в одной команде.
Чтобы удалить свойства хоста, выполните следующую команду:
Linux или AIX:
./oneagentctl --remove-host-property=AppName --remove-host-property=Environment=Dev
Windows:
.\oneagentctl.exe --remove-host-property=AppName --remove-host-property=Environment=Dev
Вы можете удалить более одного свойства с помощью одной команды. Если ключ свойства, переданный в команду, не существует, будет возвращен ненулевой код выхода, но все существующие свойства, переданные в команде, будут удалены. После удаления свойств хоста они остаются видимыми в веб-интерфейсе Dynatrace до 7 часов.
Чтобы отобразить все свойства
, настроенные для хоста, выполните следующую команду:
Linux или AIX:
./oneagentctl --get-host-properties
Windows:
.\oneagentctl.exe --get-host-properties
Пользовательские теги хоста
После настройки пользовательских тегов хоста они отображаются в верхней части раздела «Свойства и теги» на странице обзора хоста. Значение свойства не должно содержать =
(если только оно не используется в качестве разделителя значений ключа) или пробельные символы. Максимальная длина — 256 символов, включая разделитель «ключ-значение». Имя ключа не должно начинаться с #
.
Чтобы добавить или изменить теги хоста, выполните следующую команду:
Linux или AIX:
./oneagentctl --set-host-tag=TestHost --set-host-tag=role=fallback --set-host-tag=Gdansk
Windows:
.\oneagentctl.exe --set-host-tag=TestHost --set-host-tag=role=fallback --set-host-tag=Gdansk
Вы можете добавить или изменить более одного тега в одной команде. Допускается определение тегов с одним и тем же ключом, но разными значениями.
Чтобы удалить теги, выполните следующую команду:
Linux или AIX:
./oneagentctl --remove-host-tag=role=fallback --remove-host-tag=Gdansk
Windows:
.\oneagentctl.exe --remove-host-tag=role=fallback --remove-host-tag=Gdansk
Вы можете удалить более одного тега с помощью одной и той же команды. Если тег, переданный в команде, не существует, возвращается ненулевой код выхода, но все существующие теги, переданные в команде, удаляются. После удаления теги остаются видимыми в веб-интерфейсе Dynatrace до 6 часов.
Чтобы отобразить все теги, настроенные для хоста, выполните следующую команду:
Linux или AIX:
./oneagentctl --get-host-tags
Windows:
.\oneagentctl.exe --get-host-tags
Мониторинг инфраструктуры
Используйте режим мониторинга инфраструктуры вместо режима мониторинга полного стека. При таком подходе вы получаете данные о работоспособности только инфраструктуры, без данных о производительности приложений или пользователей. Дополнительные сведения см. в разделе Мониторинг инфраструктуры.
Проверьте, включен ли режим мониторинга инфраструктуры
Используйте параметр --get-infra-only
, чтобы проверить, включен ли режим мониторинга инфраструктуры:
Linux или AIX:
./oneagentctl --get-infra-only
Windows:
.\oneagentctl.exe --get-infra-only
Включить или отключить режим мониторинга инфраструктуры
Установите для параметра --set-infra-only
значение true
или false
, чтобы включить или отключить режим мониторинга инфраструктуры.
Чтобы включить режим мониторинга инфраструктуры:
Linux или AIX:
./oneagentctl --set-infra-only=true
Windows:
.\oneagentctl.exe --set-infra-only=true
Изменение режима мониторинга инфраструктуры требует перезапуска OneAgent, а также перезапуска всех отслеживаемых служб. Добавьте --restart-service
в команду для автоматического перезапуска OneAgent (версия 1.189+) или для остановки и запуска процесса OneAgent вручную. Инструкции для конкретных ОС см. в Linux, Windows или AIX.
Автоматическая инъекция в мониторинге инфраструктуры
OneAgent версии 1.213
Автоматическое внедрение OneAgent включено по умолчанию в режиме мониторинга инфраструктуры, чтобы получать и сообщать показатели JMX/PMI.
Дополнительные сведения см. в разделе Режим мониторинга инфраструктуры.
Проверьте, включена ли автоинъекция
Используйте параметр get-auto-injection-enabled
, чтобы проверить, включено ли автоматическое внедрение OneAgent:
Linux или AIX:
./oneagentctl --get-auto-injection-enabled
Windows:
.\oneagentctl.exe --get-auto-injection-enabled
Включить или отключить автоинъекцию
Установите для параметра --set-auto-injection-enabled
значение true
или false
, чтобы включить или отключить автоматическую инъекцию OneAgent:
Чтобы включить автоинъекции:
Linux или AIX:
./oneagentctl --set-auto-injection-enabled=true
Windows:
.\oneagentctl.exe --set-auto-injection-enabled=true
Чтобы отключить автоинъекции:
Linux или AIX:
./oneagentctl --set-auto-injection-enabled=false
Windows:
.\oneagentctl.exe --set-auto-injection-enabled=false
Дополнительные сведения см. в разделе Отключение автоматического внедрения.
Прием метрик
OneAgent версии 1.201
Прием локальных метрик в настоящее время поддерживается только в Windows и Linux.
Вы можете использовать команду oneagentctl
для проверки или изменения портов связи, используемых для локального приема метрик, с помощью API метрик OneAgent, интеграции сценариев, Telegraf или Dynatrace Statsd. Для изменения порта приема метрик требуется перезапуск OneAgent. Добавьте --restart-service
в команду для автоматического перезапуска OneAgent.
Дополнительные сведения см. в разделе Прием метрик.
API OneAgent, интеграция сценариев и Telegraf
Порт приема метрик по умолчанию — 14499. При необходимости вы можете использовать команду oneagentctl
, чтобы проверить или изменить порт. Для изменения порта приема метрик требуется перезапуск OneAgent. Добавьте --restart-service
в команду для автоматического перезапуска OneAgent.
Проверьте порт приема
Используйте параметр --get-extensions-ingest-port
, чтобы отобразить текущий локальный порт приема, по умолчанию 14499
.
Linux: ./oneagentctl --get-extensions-ingest-port
Windows: .\oneagentctl.exe --get-extensions-ingest-port
Установите собственный порт приема
Используйте параметр --set-extensions-ingest-port=<arg>
, чтобы задать собственный локальный порт приема.
Linux: ./oneagentctl --set-extensions-ingest-port=14499 --restart-service
Windows: .\oneagentctl.exe --set-extensions-ingest-port=14499 --restart-service
Настроить прокси
Настройте прокси-сервер хоста, чтобы разрешить трафику локального хоста идти на порт приема метрик, по умолчанию 14499
.
StatsD
Прослушиватель OneAgent
Порт прослушивания UDP Dynatrace StatsD по умолчанию для прослушивателя OneAgent— 18125
. При необходимости можно использовать команду oneagentctl
, чтобы проверить или изменить порт приема метрик. Изменение порта требует перезапуска OneAgent. Добавьте --restart-service
в команду для автоматического перезапуска OneAgent.
Проверьте порт приема
Используйте параметр --get-extensions-statsd-port
, чтобы показать текущий порт прослушивания UDP Dynatrace StatsD (по умолчанию = 18125
).
Linux: ./oneagentctl --get-extensions-statsd-port
Windows: .\oneagentctl.exe --get-extensions-statsd-port
Установите собственный порт приема
Используйте параметр --set-extensions-statsd-port=<arg>
, чтобы установить собственный порт прослушивания UDP Dynatrace StatsD.
Linux: ./oneagentctl --set-extensions-statsd-port=18125 --restart-service
Windows: .\oneagentctl.exe --set-extensions-statsd-port=18125 --restart-service
Удаленная статистикаD
Порт прослушивания UDP Dynatrace StatsD по умолчанию для удаленного прослушивателя — 18126
.
Чтобы изменить порт прослушивания по умолчанию 18126
, измените параметр StatsdPort
в файле extensionsuser.conf ActiveGate:
Linux /var/lib/AstromKey/remotepluginmodule/agent/conf/extensionsuser.conf
Windows C:\ProgramData\AstromKey\remotepluginmodule\agent\conf\extensionsuser.conf
:
StatsdPort=18126
Сетевые зоны
Чтобы узнать о правилах именования сетевых зон и другую справочную информацию, см. раздел Сетевые зоны.
Установить сетевую зону
Используйте параметр --set-network-zone
, чтобы указать OneAgent обмениваться данными через указанную сетевую зону. Имя сетевой зоны представляет собой строку буквенно-цифровых символов. Вы также можете использовать дефисы (-
), символы подчеркивания (_
) и точку (.
) в качестве разделителя. Имя сетевой зоны не должно начинаться с точки. Длина строки ограничена 256 символами. Имена сетевых зон не чувствительны к регистру. Dynatrace хранит эти имена в нижнем регистре. Дополнительные сведения см. в разделе об именовании зон сети.
В Linux или AIX:
./oneagentctl --set-network-zone=<your.network.zone>
В Windows:
.\oneagentctl.exe --set-network-zone=<your.network.zone>
Сбросить сетевую зону
Вы можете сбросить настройку сетевой зоны, передав пустое имя сетевой зоны:
В Linux или AIX:
./oneagentctl --set-network-zone=""
В Windows:
.\oneagentctl.exe --set-network-zone=""
Показать настройки зоны сети
Используйте параметр --get-network-zone
для отображения текущей конфигурации сетевой зоны:
В Linux или AIX:
./oneagentctl --get-network-zone
В Windows:
.\oneagentctl.exe --get-network-zone
Передача параметров конфигурации во время установки
Вы можете передать параметры --set-*
во время установки. Параметры конфигурации применяются непосредственно перед запуском службы OneAgent, и нет необходимости перезапускать ее, чтобы применить вашу конфигурацию.
Linux или AIX
Чтобы пройти через параметры конфигурации, просто добавьте параметр и поставьте перед значением знак равенства (=
). Например:
/bin/sh OneAgent-Linux.sh –-set-host-group=test_group
Windows
EXE установщик
Чтобы передать параметры конфигурации с помощью установщика EXE, просто добавьте параметр и поставьте перед значением знак равенства (=
). Например:
OneAgent-Windows.exe --set-host-group=test_group
MSI-пакет
Вы также можете передать параметры конфигурации с помощью пакета MSI. Однако на этот раз вы должны использовать дополнительный параметр ADDITIONAL_CONFIGURATION
. Например:
OneAgent-Windows.msi ADDITIONAL_CONFIGURATION="--set-host-group=test_group"
Криптографические алгоритмы FIPS 140
OneAgent версии 1.245+
OneAgent использует режим FIPS для обеспечения соответствия стандарту компьютерной безопасности FIPS 140-3.
Проверьте, включен ли FIPS 140.
Используйте --get-fips-enabled
, чтобы проверить, использует ли OneAgent проверенные криптографические алгоритмы FIPS 140.
В Linux или AIX
./oneagentctl --get-fips-enabled
В Windows
./oneagentctl.exe --get-fips-enabled
Включить или отключить FIPS 140
Установите для параметра --set-fips-enabled
значение true
или false
, чтобы включить или отключить проверенные криптографические алгоритмы FIPS 140 в OneAgent.
Чтобы включить режим FIPS:
В Linux или AIX
./oneagentctl --set-fips-enabled=true
В Windows
./oneagentctl.exe --set-fips-enabled=true
Чтобы отключить режим FIPS:
В Linux или AIX
/oneagentctl --set-fips-enabled=false
В Windows
./oneagentctl.exe --set-fips-enabled=false
Если вы хотите включить режим FIPS для развертывания только приложений, перейдите в /paas/package/agent
и удалите dt_fips_disabled.flag
.