обновить-определение-метрики-rum
Описание
Изменяет определение существующей метрики для расширенных метрик CloudWatch RUM. Дополнительную информацию об расширенных метриках см. в разделе BatchCreateRumMetricsDefinitions .
См. также: Документацию API AWS
Синтаксис
update-rum-metric-definition
--app-monitor-name <value>
--destination <value>
[--destination-arn <value>]
--metric-definition <value>
--metric-definition-id <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-name (строка)
--destination (строка)
Назначение для отправки метрик. Допустимые значения — CloudWatch и Evidently. Если вы указываете Evidently, вы также должны указать ARN эксперимента CloudWatchEvidently, который будет получать метрики, и роль IAM, имеющую разрешения на запись в эксперимент.
Возможные значения:
CloudWatchEvidently
--destination-arn (строка)
Этот параметр требуется, если Destination равен Evidently. Если Destination равен CloudWatch, этот параметр не используйте.
Этот параметр указывает ARN эксперимента Evidently, который должен получать метрики. Данный эксперимент должен быть предварительно определен в качестве допустимого назначения. Для получения дополнительной информации см. PutRumMetricsDestination .
--metric-definition (структура)
Структура, содержащая новое определение, которое вы хотите использовать для этой метрики.
DimensionKeys -> (массив)
Используйте этот параметр только если вы отправляете метрику в CloudWatch.
Этот параметр представляет собой массив пар «ключ-значение», где ключ — путь к полю, а значение — имя измерения. Он определяет измерения, которые нужно связать с этой метрикой в CloudWatch. Для расширенных метрик допустимые значения для элементов этого параметра следующие:
"metadata.pageId": "PageId""metadata.browserName": "BrowserName""metadata.deviceType": "DeviceType""metadata.osName": "OSName""metadata.countryCode": "CountryCode""event_details.fileType": "FileType"
Для расширенных и пользовательских метрик все измерения, указанные в этом параметре, также должны быть включены в EventPattern.
ключ -> (строка)
значение -> (строка)
EventPattern -> (строка)
Шаблон, определяющий метрику, заданный как JSON-объект. RUM проверяет события, происходящие в сессии пользователя, на соответствие шаблону, и события, соответствующие шаблону, отправляются в пункт назначения метрики.
При определении расширенных метрик определение метрики недействительно, если EventPattern опущено.
Примеры шаблонов событий:
'{ "event_type": ["com.amazon.rum.js_error_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], } }''{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Firefox" ] }, "event_details": { "duration": [{ "numeric": [ "<", 2000 ] }] } }''{ "event_type": ["com.amazon.rum.performance_navigation_event"], "metadata": { "browserName": [ "Chrome", "Safari" ], "countryCode": [ "US" ] }, "event_details": { "duration": [{ "numeric": [ ">=", 2000, "<", 8000 ] }] } }'
Если пункт назначения метрик — CloudWatch, и событие также соответствует значению в DimensionKeys, то метрика публикуется с указанными измерениями.
Name -> (строка)
Имя метрики, определённое в этой структуре. Для пользовательских метрик вы можете указать любое имя. Для расширенных метрик допустимые значения следующие:
PerformanceNavigationDurationPerformanceResourceDurationNavigationSatisfiedTransactionNavigationToleratedTransactionNavigationFrustratedTransactionWebVitalsCumulativeLayoutShiftWebVitalsFirstInputDelayWebVitalsLargestContentfulPaintJsErrorCountHttpErrorCountSessionCount
Namespace -> (строка)
Если эта структура предназначена для пользовательской метрики, а не для расширенной, используйте этот параметр для определения пространства имён метрики для этой пользовательской метрики. Не указывайте этот параметр, если эта структура предназначена для расширенной метрики.
Вы не можете использовать строку, начинающуюся с AWS/, в качестве пространства имён.
UnitLabel -> (строка)
ValueKey -> (строка)
Поле в объекте события, из которого берётся значение метрики.
Если этот параметр опущен, в качестве значения метрики устанавливается жёстко заданное значение 1. Это полезно, если вы хотите подсчитать количество событий, которые попадают под фильтр.
Если эта метрика отправляется в CloudWatch Evidently, это поле будет передано в Evidently raw. Evidently обработает извлечение данных из события.
Укороченный синтаксис:
DimensionKeys={KeyName1=string,KeyName2=string},EventPattern=string,Name=string,Namespace=string,UnitLabel=string,ValueKey=string
JSON-синтаксис:
{
"DimensionKeys": {"string": "string"
...},
"EventPattern": "string",
"Name": "string",
"Namespace": "string",
"UnitLabel": "string",
"ValueKey": "string"
}
--metric-definition-id (строка)
--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.
Вывод
Нет
© Copyright 2025, Amazon Web Services. Created using Sphinx.