batch-create-rum-metric-definitions
Описание
Указывает расширенные метрики и настраиваемые метрики, которые должен отправлять монитор приложений CloudWatch RUM в пункт назначения. Допустимыми пунктами назначения являются CloudWatch и Evidently.
По умолчанию мониторы приложений RUM отправляют некоторые метрики в CloudWatch. Эти метрики по умолчанию перечислены в метриках CloudWatch, которые можно собирать с помощью CloudWatch RUM.
Помимо этих метрик по умолчанию, вы можете выбрать отправку расширенных метрик, настраиваемых метрик или обоих типов.
- Расширенные метрики позволяют отправлять метрики с дополнительными измерениями, которые не включены в метрики по умолчанию. Вы также можете отправлять расширенные метрики как в Evidently, так и в CloudWatch. Допустимые имена измерений для дополнительных измерений расширенных метрик —
BrowserName,CountryCode,DeviceType,FileType,OSNameиPageId. Дополнительную информацию см. в разделе Расширенные метрики, которые можно отправлять в CloudWatch и CloudWatch Evidently. - Настраиваемые метрики — это метрики, которые вы определяете. Вы можете отправлять настраиваемые метрики в CloudWatch, CloudWatch Evidently или в оба места. С настраиваемыми метриками вы можете использовать любое имя и пространство имен метрик. Для вычисления метрик вы можете использовать любые пользовательские события, встроенные события, пользовательские атрибуты или атрибуты по умолчанию. Вы не можете отправлять настраиваемые метрики в пространство имен
AWS/RUM. Вы должны отправлять настраиваемые метрики в настраиваемое пространство имен, которое вы определяете. Имя пространства, которое вы используете, не может начинаться сAWS/. CloudWatch RUM добавляет префиксRUM/CustomMetrics/к настраиваемому пространству имен, которое вы определяете, поэтому конечным пространством имен ваших метрик в CloudWatch будет ``RUM/CustomMetrics/ваше-настраиваемое-пространство-имен ``.
Максимальное количество определений метрик, которые можно указать в одной операции BatchCreateRumMetricDefinitions, равно 200.
Максимальное количество определений метрик, которые может содержать один пункт назначения, равно 2000.
Расширенные метрики, отправленные в CloudWatch, и настраиваемые метрики RUM оплачиваются как настраиваемые метрики CloudWatch. Каждая комбинация имени дополнительного измерения и значения измерения считается настраиваемой метрикой. Дополнительную информацию см. в разделе Amazon CloudWatch Pricing.
Перед отправкой метрик необходимо создать пункт назначения для них. Дополнительную информацию см. в разделе PutRumMetricsDestination.
Если некоторые определения метрик, указанные в операции BatchCreateRumMetricDefinitions, недействительны, эти определения метрик завершаются ошибкой, но все действительные определения метрик в той же операции все равно выполняются успешно.
См. также: AWS API Documentation
Синтаксис
batch-create-rum-metric-definitions
--app-monitor-name <value>
--destination <value>
[--destination-arn <value>]
--metric-definitions <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, вы также должны указать Amazon Resource Name (ARN) эксперимента CloudWatchEvidently, который будет получать метрики, и роль IAM, имеющую разрешения на запись в эксперимент.
Возможные значения:
CloudWatchEvidently
--destination-arn (строка)
Этот параметр необходим, если Destination равен Evidently. Если Destination равен CloudWatch, не используйте этот параметр.
Этот параметр указывает ARN эксперимента Evidently, который должен получать метрики. Вы должны предварительно определить этот эксперимент как допустимое назначение. Дополнительную информацию см. в разделе PutRumMetricsDestination.
--metric-definitions (список)
Массив структур, определяющих метрики, которые вы хотите отправить.
(структура)
Используйте эту структуру для определения одной расширенной метрики или пользовательской метрики, которую RUM отправит в CloudWatch или CloudWatch Evidently. Дополнительную информацию см. в разделе Пользовательские метрики и расширенные метрики, которые вы можете отправлять в CloudWatch и CloudWatch Evidently.
Эта структура проверяется по-разному для расширенных и пользовательских метрик. Для расширенных метрик, которые отправляются в пространство имен AWS/RUM, применяются следующие проверки:
- Параметр
Namespaceдолжен быть опущен или установлен вAWS/RUM. - Только определенные сочетания значений для
Name,ValueKeyиEventPatternявляются допустимыми. Помимо представленного ниже списка,EventPatternможет также содержать информацию, используемую полемDimensionKeys.- Если
NameравноPerformanceNavigationDuration, тоValueKeyдолжно быть равноevent_details.duration, аEventPatternдолжно включать в себя{"event_type":["com.amazon.rum.performance_navigation_event"]} - Если
NameравноPerformanceResourceDuration, тоValueKeyдолжно быть равноevent_details.duration, аEventPatternдолжно включать в себя{"event_type":["com.amazon.rum.performance_resource_event"]} - Если
NameравноNavigationSatisfiedTransaction, тоValueKeyдолжно быть равно null, аEventPatternдолжно включать в себя{ "event_type": ["com.amazon.rum.performance_navigation_event"], "event_details": { "duration": [{ "numeric": [">",2000] }] } } - Если
NameравноNavigationToleratedTransaction, тоValueKeyдолжно быть равно null, аEventPatternдолжно включать в себя{ "event_type": ["com.amazon.rum.performance_navigation_event"], "event_details": { "duration": [{ "numeric": [">=",2000,"<"8000] }] } } - Если
NameравноNavigationFrustratedTransaction, тоValueKeyдолжно быть равно null, аEventPatternдолжно включать в себя{ "event_type": ["com.amazon.rum.performance_navigation_event"], "event_details": { "duration": [{ "numeric": [">=",8000] }] } } - Если
NameравноWebVitalsCumulativeLayoutShift, тоValueKeyдолжно быть равноevent_details.value, аEventPatternдолжно включать в себя{"event_type":["com.amazon.rum.cumulative_layout_shift_event"]} - Если
NameравноWebVitalsFirstInputDelay, тоValueKeyдолжно быть равноevent_details.value, аEventPatternдолжно включать в себя{"event_type":["com.amazon.rum.first_input_delay_event"]} - Если
NameравноWebVitalsLargestContentfulPaint, тоValueKeyдолжно быть равноevent_details.value, аEventPatternдолжно включать в себя{"event_type":["com.amazon.rum.largest_contentful_paint_event"]} - Если
NameравноJsErrorCount, тоValueKeyдолжно быть равно null, аEventPatternдолжно включать в себя{"event_type":["com.amazon.rum.js_error_event"]} - Если
NameравноHttpErrorCount, тоValueKeyдолжно быть равно null, аEventPatternдолжно включать в себя{"event_type":["com.amazon.rum.http_event"]} - Если
NameравноSessionCount, тоValueKeyдолжно быть равно null, аEventPatternдолжно включать в себя{"event_type":["com.amazon.rum.session_start_event"]} - Если
NameравноPageViewCount, тоValueKeyдолжно быть равно null, аEventPatternдолжно включать в себя{"event_type":["com.amazon.rum.page_view_event"]} - Если
NameравноHttp4xxCount, тоValueKeyдолжно быть равно null, аEventPatternдолжно включать в себя{"event_type": ["com.amazon.rum.http_event"],"event_details":{"response":{"status":[{"numeric":[">=",400,"<",500]}]}}} } - Если
NameравноHttp5xxCount, тоValueKeyдолжно быть равно null, аEventPatternдолжно включать в себя{"event_type": ["com.amazon.rum.http_event"],"event_details":{"response":{"status":[{"numeric":[">=",500,"<=",599]}]}}} }
- Если
Для пользовательских метрик применяются следующие правила проверки:
- Пространство имен не может быть опущено и не может быть равно
AWS/RUM. Вы можете использовать пространство именAWS/RUMтолько для расширенных метрик. - Все измерения, указанные в поле
DimensionKeys, должны присутствовать в значенииEventPattern. - Значения, которые вы указываете для
ValueKey,EventPatternиDimensionKeys, должны быть полями в событиях RUM, поэтому все ключи первого уровня в этих полях должны быть одним из ключей в списке ниже в этом разделе. - Если вы задаете значение для
EventPattern, оно должно быть объектом JSON. - Для каждого непустого
event_detailsдолжно существовать непустое значениеevent_type. - Если
EventPatternсодержит полеevent_details, оно также должно содержать полеevent_type. Для каждой встроеннойevent_type, которую вы используете, вы должны использовать значение дляevent_details, которое соответствует этойevent_type. Информацию о деталях событий, соответствующих типам событий, см. в разделе Детали событий RUM. - В
EventPatternлюбой массив JSON должен содержать только одно значение.
Допустимые значения ключей первого уровня в полях ValueKey, EventPattern и DimensionKeys:
account_idapplication_Idapplication_versionapplication_namebatch_idevent_detailsevent_idevent_interactionevent_timestampevent_typeevent_versionlog_streammetadatasessionIduser_detailsuserId
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"
}
...
]
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения перепишут значения, предоставленные через JSON. Передача произвольных двоичных данных с помощью значения, предоставленного через JSON, невозможна, поскольку строка будет интерпретироваться буквально. Это не может быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено значение null или строка 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)
Файл с корневым сертификатом для проверки 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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичным данным fileb:// всегда будет рассматриваться как двоичные данные и использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Отключить пейджер CLI для вывода.
--cli-auto-prompt (boolean)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическое запросы параметров ввода CLI.
Вывод
Ошибки -> (список)
Массив объектов ошибок, если операция привела к ошибкам.
(структура)
Структура, определяющая одну ошибку, вызванную операцией BatchCreateRumMetricsDefinitions.
КодОшибки -> (строка)
СообщениеОбОшибке -> (строка)
ОпределениеМетрики -> (структура)
Определение метрики, вызвавшей эту ошибку.
КлючиИзмерений -> (карта)
Используйте этот параметр только если вы отправляете метрику в CloudWatch.
Этот параметр — карта путей к полям и имена измерений. Он определяет измерения, которые необходимо связать с этой метрикой в CloudWatch. Для расширенных метрик допустимые значения для записей в этом поле:
"metadata.pageId": "PageId""metadata.browserName": "BrowserName""metadata.deviceType": "DeviceType""metadata.osName": "OSName""metadata.countryCode": "CountryCode""event_details.fileType": "FileType"
Для расширенных метрик и пользовательских метрик все измерения, указанные в этом поле, также должны быть включены в 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, то метрика публикуется со специфицированными измерениями.
Имя -> (строка)
Имя метрики, определённой в этой структуре. Для пользовательских метрик можно указать любое имя. Для расширенных метрик допустимы следующие значения:
PerformanceNavigationDurationPerformanceResourceDurationNavigationSatisfiedTransactionNavigationToleratedTransactionNavigationFrustratedTransactionWebVitalsCumulativeLayoutShiftWebVitalsFirstInputDelayWebVitalsLargestContentfulPaintJsErrorCountHttpErrorCountSessionCount
ПространствоИмен -> (строка)
Если эта структура предназначена для пользовательской метрики, а не для расширенной метрики, используйте этот параметр для определения пространства имён метрики для этой пользовательской метрики. Не указывайте этот параметр, если эта структура предназначена для расширенной метрики.
Вы не можете использовать любую строку, начинающуюся с AWS/ для вашего пространства имён.
ЕдиницаИзмерения -> (строка)
КлючЗначения -> (строка)
Поле в объекте события, из которого берется значение метрики.
Если вы опустите это поле, жестко закодированное значение 1 будет передано в качестве значения метрики. Это полезно, если вы хотите подсчитать количество событий, которые фильтрует шаблон.
Если эта метрика отправляется в CloudWatch Evidently, это поле будет передано в Evidently без изменений. Evidently обработает извлечение данных из события.
ОпределенияМетрик -> (список)
Массив структур, определяющих расширенные метрики.
(структура)
Структура, отображающая определение одной расширенной метрики, которую RUM отправляет в CloudWatch или CloudWatch Evidently. Дополнительная информация представлена в разделе Дополнительные метрики, которые можно отправлять в CloudWatch и CloudWatch Evidently.
КлючиИзмерений -> (карта)
Это поле — карта путей к полям и имен измерений. Оно определяет измерения, которые следует связать с этой метрикой в CloudWatch. Значение этого поля используется только если пункт назначения метрики — CloudWatch. Если пункт назначения метрики — Evidently, значение DimensionKeys игнорируется.
ключ -> (строка)
значение -> (строка)
ШаблонСобытия -> (строка)
Шаблон, определяющий метрику. RUM проверяет события, происходящие в сессии пользователя, на соответствие шаблону, а события, соответствующие шаблону, отправляются в пункт назначения метрики.
Если пункт назначения метрики — CloudWatch, и событие также соответствует значению в DimensionKeys, то метрика публикуется со специфицированными измерениями.
IDОпределенияМетрики -> (строка)
Имя -> (строка)
ПространствоИмен -> (строка)
ЕдиницаИзмерения -> (строка)
КлючЗначения -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.