[ aws . cloudwatch ]
put-anomaly-detector
Описание
Создаёт модель обнаружения аномалий для метрики CloudWatch. Вы можете использовать модель для отображения диапазона ожидаемых нормальных значений при построении графика метрики.
Если вы включили унифицированную наблюдаемость между аккаунтами, и этот аккаунт является аккаунтом мониторинга, метрика может находиться в том же аккаунте или в исходном аккаунте. Вы можете указать идентификатор аккаунта в объекте, указанном в параметре SingleMetricAnomalyDetector.
Дополнительную информацию можно найти в разделе Обнаружение аномалий CloudWatch.
См. также: Документация API AWS
Синтаксис
put-anomaly-detector
[--namespace <value>]
[--metric-name <value>]
[--dimensions <value>]
[--stat <value>]
[--configuration <value>]
[--metric-characteristics <value>]
[--single-metric-anomaly-detector <value>]
[--metric-math-anomaly-detector <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-name (строка)
--dimensions (список)
Размеры метрики, для которых необходимо создать модель обнаружения аномалий.
(структура)
Размер — это пара «имя/значение», которая является частью идентификатора метрики. Поскольку размеры являются частью уникального идентификатора метрики, каждый раз, когда вы добавляете уникальную пару «имя/значение» к одной из ваших метрик, вы создаёте новую вариацию этой метрики. Например, многие метрики Amazon EC2 публикуют InstanceId в качестве имени размера и фактический идентификатор экземпляра в качестве значения для этого размера.
Вы можете назначить до 30 размеров метрике.
Name -> (строка)
:). ASCII-управляющие символы не поддерживаются в качестве части имён размеров.Value -> (строка)
Синтаксис сокращённой записи:
Name=string,Value=string ...
Синтаксис JSON:
[
{
"Name": "string",
"Value": "string"
}
...
]
--stat (строка)
--configuration (структура)
Конфигурация задаёт детали о том, как должна обучаться модель обнаружения аномалий, включая временные интервалы, которые необходимо исключить при обучении и обновлении модели. Вы можете указать до 10 временных интервалов.
Конфигурация также может включать часовой пояс, который необходимо использовать для метрики.
ExcludedTimeRanges -> (список)
Массив временных интервалов, которые необходимо исключить при обучении модели обнаружения аномалий. Используйте это, чтобы убедиться, что события, которые могут привести к необычным значениям метрики, такие как развертывания, не используются при создании модели CloudWatch.
(структура)
Указывает диапазон дней или времени, которые необходимо исключить при обучении модели обнаружения аномалий.
StartTime -> (отметка времени)
yyyy-MM-dd'T'HH:mm:ss. Например, 2019-07-01T23:59:59.EndTime -> (отметка времени)
yyyy-MM-dd'T'HH:mm:ss. Например, 2019-07-01T23:59:59.MetricTimezone -> (строка)
Часовой пояс, который необходимо использовать для метрики. Это полезно для того, чтобы модель могла автоматически учитывать изменения летнего времени, если метрика чувствительна к таким изменениям.
Для указания часового пояса используйте имя часового пояса, указанное в стандартной базе данных tz. Дополнительную информацию см. в базе данных tz.
Синтаксис сокращённой записи:
ExcludedTimeRanges=[{StartTime=timestamp,EndTime=timestamp},{StartTime=timestamp,EndTime=timestamp}],MetricTimezone=string
Синтаксис JSON:
{
"ExcludedTimeRanges": [
{
"StartTime": timestamp,
"EndTime": timestamp
}
...
],
"MetricTimezone": "string"
}
--metric-characteristics (структура)
Используйте этот объект, чтобы включить параметры, предоставляющие информацию о вашей метрике в CloudWatch, чтобы помочь ей создавать более точные модели обнаружения аномалий. В настоящее время он включает параметр PeriodicSpikes.
PeriodicSpikes -> (булево)
true, если значения для этой метрики постоянно включают пики, которые не должны считаться аномалиями. При установке в значение true CloudWatch будет ожидать появления пиков, которые постоянно встречались в период обучения модели, и не будет отмечать будущие аналогичные пики как аномалии.Синтаксис сокращённой записи:
PeriodicSpikes=boolean
Синтаксис JSON:
{
"PeriodicSpikes": true|false
}
--single-metric-anomaly-detector (структура)
Одна модель обнаружения аномалий для метрики, которая должна быть создана.
При использовании SingleMetricAnomalyDetector вы не можете включать следующие параметры в одну операцию:
DimensionsMetricNameNamespaceStat- параметры
MetricMathAnomalyDetectorмоделиPutAnomalyDetectorInput.
Вместо этого укажите атрибуты единственной модели обнаружения аномалий в свойстве SingleMetricAnomalyDetector.
AccountId -> (строка)
Namespace -> (строка)
MetricName -> (строка)
Dimensions -> (список)
Размеры метрики, для которых необходимо создать модель обнаружения аномалий.
(структура)
Размер — это пара «имя/значение», которая является частью идентификатора метрики. Поскольку размеры являются частью уникального идентификатора метрики, каждый раз, когда вы добавляете уникальную пару «имя/значение» к одной из ваших метрик, вы создаёте новую вариацию этой метрики. Например, многие метрики Amazon EC2 публикуют InstanceId в качестве имени размера и фактический идентификатор экземпляра в качестве значения для этого размера.
Вы можете назначить до 30 размеров метрике.
Name -> (строка)
:). ASCII-управляющие символы не поддерживаются в качестве части имён размеров.Value -> (строка)
Stat -> (строка)
Синтаксис сокращённой записи:
AccountId=string,Namespace=string,MetricName=string,Dimensions=[{Name=string,Value=string},{Name=string,Value=string}],Stat=string
Синтаксис JSON:
{
"AccountId": "string",
"Namespace": "string",
"MetricName": "string",
"Dimensions": [
{
"Name": "string",
"Value": "string"
}
...
],
"Stat": "string"
}
--metric-math-anomaly-detector (структура)
Создаваемый детектор аномалий метрических выражений.
При использовании MetricMathAnomalyDetector, вы не можете включать следующие параметры в одной операции:
DimensionsMetricNameNamespaceStat- параметры
SingleMetricAnomalyDetectorобъектаPutAnomalyDetectorInput
Вместо этого, укажите атрибуты детектора аномалий метрических выражений как часть свойства MetricMathAnomalyDetector.
MetricDataQueries -> (список)
Массив структур запросов данных метрик, которые позволяют создать детектор аномалий на основе результата метрического выражения. Каждый элемент в MetricDataQueries получает метрику или выполняет математическое выражение. Один элемент в MetricDataQueries — это выражение, которое предоставляет временной ряд, используемый детектором аномалий в качестве входных данных. Укажите это выражение, установив ReturnData в true для этого объекта в массиве. Для всех остальных выражений и метрик установите ReturnData в false. Указанное выражение должно возвращать один временной ряд.
(структура)
Эта структура используется как в GetMetricData, так и в PutMetricAlarm. Поддерживаемое использование этой структуры отличается для этих двух операций.
При использовании в GetMetricData она указывает данные метрики для возврата и то, является ли этот вызов просто получением набора данных для одной метрики, или выполняет запрос Metrics Insights или математическое выражение. Один вызов GetMetricData может содержать до 500 структур MetricDataQuery.
При использовании в PutMetricAlarm она позволяет создать сигнал тревоги на основе метрического выражения. Каждый элемент MetricDataQuery в массиве задаёт либо метрику для извлечения, либо математическое выражение для выполнения над извлечёнными метриками. Один вызов PutMetricAlarm может содержать до 20 структур MetricDataQuery в массиве. Эти 20 структур могут включать до 10 структур с параметром MetricStat для извлечения метрики и до 10 структур с параметром Expression для выполнения математического выражения. Из этих структур Expression одна должна иметь true в качестве значения для ReturnData. Результат этого выражения — значение, за которым следит сигнал тревоги.
Любое выражение, используемое в операции PutMetricAlarm, должно возвращать один временной ряд. Дополнительную информацию см. в руководстве пользователя Amazon CloudWatch по синтаксису и функциям метрических выражений.
Некоторые параметры этой структуры также имеют разное использование в зависимости от того, используете ли вы эту структуру в операции GetMetricData или в операции PutMetricAlarm. Эти различия объясняются в следующем списке параметров.
Id -> (строка)
GetMetricData. Если вы выполняете математические выражения над этим набором данных, это имя представляет эти данные и может служить переменной в математическом выражении. Допустимые символы: буквы, цифры и символ подчёркивания. Первый символ должен быть строчной буквой.MetricStat -> (структура)
Возвращаемая метрика вместе со статистикой, периодом и единицами измерения. Используйте этот параметр только если этот объект извлекает метрику, а не выполняет математическое выражение над возвращаемыми данными.
Внутри одного объекта MetricDataQuery необходимо указать либо Expression, либо MetricStat, но не оба параметра.
Metric -> (структура)
Возвращаемая метрика, включая имя метрики, имя пространства имён и измерения.
Namespace -> (строка)
MetricName -> (строка)
Dimensions -> (список)
Измерения для метрики.
(структура)
Измерение — это пара «имя/значение», которая является частью идентификатора метрики. Поскольку измерения являются частью уникального идентификатора метрики, каждый раз, когда вы добавляете уникальную пару «имя/значение» к одной из ваших метрик, вы создаёте новую вариацию этой метрики. Например, многие метрики Amazon EC2 публикуют InstanceId в качестве имени измерения, а фактический идентификатор экземпляра — в качестве значения этого измерения.
Вы можете назначить до 30 измерений метрике.
Name -> (строка)
:). ASCII-управляющие символы не поддерживаются в именах измерений.Value -> (строка)
Period -> (целое число)
Гранularity возвращаемых точек данных в секундах. Для метрик с регулярным разрешением период может быть как минимум одной минутой (60 секунд) и должен быть кратен 60. Для метрик с высоким разрешением, которые собираются с интервалами менее одной минуты, период может быть 1, 5, 10, 20, 30, 60 или любым кратным 60. Высокоразрешительные метрики — это метрики, хранящиеся вызовом PutMetricData, который включает StorageResolution в 1 секунду.
Если параметр StartTime указывает временную метку, которая больше чем за 3 часа, вы должны указать период следующим образом, иначе точки данных в этом временном диапазоне не будут возвращены:
- Начальное время от 3 часов до 15 дней назад — используйте кратное 60 секундам (1 минута).
- Начальное время от 15 до 63 дней назад — используйте кратное 300 секундам (5 минут).
- Начальное время более 63 дней назад — используйте кратное 3600 секундам (1 час).
Stat -> (строка)
Unit -> (строка)
При использовании операции Put это определяет единицу измерения, которую вы хотите использовать при хранении метрики.
В операции Get, если вы опустите Unit, то будут возвращены все данные, собранные с любыми единицами, а также соответствующие единицы, указанные при отправке данных в CloudWatch. Если вы укажете единицу измерения, то операция вернёт только данные, собранные с указанной единицей. Если вы укажете единицу, которая не соответствует собранным данным, результаты операции будут null. CloudWatch не выполняет преобразование единиц измерения.
Expression -> (строка)
Это поле может содержать запрос Metrics Insights или метрическое математическое выражение, выполняемое над возвращаемыми данными. Дополнительную информацию о запросах Metrics Insights см. в руководстве пользователя Amazon CloudWatch по компонентам и синтаксису запросов Metrics Insights.
Математическое выражение может использовать Id других метрик или запросов, чтобы ссылаться на эти метрики, а также использовать Id других выражений, чтобы использовать результат этих выражений. Дополнительную информацию о математических выражениях для метрик см. в руководстве пользователя Amazon CloudWatch по синтаксису и функциям метрических выражений.
В каждом объекте MetricDataQuery необходимо указать либо Expression, либо MetricStat, но не оба.
Label -> (строка)
Человекочитаемый ярлык для этой метрики или выражения. Это особенно полезно, если это выражение, чтобы вы знали, что представляет значение. Если метрика или выражение отображаются в виджете панели CloudWatch, отображается метка. Если Label опущено, CloudWatch генерирует значение по умолчанию.
Вы можете поместить динамические выражения в метку, чтобы она была более описательной. Дополнительную информацию см. в разделе "Использование динамических меток".
ReturnData -> (булево)
При использовании в GetMetricData этот параметр указывает, следует ли возвращать метки времени и исходные значения данных этой метрики. Если вы выполняете этот вызов только для выполнения математических выражений и не нуждаетесь в возвращении исходных данных, вы можете указать false. Если вы опустите этот параметр, будет использоваться значение по умолчанию true.
При использовании в PutMetricAlarm укажите true для использования результата одного выражения в качестве сигнала тревоги. Для всех других метрик и выражений в одной и той же операции PutMetricAlarm укажите ReturnData как False.
Period -> (целое число)
PutMetricData, которая включает StorageResolution of 1 second.AccountId -> (строка)
Идентификатор аккаунта, в котором находятся метрики.
Если вы выполняете операцию GetMetricData в аккаунте мониторинга, используйте этот параметр для указания аккаунта, из которого нужно извлечь метрику.
Если вы выполняете операцию PutMetricAlarm, используйте этот параметр для указания аккаунта, содержащего метрику, за которой следит сигнал тревоги.
Синтаксис JSON:
{
"MetricDataQueries": [
{
"Id": "string",
"MetricStat": {
"Metric": {
"Namespace": "string",
"MetricName": "string",
"Dimensions": [
{
"Name": "string",
"Value": "string"
}
...
]
},
"Period": integer,
"Stat": "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"
},
"Expression": "string",
"Label": "string",
"ReturnData": true|false,
"Period": integer,
"AccountId": "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 для вывода.
--cli-auto-prompt (boolean)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическое запросы параметров ввода CLI.
Примеры
Примечание
Для использования следующих примеров, необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
За исключением случаев, когда указано иное, во всех примерах используются правила цитирования, характерные для Unix-систем. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. Дополнительную информацию см. в разделе «Использование кавычек со строками» в Руководстве пользователя AWS CLI.
Для создания модели выявления аномалий
Следующий put-anomaly-detector пример создает модель выявления аномалий для метрики CloudWatch.
aws cloudwatch put-anomaly-detector \
--namespace AWS/Logs \
--metric-name IncomingBytes \
--stat SampleCount
Эта команда не генерирует вывод.
Дополнительную информацию см. в разделе «Использование обнаружения аномалий CloudWatch» в Руководстве пользователя Amazon CloudWatch.
Вывод
Нет
© Copyright 2025, Amazon Web Services. Created using Sphinx.