ЕдиныйАгент настройка через интерфейс командной строки - История изменений

IKuznetsov в 07:58, 8 января 2025

2025-01-08T07:58:28Z

← Предыдущая версия		Версия от 07:58, 8 января 2025
Строка 1:		Строка 1:
			'''''[[Установка и настройка]] / [[Установка и настройка\|Основные элементы АппОптима]] / [[ЕдиныйАгент АппОптима]] / [[ЕдиныйАгент АппОптима\|Установка и эксплуатация]] / [[ЕдиныйАгент АппОптима#:~:text=%D0%9E%D0%BF%D0%B5%D1%80%D0%B0%D1%86%D0%B8%D0%BE%D0%BD%D0%BD%D1%8B%D0%B5 %D1%81%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D1%8B\|Операционные системы]]/ [[ЕдиныйАгент в Windows]] / [[ЕдиныйАгент в Windows\|Смотрите также]] / ЕдиныйАгент настройка через интерфейс командной строки'''''

	Используйте интерфейс командной строки <code>oneagentctl</code> для выполнения некоторых настроек ЕдиногоАгента после установки на уровне отдельного хоста.		Используйте интерфейс командной строки <code>oneagentctl</code> для выполнения некоторых настроек ЕдиногоАгента после установки на уровне отдельного хоста.

IKuznetsov в 18:17, 2 января 2025

2025-01-02T18:17:20Z

← Предыдущая версия		Версия от 18:17, 2 января 2025
Строка 634:		Строка 634:
	Чтобы изменить порт прослушивания по умолчанию <code>18126</code>, измените параметр <code>StatsdPort</code> в файле extensionsuser.conf АктивногоШлюза:		Чтобы изменить порт прослушивания по умолчанию <code>18126</code>, измените параметр <code>StatsdPort</code> в файле extensionsuser.conf АктивногоШлюза:

	'''Linux''' <code>/var/lib/~~AstromKey~~/remotepluginmodule/agent/conf/extensionsuser.conf</code>		'''Linux''' <code>/var/lib/AppOptima/remotepluginmodule/agent/conf/extensionsuser.conf</code>

	'''Windows''' <code>C:\ProgramData\~~AstromKey~~\remotepluginmodule\agent\conf\extensionsuser.conf</code>:		'''Windows''' <code>C:\ProgramData\AppOptima\remotepluginmodule\agent\conf\extensionsuser.conf</code>:
	StatsdPort=18126		StatsdPort=18126

IKuznetsov: /* Идентификатор хоста */

2024-12-17T13:33:44Z

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

← Предыдущая версия		Версия от 13:33, 17 декабря 2024
Строка 295:		Строка 295:

	== Идентификатор хоста ==		== Идентификатор хоста ==
	АппОптима присваивает уникальный идентификатор каждому отслеживаемому узлу в вашей среде. Идентификаторы хостов можно использовать в качестве параметров в запросах АппОптима API, например, Topology ~~и Smartscape API~~ — Hosts API. Идентификатор хоста также представляет собой URL-адрес страницы '''обзора хоста''', например, <code><nowiki>https://environment.org/#newhosts/hostdetails;id=HOST-6E56EE455C84E232</nowiki></code>.		АппОптима присваивает уникальный идентификатор каждому отслеживаемому узлу в вашей среде. Идентификаторы хостов можно использовать в качестве параметров в запросах АппОптима API, например, Topology — Hosts API. Идентификатор хоста также представляет собой URL-адрес страницы '''обзора хоста''', например, <code><nowiki>https://environment.org/#newhosts/hostdetails;id=HOST-6E56EE455C84E232</nowiki></code>.

	=== Показать свой идентификатор хоста ===		=== Показать свой идентификатор хоста ===

IKuznetsov в 10:50, 11 ноября 2024

2024-11-11T10:50:50Z

Внесённые изменения

ENetrebin в 15:48, 21 сентября 2023

2023-09-21T15:48:09Z

