Spec-Zone.ru › AWS CLI v2

[ aws . rum ]

получить-монитор-приложения

Описание

Получает полную информацию о конфигурации одного монитора приложения.

См. также: Документация API AWS

Синтаксис

  get-app-monitor
--name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--name (строка)

Монитор приложения, для которого требуется получить информацию.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределяют значения, предоставленные в JSON. Передача произвольных двоичных данных с помощью значения, предоставленного в JSON, невозможна, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод, не отправляя запрос API. Если указано без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, он проверит входные данные команды и вернет пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладку логов.

--endpoint-url (строка)

Переопределить URL по умолчанию команды на указанный URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (логическое значение)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (строка)

Показать версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • включить
  • выключить
  • авто

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл с сертификатом CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как закодированная строка base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое отображается на двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла непосредственно независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для конфигурируемого cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить вывод страницы для cli.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

AppMonitor -> (структура)

Структура, содержащая всю конфигурационную информацию для монитора приложения.

AppMonitorConfiguration -> (структура)

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

AllowCookies -> (логическое значение)

Если вы установите это значение в true, клиент веб-приложения RUM устанавливает два cookie: cookie сессии и cookie пользователя. Cookie позволяют клиенту веб-приложения RUM собирать данные, относящиеся к количеству пользователей приложения и поведению приложения в последовательности событий. Cookie хранятся в домене верхнего уровня текущей страницы.

EnableXRay -> (логическое значение)

Если вы установите это значение в true, RUM включает трассировку X-Ray для сессий пользователей, которые RUM отбирает. RUM добавляет заголовок трассировки X-Ray к разрешенным HTTP-запросам. Также он записывает сегмент X-Ray для разрешенных HTTP-запросов. Вы можете просмотреть трассировки и сегменты этих сессий пользователей в консоли X-Ray и консоли CloudWatch ServiceLens. Дополнительная информация находится в разделе Что такое X-Ray?

ExcludedPages -> (список)

Список URL-адресов вашего веб-сайта или приложения, которые необходимо исключить из сбора данных RUM.

Вы не можете включить одновременно ExcludedPages и IncludedPages в одной операции.

(строка)

FavoritePages -> (список)

Список страниц вашего приложения, которые будут отображаться с иконкой «избранное» в консоли CloudWatch RUM.

(строка)

GuestRoleArn -> (строка)

ARN гостевой роли IAM, которая подключена к пулу идентификаторов Amazon Cognito, используемому для авторизации отправки данных в RUM.

Примечание

Возможно, монитор приложения не имеет значения для GuestRoleArn. Например, это может произойти, когда вы используете консоль для создания монитора приложения и разрешаете CloudWatch RUM создать новый пул идентификаторов для авторизации. В этом случае GuestRoleArn отсутствует в ответе GetAppMonitor, так как он не хранится сервисом.

Если у вас возникла эта проблема, вы можете выполнить следующие действия:

  • Используйте Cloud Development Kit (CDK) для создания пула идентификаторов и связанной роли IAM и используйте их для монитора приложения.
  • Выполните отдельный вызов GetIdentityPoolRoles к Amazon Cognito для получения GuestRoleArn.

IdentityPoolId -> (строка)

Идентификатор пула идентификаторов Amazon Cognito, используемого для авторизации отправки данных в RUM.

IncludedPages -> (список)

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

Вы не можете включить одновременно ExcludedPages и IncludedPages в одной операции.

(строка)

SessionSampleRate -> (дробное число)

Определяет часть сессий пользователей, используемых для сбора данных RUM. Выбор большей части даст вам больше данных, но также повлечет за собой больше затрат.

Диапазон этого значения составляет от 0 до 1 включительно. Установка этого значения в 1 означает, что 100% сессий пользователей отбираются, а установка в 0,1 означает, что 10% сессий пользователей отбираются.

Если вы опустите этот параметр, будет использоваться значение по умолчанию 0,1, и 10% сессий будут отбираться.

Telemetries -> (список)

Массив, перечисляющий типы данных телеметрии, которые должен собирать этот монитор приложения.

  • errors указывает, что RUM собирает данные об необработанных ошибках JavaScript, возникающих в вашем приложении.
  • performance указывает, что RUM собирает данные о производительности загрузки и отображения вашего приложения и его ресурсов. Это включает критические показатели веб-сайтов.
  • http указывает, что RUM собирает данные об HTTP-ошибках, возникших в вашем приложении.

(строка)

Created -> (строка)

Дата и время создания этого монитора приложения.

CustomEvents -> (структура)

Указывает, разрешает ли этот монитор приложения клиенту веб-приложения определять и отправлять пользовательские события.

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

Status -> (строка)

Указывает, разрешает ли этот монитор приложения клиенту веб-приложения определять и отправлять пользовательские события. Значение по умолчанию — пользовательские события DISABLED.

DataStorage -> (структура)

Структура, содержащая информацию о том, хранит ли этот монитор приложения копию данных телеметрии, собранных RUM с помощью CloudWatch Logs.

CwLog -> (структура)

Структура, содержащая информацию о том, хранит ли монитор приложения копии данных, собранных RUM в CloudWatch Logs. Если да, эта структура также содержит имя группы журналов.

CwLogEnabled -> (логическое значение)

Указывает, хранит ли монитор приложения копии данных, собранных RUM в CloudWatch Logs.

CwLogGroup -> (строка)

Имя группы журналов, где хранятся копии.

DeobfuscationConfiguration -> (структура)

Структура, содержащая конфигурацию того, как монитор приложения может деобфусцировать трассировки стека.

JavaScriptSourceMaps -> (структура)

Структура, содержащая конфигурацию того, как монитор приложения может деобфусцировать трассировки стека JavaScript с помощью карты исходного кода.

S3Uri -> (строка)

S3Uri ведра или папки, в которой хранятся файлы карты исходного кода. Требуется, если статус ENABLED.

Status -> (строка)

Указывает, следует ли деобфусцировать трассировки стека JavaScript для этого монитора приложения. По умолчанию деобфусцирование трассировок стека JavaScript для этого монитора приложения включено. DISABLED.

Domain -> (строка)

Домен верхнего уровня интернет-домена, за который ваше приложение имеет административные права.

DomainList -> (список)

Список доменных имен, за которые ваше приложение имеет административные права.

(строка)

Id -> (строка)

Уникальный идентификатор этого монитора приложения.

LastModified -> (строка)

Дата и время последних изменений конфигурации этого монитора приложения.

Name -> (строка)

Имя монитора приложения.

State -> (строка)

Текущее состояние монитора приложения.

Tags -> (карта)

Список ключей и значений тегов, связанных с этим монитором приложения.

key -> (строка)

value -> (строка)

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API