Spec-Zone.ru › AWS CLI v2

[ aws . rum ]

создать-монитор-приложения

Описание

Создает монитор приложения Amazon CloudWatch RUM, который собирает данные телеметрии из вашего приложения и отправляет эти данные в RUM. Данные включают информацию о производительности и надёжности, такую как время загрузки страницы, ошибки на стороне клиента и поведение пользователя.

Данная операция используется только для создания нового монитора приложения. Для обновления существующего монитора приложения используйте UpdateAppMonitor.

После создания монитора приложения войдите в консоль CloudWatch RUM, чтобы получить фрагмент кода JavaScript для добавления в ваше веб-приложение. Дополнительную информацию см. в разделе Как найти уже сгенерированный фрагмент кода?

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

Синтаксис

  create-app-monitor
[--app-monitor-configuration <value>]
[--custom-events <value>]
[--cw-log-enabled | --no-cw-log-enabled]
[--deobfuscation-configuration <value>]
[--domain <value>]
[--domain-list <value>]
--name <value>
[--tags <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]

Параметры

--app-monitor-configuration (структура)

Структура, содержащая большую часть конфигурационных данных для монитора приложения. Если вы используете Amazon Cognito для авторизации, вы должны включить эту структуру в свой запрос, и она должна содержать идентификатор пула идентификации Amazon Cognito, который нужно использовать для авторизации. Если вы не включите AppMonitorConfiguration, вы должны настроить свой собственный метод авторизации. Дополнительную информацию см. в разделе Авторизуйте ваше приложение для отправки данных в Amazon Web Services.

Если вы опустите этот аргумент, для RUM будет использоваться процент выборки 10% от пользовательских сессий.

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

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

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 собирает данные о производительности, касающиеся того, как загружаются и рендерятся ваше приложение и его ресурсы. Это включает Core Web Vitals.
  • http указывает, что RUM собирает данные об ошибках HTTP, выброшенных вашим приложением.

(строка)

Краткая запись синтаксиса:

AllowCookies=boolean,EnableXRay=boolean,ExcludedPages=string,string,FavoritePages=string,string,GuestRoleArn=string,IdentityPoolId=string,IncludedPages=string,string,SessionSampleRate=double,Telemetries=string,string

Синтаксис JSON:

{
  "AllowCookies": true|false,
  "EnableXRay": true|false,
  "ExcludedPages": ["string", ...],
  "FavoritePages": ["string", ...],
  "GuestRoleArn": "string",
  "IdentityPoolId": "string",
  "IncludedPages": ["string", ...],
  "SessionSampleRate": double,
  "Telemetries": ["errors"|"performance"|"http", ...]
}

--custom-events (структура)

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

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

Status -> (строка)

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

Краткая запись синтаксиса:

Status=string

Синтаксис JSON:

{
  "Status": "ENABLED"|"DISABLED"
}

--cw-log-enabled | --no-cw-log-enabled (логическое значение)

Данные, собранные RUM, хранятся в RUM в течение 30 дней, а затем удаляются. Этот параметр указывает, отправляет ли RUM копию этих данных телеметрии в Amazon CloudWatch Logs в вашем аккаунте. Это позволяет хранить данные телеметрии более 30 дней, но влечёт за собой расходы на Amazon CloudWatch Logs.

Если вы опустите этот параметр, значение по умолчанию false.

--deobfuscation-configuration (структура)

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

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

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

S3Uri -> (строка)

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

Status -> (строка)

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

Краткая запись синтаксиса:

JavaScriptSourceMaps={S3Uri=string,Status=string}

Синтаксис JSON:

{
  "JavaScriptSourceMaps": {
    "S3Uri": "string",
    "Status": "ENABLED"|"DISABLED"
  }
}

--domain (строка)

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

--domain-list (список)

Перечислите доменные имена, за которые ваше приложение имеет административные полномочия. CreateAppMonitor требует либо домена, либо списка доменов.

(строка)

Синтаксис:

"string" "string" ...

--name (строка)

Название монитора приложения.

--tags (карта)

Присваивает один или несколько тегов (пар ключ-значение) монитору приложения.

Теги могут помочь вам организовать и категоризировать ваши ресурсы. Вы также можете использовать их для определения прав доступа пользователей, предоставив пользователю разрешения на доступ или изменение только ресурсов с определёнными значениями тегов.

Теги не имеют никакого семантического значения для Amazon Web Services и интерпретируются исключительно как строки символов.

Вы можете ассоциировать до 50 тегов с монитором приложения.

Дополнительную информацию см. в разделе Помечание ресурсов Amazon Web Services.

key -> (строка)

value -> (строка)

Краткая запись синтаксиса:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--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 (boolean)

Включить отладку регистрации.

--endpoint-url (string)

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (string)

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

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

Используемый регион. Переопределяет параметры конфигурации/среды.

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--ca-bundle (string)

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить вывод кли-пейджера.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

Id -> (строка)

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

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

Spec-Zone.ru

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