← Предыдущая версия		Версия от 15:48, 21 сентября 2023
Строка 25:		Строка 25:
	Команда <code>oneagentctl</code> принимает параметр <code>get</code> для проверки состояния или значения параметра и параметр <code>set</code> для изменения параметра. Обратите внимание, что вы можете использовать несколько заданных параметров в одной команде.		Команда <code>oneagentctl</code> принимает параметр <code>get</code> для проверки состояния или значения параметра и параметр <code>set</code> для изменения параметра. Обратите внимание, что вы можете использовать несколько заданных параметров в одной команде.

	==Перезапуск ~~OneAgent~~==		==Перезапуск ЕдиныйАгент==
	При использовании <code>set</code> параметров необходимо перезапустить службу ЕдиногоАгента, чтобы изменения вступили в силу. Вы можете использовать параметр <code>--restart-service</code> с командой, которая автоматически запускает перезагрузку. В некоторых случаях вам также потребуется перезапустить отслеживаемые приложения. Вы также можете использовать параметр перезапуска сам по себе, без других параметров. См. пример команды ниже.		При использовании <code>set</code> параметров необходимо перезапустить службу ЕдиногоАгента, чтобы изменения вступили в силу. Вы можете использовать параметр <code>--restart-service</code> с командой, которая автоматически запускает перезагрузку. В некоторых случаях вам также потребуется перезапустить отслеживаемые приложения. Вы также можете использовать параметр перезапуска сам по себе, без других параметров. См. пример команды ниже.

Строка 421:		Строка 421:
	Изменение может не отображаться в веб-интерфейсе Ключ-Астром до 6 минут.		Изменение может не отображаться в веб-интерфейсе Ключ-Астром до 6 минут.

	Использование <code>--set-host-name</code> требует перезапуска ЕдиногоАгента. Добавьте <code>--restart-service</code> в команду для автоматического перезапуска ЕдиногоАгента (версия 1.189+) или для остановки и запуска процесса ~~OneAgent~~ вручную. Инструкции для конкретных ОС см. в [[Остановить/перезапустить ЕдиныйАгент в Linux\|Linux]], [[ЕдиныйАгент остановка/перезапуск в Windows\|Windows]] или AIX.		Использование <code>--set-host-name</code> требует перезапуска ЕдиногоАгента. Добавьте <code>--restart-service</code> в команду для автоматического перезапуска ЕдиногоАгента (версия 1.189+) или для остановки и запуска процесса ЕдиногоАгента вручную. Инструкции для конкретных ОС см. в [[Остановить/перезапустить ЕдиныйАгент в Linux\|Linux]], [[ЕдиныйАгент остановка/перезапуск в Windows\|Windows]] или AIX.

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

RGolovanov в 15:44, 15 сентября 2022

2022-09-15T15:44:01Z

← Предыдущая версия		Версия от 15:44, 15 сентября 2022
Строка 634:		Строка 634:
	Чтобы изменить порт прослушивания по умолчанию <code>18126</code>, измените параметр <code>StatsdPort</code> в файле extensionsuser.conf АктивногоШлюза:		Чтобы изменить порт прослушивания по умолчанию <code>18126</code>, измените параметр <code>StatsdPort</code> в файле extensionsuser.conf АктивногоШлюза:

	'''Linux''' <code>/var/lib/~~dynatrace~~/remotepluginmodule/agent/conf/extensionsuser.conf</code>		'''Linux''' <code>/var/lib/AstromKey/remotepluginmodule/agent/conf/extensionsuser.conf</code>

	'''Windows''' <code>C:\ProgramData\~~dynatrace~~\remotepluginmodule\agent\conf\extensionsuser.conf</code>:		'''Windows''' <code>C:\ProgramData\AstromKey\remotepluginmodule\agent\conf\extensionsuser.conf</code>:
	StatsdPort=18126		StatsdPort=18126

Lobanov: /* Пользовательские теги хоста */

2022-08-28T15:51:58Z

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

Внесённые изменения

Lobanov в 10:13, 28 августа 2022

2022-08-28T10:13:42Z

Внесённые изменения

Lobanov: Новая страница: «Используйте интерфейс командной строки `oneagentctl` для выполнения некоторых настроек...»

2022-08-28T09:29:39Z

Новая страница: «Используйте интерфейс командной строки <code>oneagentctl</code> для выполнения некоторых настроек...»

Новая страница

Используйте интерфейс командной строки <code>oneagentctl</code> для выполнения некоторых настроек ЕдиногоАгента после установки на уровне отдельного хоста.

==Расположение==
Расположение инструмента зависит от того, настроили ли вы установку ЕдиногоАгента с помощью параметра <code><INSTALL_PATH></code>:

'''Linux''' или '''AIX''':

<code><INSTALL_PATH>/agent/tools</code>

Вам нужны root-права.

'''Развертывание на основе Docker'''

<code><INSTALL_PATH>/agent/tools</code>

Обратите внимание, что этот путь будет отличаться для развертывания на основе тома.

'''Windows''':

<code><INSTALL_PATH>\agent\tools</code>

Вам нужны права администратора. Если вы попытаетесь запустить <code>oneagentctl</code> в консоли Windows без прав администратора, Windows отобразит всплывающее окно контроля учетных записей и завершится ошибкой.

