Spec-Zone.ru › AWS CLI v2

[ aws . logs ]

put-metric-filter

Описание

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

Максимальное количество фильтров метрик, которые могут быть связаны с группой логов, равно 100.

Поддерживается использование регулярных выражений в шаблонах фильтров. Для таких фильтров существует квота в два шаблона регулярных выражений в одном шаблоне фильтра. Также существует квота в пять шаблонов регулярных выражений на одну группу логов. Более подробную информацию об использовании регулярных выражений в шаблонах фильтров можно найти в разделе Синтаксис шаблона фильтра для метрик, фильтров подписки, фильтров событий логов и Живого хвоста.

При создании фильтра метрики можно также необязательно назначить единицу измерения и измерения метрики, которая создаётся.

Предупреждение

Метрики, извлеченные из событий логов, взимаются как пользовательские метрики. Чтобы избежать неожиданно высоких расходов, не указывайте поля с высокой кардинальностью, такие как IPAddress или requestID, в качестве измерений. Каждое различающееся значение, найденное для измерения, обрабатывается как отдельная метрика и взимает плату как отдельная пользовательская метрика.

CloudWatch Logs может отключить фильтр метрик, если он генерирует 1000 различных пар имя/значение для указанных измерений в течение одного часа.

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

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

Синтаксис

  put-metric-filter
--log-group-name <value>
--filter-name <value>
--filter-pattern <value>
--metric-transformations <value>
[--apply-on-transformed-logs | --no-apply-on-transformed-logs]
[--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]

Параметры

--log-group-name (строка)

Имя группы логов.

--filter-name (строка)

Имя фильтра метрик.

--filter-pattern (строка)

Шаблон фильтра для извлечения данных метрики из событий логов, которые поступают.

--metric-transformations (список)

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

(структура)

Указывает, как преобразовать события логов в данные метрик в метрике CloudWatch.

metricName -> (строка)

Имя метрики CloudWatch.

metricNamespace -> (строка)

Пользовательское пространство имён для группировки ваших метрик в CloudWatch. Используйте пространства имён для группировки похожих метрик. Дополнительную информацию можно найти в разделе Пространства имён.

metricValue -> (строка)

Значение, которое публикуется в метрике CloudWatch, когда шаблон фильтра соответствует событию лога.

defaultValue -> (двойное)

(Необязательно) Значение, которое выводится, когда шаблон фильтра не соответствует событию лога. Это значение может быть null.

dimensions -> (словарь)

Поля, используемые в качестве измерений для метрики. Один фильтр метрики может включать до трёх измерений.

Предупреждение

Метрики, извлеченные из событий логов, взимаются как пользовательские метрики. Чтобы избежать неожиданно высоких расходов, не указывайте поля с высокой кардинальностью, такие как IPAddress или requestID, в качестве измерений. Каждое различающееся значение, найденное для измерения, обрабатывается как отдельная метрика и взимает плату как отдельная пользовательская метрика.

CloudWatch Logs отключает фильтр метрик, если он генерирует 1000 различных пар имя/значение для указанных измерений в течение определенного периода времени. Это помогает предотвратить случайные высокие расходы.

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

key -> (строка)

value -> (строка)

unit -> (строка)

Единица измерения для назначения метрики. Если это опущенно, единица устанавливается как None.

Сокращённый синтаксис:

metricName=string,metricNamespace=string,metricValue=string,defaultValue=double,dimensions={KeyName1=string,KeyName2=string},unit=string ...

Синтаксис JSON:

[
  {
    "metricName": "string",
    "metricNamespace": "string",
    "metricValue": "string",
    "defaultValue": double,
    "dimensions": {"string": "string"
      ...},
    "unit": "Seconds"|"Microseconds"|"Milliseconds"|"Bytes"|"Kilobytes"|"Megabytes"|"Gigabytes"|"Terabytes"|"Bits"|"Kilobits"|"Megabits"|"Gigabits"|"Terabits"|"Percent"|"Count"|"Bytes/Second"|"Kilobytes/Second"|"Megabytes/Second"|"Gigabytes/Second"|"Terabytes/Second"|"Bits/Second"|"Kilobits/Second"|"Megabits/Second"|"Gigabits/Second"|"Terabits/Second"|"Count/Second"|"None"
  }
  ...
]

--apply-on-transformed-logs | --no-apply-on-transformed-logs (логическое значение)

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

Если группа логов использует преобразователь на уровне группы логов или на уровне учётной записи, и вы указываете true, фильтр метрик будет применяться к преобразованной версии событий логов, а не к исходным событиям логов.

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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.

Spec-Zone.ru

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