put-metric-data

Описание

Опубликовывает данные метрики в Amazon CloudWatch. CloudWatch связывает данные со значением указанной метрики. Если указанная метрика не существует, CloudWatch создаёт метрику. При создании метрики CloudWatch может потребоваться до пятнадцати минут, чтобы метрика появилась в вызовах ListMetrics.

Можно опубликовать метрики с сопутствующими данными сущности (чтобы можно было найти и просмотреть связанную телеметрию) или опубликовать данные метрики сами по себе. Чтобы отправить данные сущности вместе с метриками, используйте параметр EntityMetricData. Чтобы отправить метрики без данных сущности, используйте параметр MetricData. Структура EntityMetricData включает структуры MetricData для данных метрики.

Можно опубликовать отдельные значения в поле Value или массивы значений и количество раз, которое каждое значение появлялось в течение периода, используя поля Values и Counts в структуре MetricData. Использование методов Values и Counts позволяет публиковать до 150 значений на метрику с одним запросом PutMetricData, и поддерживает получение перцентильных статистик по этим данным.

Каждый запрос PutMetricData ограничен размером 1 МБ для запросов HTTP POST. Можно отправлять данные, сжатые с помощью gzip. Каждый запрос также ограничен не более чем 1000 различными метриками (по обеим свойствам MetricData и EntityMetricData).

Хотя параметр Value принимает числа типа Double, CloudWatch отклоняет значения, которые слишком маленькие или слишком большие. Значения должны находиться в диапазоне от -2^360 до 2^360. Кроме того, специальные значения (например, NaN, +Infinity, -Infinity) не поддерживаются.

Можно использовать до 30 размерностей на метрику, чтобы дополнительно прояснить, какие данные собирает метрика. Каждая размерность состоит из пары «Имя» и «Значение». Дополнительную информацию об указании размерностей см. в разделе «Опубликование метрик» в руководстве пользователя Amazon CloudWatch.

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

Значения данных с метками времени 24 часа или более назад могут потребовать как минимум 48 часов, чтобы стать доступными для GetMetricData или GetMetricStatistics с момента их отправки. Значения данных с метками времени от 3 до 24 часов назад могут потребовать до 2 часов, чтобы стать доступными для GetMetricData или GetMetricStatistics.

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

• Значение SampleCount набора статистик равно 1, и Min , Max , и Sum все равны.
• Min и Max равны, и Sum равно Min умноженному на SampleCount.

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

Краткое описание

  put-metric-data
--namespace <value>
[--metric-data <value>]
[--entity-metric-data <value>]
[--strict-entity-validation | --no-strict-entity-validation]
[--metric-name <value>]
[--timestamp <value>]
[--unit <value>]
[--value <value>]
[--dimensions <value>]
[--statistic-values <value>]
[--storage-resolution <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]

Параметры

--namespace (строка)

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

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

MetricName=string,Dimensions=[{Name=string,Value=string},{Name=string,Value=string}],Timestamp=timestamp,Value=double,StatisticValues={SampleCount=double,Sum=double,Minimum=double,Maximum=double},Values=double,double,Counts=double,double,Unit=string,StorageResolution=integer ...

Синтаксис JSON:

[
  {
    "MetricName": "string",
    "Dimensions": [
      {
        "Name": "string",
        "Value": "string"
      }
      ...
    ],
    "Timestamp": timestamp,
    "Value": double,
    "StatisticValues": {
      "SampleCount": double,
      "Sum": double,
      "Minimum": double,
      "Maximum": double
    },
    "Values": [double, ...],
    "Counts": [double, ...],
    "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",
    "StorageResolution": integer
  }
  ...
]

--entity-metric-data (список)

Синтаксис JSON:

[
  {
    "Entity": {
      "KeyAttributes": {"string": "string"
        ...},
      "Attributes": {"string": "string"
        ...}
    },
    "MetricData": [
      {
        "MetricName": "string",
        "Dimensions": [
          {
            "Name": "string",
            "Value": "string"
          }
          ...
        ],
        "Timestamp": timestamp,
        "Value": double,
        "StatisticValues": {
          "SampleCount": double,
          "Sum": double,
          "Minimum": double,
          "Maximum": double
        },
        "Values": [double, ...],
        "Counts": [double, ...],
        "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",
        "StorageResolution": integer
      }
      ...
    ]
  }
  ...
]

--strict-entity-validation | --no-strict-entity-validation (boolean)

--metric-name (строка) Название метрики.

--timestamp (строка) Отметка времени, используемая для метрики. Если не указано, по умолчанию устанавливается время получения данных метрики.

--unit (строка) Единица измерения метрики.

--value (строка) Значение метрики. Хотя параметр –value принимает числа типа Double, Amazon CloudWatch усекает значения с очень большими показателями степени. Значения с показателями степени основания 10, превышающими 126 (1 x 10^126), усекаются. Аналогично, значения с показателями степени основания 10, меньшими -130 (1 x 10^-130), также усекаются.

--dimensions (строка) Аргумент –dimensions дополнительно уточняет идентификацию метрики, используя пару Имя=Значение, разделённые запятыми, например: --dimensions InstanceID=1-23456789,InstanceType=m1.small. Обратите внимание, что аргумент --dimensions имеет другой формат при использовании в get-metric-data, где для того же примера вы бы использовали формат --dimensions Name=InstanceID,Value=i-aaba32d4 Name=InstanceType,value=m1.small.

--statistic-values (строка) Набор статистических значений, описывающих метрику.

--storage-resolution (строка)

--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 (строка)

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (строка)

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

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

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

• on
• off
• auto

--no-sign-request (boolean)

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

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

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

Максимальное время подключения к сокету в секундах. Если значение равно 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 (boolean)

Отключить вывод постраничного просмотра CLI.

--cli-auto-prompt (boolean)

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

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

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

Примеры

Для публикации пользовательской метрики в Amazon CloudWatch

В следующем примере используется команда put-metric-data для публикации пользовательской метрики в Amazon CloudWatch:

aws cloudwatch put-metric-data --namespace "Usage Metrics" --metric-data file://metric.json

Значения самой метрики хранятся в файле JSON, metric.json.

Вот содержимое этого файла:

[
  {
    "MetricName": "New Posts",
    "Timestamp": "Wednesday, June 12, 2013 8:28:20 PM",
    "Value": 0.50,
    "Unit": "Count"
  }
]

Дополнительную информацию см. в разделе «Публикация пользовательских метрик» в руководстве разработчика Amazon CloudWatch.

Для указания нескольких измерений

Следующий пример демонстрирует, как указать несколько измерений. Каждое измерение указывается как пара «Имя=Значение». Несколько измерений разделяются запятой:

aws cloudwatch put-metric-data --metric-name Buffers --namespace MyNameSpace --unit Bytes --value 231434333 --dimensions InstanceID=1-23456789,InstanceType=m1.small

Вывод

Нет