==Типы параметров==
Команда <code>oneagentctl</code> принимает параметр <code>get</code> для проверки состояния или значения параметра и параметр <code>set</code> для изменения параметра. Обратите внимание, что вы можете использовать несколько заданных параметров в одной команде.

==Перезапуск OneAgent==
При использовании <code>set</code> параметров необходимо перезапустить службу ЕдиногоАгента, чтобы изменения вступили в силу. Вы можете использовать параметр <code>--restart-service</code> с командой, которая автоматически запускает перезагрузку. В некоторых случаях вам также потребуется перезапустить отслеживаемые приложения. Вы также можете использовать параметр перезапуска сам по себе, без других параметров. См. пример команды ниже.

'''Linux''' или '''AIX''':

<code>./oneagentctl --set-proxy=my-proxy.com --restart-service</code>

'''Windows''':

<code>.\oneagentctl.exe --set-proxy=my-proxy.com --restart-service</code>

==Показать справку==
Используйте параметр <code>--help</code> для отображения всех поддерживаемых параметров.

'''Linux''' или '''AIX''':

<code>./oneagentctl --help</code>

'''Windows''':

<code>.\oneagentctl.exe --help</code>

==Показать версию ЕдиногоАгента==
Используйте параметр <code>--version</code> для отображения версии ЕдиногоАгента.

'''Linux''' или '''AIX''':

<code>./oneagentctl --version</code>

'''Windows''':

<code>.\oneagentctl.exe --version</code>

==Связь с ЕдинымАгентом==

===Изменить настройки связи с ЕдинымАгентом===
<code>ЕдиныйАгент версии 1.185</code>

*Используйте параметр <code>--set-server</code>, чтобы задать конечную точку связи ЕдиногоАгента. Используйте IP-адрес или имя. В зависимости от вашего развертывания это может быть сервер Ключ-Астром, управляемый кластер Ключ-Астром или АктивныйШлюз.
*Используйте параметр <code>--set-tenant</code>, чтобы задать идентификатор среды. По умолчанию для него уже установлено правильное значение. Если вы продаете услуги на основе Ключ-Астром, используйте этот параметр, чтобы установить идентификаторы ваших клиентов из пула идентификаторов, приобретенных вами у Ключ-Астром. Всегда используйте в сочетании с параметром <code>--set-tenant-token</code>, который определяет токен клиента для внутренней проверки подлинности.
*Используйте параметр <code>--set-tenant-token</code>, чтобы установить токен клиента, который используется для аутентификации связи с определенной конечной точкой. Всегда используйте в сочетании с <code>--set-tenant</code>
*Используйте параметр <code>--set-proxy</code> для установки прокси-сервера.

Выполните следующую команду, чтобы настроить параметры подключения ЕдиногоАгента:

'''Linux''' или '''AIX''':

<code>./oneagentctl --set-server=<nowiki>https://my-server.com:443</nowiki> --set-tenant=abc123456 --set-tenant-token=abcdefg123456790 --set-proxy=my-proxy.com</code>

'''Windows''':

<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>--restart-service</code> в команду для автоматического перезапуска ЕдиногоАгента(версия 1.189+) или для остановки и запуска процесса ЕдиногоАгента вручную. Инструкции для конкретных ОС см. в [[Остановить/перезапустить ЕдиныйАгент в Linux|Linux]], [[ЕдиныйАгент остановка/перезапуск в Windows|Windows]] или AIX.

Эта команда немедленно изменит конечную точку подключения модуля ОС, но модули кода не смогут прочитать новую настройку до следующего перезапуска.

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

===Показать текущие конечные точки связи===
<code>ЕдиныйАгент версии 1.185</code>

Используйте параметр <code>--get-server</code>, чтобы отобразить конечные точки, на которые ЕдиныйАгент должен отправлять данные. Это может быть сервер Ключ-Астром, управляемый кластер Ключ-Астром или АктивныйШлюз.

'''Linux''' или '''AIX''':

<code>./oneagentctl --get-server</code>

'''Windows''':

<code>.\oneagentctl.exe --get-сервер</code>

Начиная с ЕдиногоАгента версии 1.207, конечные точки представляются в формате, в котором конечные точки с одинаковым приоритетом группируются с помощью фигурных скобок <code>({...})</code> и сортируются в соответствии с приоритетом подключения. Звездочка (<code>*</code>) указывает конечную точку, на которую ЕдиныйАгент в данный момент отправляет данные. Конечные точки разделяются точкой с запятой (<code>;</code>). Например:
{<nowiki>https://endpoint1.com/communication;https:/10.0.0.0/communication;*https://endpoint3.com/communication}{https://endpoint4.com:443/communication}</nowiki>

===Показать идентификатор среды===
Идентификатор среды Ключ-Астром, который вы получили по электронной почте с активацией.

Используйте параметр <code>--get-tenant</code> для отображения идентификатора среды:

'''Linux''' или '''AIX''':

<code>./oneagentctl --get-tenant</code>

'''Windows''':

<code>.\oneagentctl.exe --get-tenant</code>

===Показать токен арендатора===
Используйте параметр <code>--get-tenant-token</code> для отображения текущего определенного токена:

'''Linux''' или '''AIX''':

<code>./oneagentctl --get-tenant-token</code>

'''Windows''':

<code>.\oneagentctl.exe --get-tenant-token</code>

===Показать текущий прокси===
<code>ЕдиныйАгент версии 1.185</code>

Используйте параметр <code>--get-proxy</code>, чтобы отобразить текущий определенный прокси, через который ЕдиныйАгент подключается:

'''Linux''' или '''AIX''':

<code>./oneagentctl --get-proxy</code>

'''Windows''':

<code>.\oneagentctl.exe --get-proxy</code>

===Очистить конфигурацию прокси===
Используйте для параметра <code>--set-proxy</code> пустое значение, чтобы очистить конфигурацию прокси:

'''Linux''' или '''AIX''':

<code>./oneagentctl --set-proxy=</code>

'''Windows''':

<code>.\oneagentctl.exe --set-proxy=</code> Перезапустите службу ЕдиногоАгента, чтобы изменения вступили в силу.

===Проверить текущий диапазон портов===
ЕдиныйАгент состоит из различных процессов, которые обмениваются данными через TCP-порт со сторожевым таймером. При запуске, сторожевой таймер ЕдиногоАгента пытается открыть первый доступный порт между портами 50000 и 50100. В некоторых случаях вам может понадобиться этот порт для ваших собственных приложений, которые запускаются после ЕдиногоАгента.

Используйте параметр <code>--get-watchdog-portrange</code>, чтобы проверить текущий диапазон портов, определенный для сторожевого таймера.

'''Linux''' или '''AIX''':

<code>./oneagentctl --get-watchdog-portrange</code>

'''Windows''':

<code>.\oneagentctl.exe --get-watchdog-portrange</code>

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

'''Linux''' или '''AIX''':

<code>./oneagentctl --set-watchdog-portrange=50000:50100</code>

'''Windows''':

<code>.\oneagentctl.exe --set-watchdog-portrange=50000:50100</code>

==Автоматические обновления==
<code>ЕдиныйАгент версии 1.213</code>

Дополнительные сведения см. в разделах по обновлению ЕдиногоАгента для [[Обновление ЕдиногоАгента в Linux|Linux]], [[Обновление ЕдиногоАгента КлючАстром в Windows|Windows]] и AIX.

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

'''Linux''' или '''AIX''':

<code>./oneagentctl --get-auto-update-enabled</code>

'''Windows''':

<code>.\oneagentctl.exe --get-auto-update-enabled</code>

===Включить или отключить автообновление===
Установите для параметра <code>--set-auto-update-enabled</code> значение <code>true</code> или <code>false</code>, чтобы отключить или включить автоматическое обновление ЕдиногоАгента :

'''Linux''' или '''AIX''':

<code>./oneagentctl --set-auto-update-enabled=true</code>

'''Windows''':

<code>.\oneagentctl.exe --set-auto-update-enabled=true</code>

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

==Мониторинг логов==
Дополнительные сведения см. в разделе [[Мониторинг логов]]. Примечание. Мониторинг логов не поддерживается в AIX.

===Проверьте, включен ли Мониторинг логов===
Используйте параметр <code>--get-app-log-content-access</code>, чтобы проверить, включен ли мониторинг журналов:

'''Linux''':

<code>./oneagentctl --get-app-log-content-access</code>

'''Windows''':

<code>.\oneagentctl.exe --get-app-log-content-access</code>

===Включить или отключить мониторинг журналов===
Установите для параметра <code>--set-app-log-content-access</code> значение <code>true</code> или <code>false</code>, чтобы отключить или включить Мониторинг логов:

'''Linux''':

<code>./oneagentctl --set-app-log-content-access=true</code>

'''Windows''':

<code>.\oneagentctl.exe --set-app-log-content-access=true</code> Перезапустите службу ЕдиногоАгента, чтобы применить изменения.

==Создать архив поддержки==
<code>ЕдиныйАгент версии 1.225+</code>

Если у вас нет доступа к веб-интерфейсу Ключ-Астром или вы хотите создать скрипт для сбора диагностических данных, вы можете использовать команду <code>oneagentctl</code> для сбора подмножества полных [[ЕдиныйАгент диагностики|диагностических данных ЕдиногоАгента]] прямо на хосте, где установлен ЕдиныйАгент. С помощью диагностических данных, собранных для ЕдиногоАгента, вы можете:

*легко собирать диагностические данные для конкретного хоста
*напрямую предоставить службе поддержки Ключ-Астром детали, необходимые для диагностики проблемы

Команда требует, чтобы служба ЕдиногоАгента была запущена.

Чтобы создать архив поддержки с диагностическими данными, запустите <code>oneagentctl</code> с параметром <code>--create-support-archive</code>. По умолчанию архив поддержки содержит данные за 7-дневный период времени и создается в текущем рабочем каталоге. При желании вы можете установить собственный каталог и временной интервал с параметрами <code>каталога</code> и <code>дней</code>. Примечание: <code>onegentctl</code> не создает каталог; вы должны указать его на существующий каталог с относительным или абсолютным путем. Например:

'''Linux''' или '''AIX''':

<code>./oneagentctl --create-support-archive directory=/data/support-archive days=30</code>

'''Windows''':

<code>.\oneagentctl.exe --create-support-archive directory=C:\data\support-archive days=30</code>

Команда сохраняет архив как файл <code>support_archive_agent_YYYY-MM-DD_hhmmss.zip</code>. Например:
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

=== Содержание диагностических данных ===
Все собранные диагностические данные сжимаются в архив <code>support_archive_agent_YYYY-MM-DD_hhmmss.zip</code>, который включает следующее подмножество полных диагностических данных ЕдиногоАгента:
{| class="wikitable"
!Папка или файл
!Описание
|-
|<code>support_archive</code> (ZIP)
|Содержит локальную конфигурацию агента ЕдиногоАгента, установленного на узле или в процессе, в котором выполнялась процедура устранения неполадок, а также файлы журналов, связанные с ЕдинымАгентом.
|-
|<code>diagnostic_files</code> (ZIP)
|Содержит информацию об обнаружении группы процессов, проблемах автоматического внедрения и конфигурации расширения ЕдиногоАгента.
|}

== Доступ к системным журналам для проактивной поддержки ==
ЕдиныйАгент загружает определенные системные журналы, чтобы Ключ-Астром мог диагностировать проблемы, которые могут быть вызваны условиями в вашей среде. Журналы также сохраняются в архиве поддержки. Чаще всего такие проблемы связаны с глубоким мониторингом или установками автоматического обновления.

=== Проверьте, включен ли доступ к системным журналам. ===
Используйте параметр <code>--get-system-logs-access-enabled</code>, чтобы проверить, включен ли доступ к системным журналам:

'''Linux''' или '''AIX''':

<code>./oneagentctl --get-system-logs-access-enabled</code>

'''Windows''':

<code>.\oneagentctl.exe --get-system-logs-access-enabled</code>

=== Включить или отключить доступ к системным журналам ===
Установите для параметра <code>--set-system-logs-access-enabled</code> значение <code>true</code> или <code>false</code>, чтобы отключить или включить доступ к системным журналам:

'''Linux''' или '''AIX''':

<code>./oneagentctl --set-system-logs-access-enabled=true</code>

'''Windows''':

<code>.\oneagentctl.exe --set-system-logs-access-enabled=true</code> Перезапустите службу ЕдиногоАгента, чтобы изменения вступили в силу.

Обратите внимание, что параметры --set-system-logs-access-enabled и --get-system-logs-access-enabled относятся к настройке самодиагностики и не связаны с мониторингом журналов.
'''Примечание''':
Отключение доступа к системному журналу ограничивает наши возможности по упреждающей диагностике и устранению проблем. Если доступ к системным журналам закрыт, вам может потребоваться вручную предоставить Ключ-Астром содержимое ваших системных журналов, чтобы мы могли диагностировать проблемы в вашей среде.

ЕдиныйАгент настройка через интерфейс командной строки - История изменений

IKuznetsov в 07:58, 8 января 2025

IKuznetsov в 18:17, 2 января 2025

IKuznetsov: /* Идентификатор хоста */

IKuznetsov в 10:50, 11 ноября 2024

ENetrebin в 15:48, 21 сентября 2023

RGolovanov в 15:44, 15 сентября 2022

Lobanov: /* Пользовательские теги хоста */

Lobanov в 10:13, 28 августа 2022

Lobanov: Новая страница: «Используйте интерфейс командной строки oneagentctl для выполнения некоторых настроек...»

Lobanov: Новая страница: «Используйте интерфейс командной строки `oneagentctl` для выполнения некоторых настроек...»