создание целевого уровня обслуживания

Описание

Создаёт целевой уровень обслуживания (SLO), который поможет вам убедиться, что ваши критически важные бизнес-операции соответствуют ожиданиям клиентов. Используйте SLO для установки и отслеживания конкретных целевых уровней надёжности и доступности ваших приложений и служб. SLO используют показатели уровня обслуживания (SLI) для расчёта, достигает ли приложение желаемого уровня производительности.

Создайте SLO для установки целевого значения доступности или задержки службы или операции. CloudWatch часто измеряет это целевое значение, чтобы определить, было ли оно нарушено.

Определённое для SLO целевое качество производительности — это цель достижения.

Вы можете устанавливать целевые значения SLO для ваших приложений, обнаруженных Application Signals, используя критически важные метрики, такие как задержка и доступность. Вы также можете установить SLO по отношению к любой метрике CloudWatch или математическому выражению, которое генерирует временной ряд.

Примечание

Вы не можете создать SLO для операции службы, обнаруженной Application Signals, до тех пор, пока эта операция не передаст стандартные метрики в Application Signals.

При создании SLO вы указываете, является ли это SLO на основе периода или SLO на основе запросов. Каждый тип SLO имеет разный способ оценки производительности вашего приложения по отношению к его целевому значению.

SLO на основе периода использует определённые периоды времени в заданном общем интервале времени. Для каждого периода времени Application Signals определяет, достигло ли приложение своей цели. Коэффициент достижения рассчитывается как number of good periods/number of total periods. Например, для SLO на основе периода достижение целевого значения в 99,9% означает, что в вашем интервале ваше приложение должно достичь своей целевой производительности в течение как минимум 99,9% периодов времени.
SLO на основе запросов не использует предварительно определённых периодов времени. Вместо этого SLO измеряет number of good requests/number of total requests в течение интервала. В любое время вы можете определить отношение успешных запросов к общему количеству запросов для интервала до указанной вами метки времени и сравнить это отношение с заданным в вашем SLO целевым значением.

После создания SLO вы можете получить отчёты о бюджете ошибок. Бюджет ошибок — это количество времени или запросов, которые ваше приложение может быть несовместимым с целью SLO и всё равно ваше приложение достигнет цели.

Для SLO на основе периода бюджет ошибок начинается с числа, определённого наибольшим количеством периодов, которые могут не соответствовать порогу, но всё ещё соответствовать общей цели. Остающийся бюджет ошибок уменьшается с каждым невыполненным периодом, который записывается. Бюджет ошибок в одном интервале никогда не может увеличиться. Например, SLO с порогом, при котором 99,95% запросов должно быть завершено менее чем за 2000 мс каждый месяц, соответствует бюджету ошибок в 21,9 минуты простоя в месяц.
Для SLO на основе запросов остающийся бюджет ошибок динамический и может увеличиваться или уменьшаться в зависимости от отношения успешных запросов к общему количеству запросов.

Дополнительную информацию об SLO см. в разделе Целевые уровни обслуживания (SLO).

При выполнении операции CreateServiceLevelObjective Application Signals создаёт связанную со службой роль AWSServiceRoleForCloudWatchApplicationSignals, если она ещё не существует в вашей учётной записи. Эта связанная со службой роль имеет следующие разрешения:

xray:GetServiceGraph
logs:StartQuery
logs:GetQueryResults
cloudwatch:GetMetricData
cloudwatch:ListMetrics
tag:GetResources
autoscaling:DescribeAutoScalingGroups

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

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

  create-service-level-objective
--name <value>
[--description <value>]
[--sli-config <value>]
[--request-based-sli-config <value>]
[--goal <value>]
[--tags <value>]
[--burn-rate-configurations <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]

Параметры

--name (строка)

Имя этого SLO.

--description (строка)

Необязательное описание этого SLO.

--sli-config (структура)

Если этот целевой показатель уровня сервиса (SLO) основан на периоде, эта структура определяет информацию о метрике производительности, которую будет отслеживать этот SLO.

Вы не можете указать и RequestBasedSliConfig, и SliConfig в одной операции.

SliMetricConfig -> (структура)

Используйте эту структуру для указания метрики, используемой для SLO.

KeyAttributes -> (отображение)

Если этот SLO связан с метрикой, собираемой Application Signals, вы должны использовать это поле для указания сервиса, к которому относится метрика SLO. Для этого необходимо указать как минимум атрибуты Type, Name и Environment.

Это отображение строка-строка. Оно может включать следующие поля.

Type обозначает тип объекта.
ResourceType указывает тип ресурса. Это поле используется только при значении поля Type как Resource или AWS::Resource.
Name указывает имя объекта. Это используется только если значение поля Type равно Service, RemoteService или AWS::Service.
Identifier идентифицирует объекты ресурсов этого ресурса. Это используется только при значении поля Type как Resource или AWS::Resource.
Environment указывает расположение размещения этого объекта или к чему он относится.

ключ -> (строка)

значение -> (строка)

OperationName -> (строка)

Если SLO должен отслеживать конкретную операцию сервиса, используйте это поле для указания имени этой операции.

MetricType -> (строка)

Если SLO должен отслеживать либо метрику LATENCY, либо AVAILABILITY, собираемую Application Signals, используйте это поле, чтобы указать, какая из этих метрик используется.

Statistic -> (строка)

Статистика для сравнения с порогом. Это может быть любая статистика CloudWatch или расширенная статистика. Для получения дополнительной информации см. определения статистик CloudWatch.

PeriodSeconds -> (целое число)

Количество секунд, используемых в качестве периода для оценки SLO. Производительность вашего приложения сравнивается со SLI в течение каждого периода. Для каждого периода определяется, достиг ли приложения необходимой производительности или нет.

MetricDataQueries -> (список)

Если этот SLO отслеживает метрику CloudWatch или результат математического выражения метрики CloudWatch, используйте эту структуру для указания этой метрики или выражения.

(структура)

Используйте эту структуру для определения метрики или математического выражения метрики, которые вы хотите использовать для целевого показателя уровня сервиса.

Каждый MetricDataQuery в массиве MetricDataQueries указывает либо метрику для извлечения, либо математическое выражение метрик для выполнения над извлеченными метриками. Один массив MetricDataQueries может содержать до 20 структур MetricDataQuery в массиве. Эти 20 структур могут содержать до 10 структур с параметром MetricStat для получения метрики и до 10 структур с параметром Expression для выполнения математического выражения. Из этих структур Expression ровно одна должна иметь значение true для параметра ReturnData. Результат этого выражения используется для SLO.

Дополнительную информацию о математических выражениях метрик см. в CloudWatchИспользование математических выражений метрик.

В каждом объекте MetricDataQuery необходимо указать либо Expression, либо MetricStat, но не оба.

Id -> (строка)

Короткое имя, используемое для связи этого объекта с результатами в ответе. Это Id должно быть уникальным внутри массива MetricDataQueries. Если вы выполняете математические выражения над этим набором данных, это имя представляет эти данные и может служить переменной в математическом выражении метрики. Допустимые символы: буквы, цифры и символ подчеркивания. Первый символ должен быть строчной буквой.

MetricStat -> (структура)

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

В одном объекте MetricDataQuery необходимо указать либо Expression, либо MetricStat, но не оба.

Metric -> (структура)

Метрика, используемая в качестве показателя уровня сервиса, включая имя метрики, пространство имен и измерения.

Namespace -> (строка)

Пространство имен метрики. Дополнительную информацию см. в раздела Названия пространств.

MetricName -> (строка)

Имя метрики для использования.

Dimensions -> (список)

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

(структура)

Измерение — это пара «имя/значение», являющаяся частью идентификатора метрики. Поскольку измерения являются частью уникального идентификатора метрики, всякий раз, когда вы добавляете уникальную пару «имя/значение» в одну из ваших метрик, вы создаете новую вариацию этой метрики. Например, многие метрики Amazon EC2 публикуют InstanceId как имя измерения, а фактический идентификатор экземпляра — как значение этого измерения.

Вы можете назначить до 30 измерений метрике.

Name -> (строка)

Имя измерения. Имена измерений должны содержать только символы ASCII, содержать как минимум один символ, отличный от пробела, и не начинаться с двоеточия (:). ASCII-управляющие символы не поддерживаются в именах измерений.

Value -> (строка)

Значение измерения. Значения измерений должны содержать только символы ASCII и содержать как минимум один символ, отличный от пробела. ASCII-управляющие символы не поддерживаются в значениях измерений.

Period -> (целое число)

Детализация в секундах, используемая для метрики. Для метрик с регулярным разрешением период может составлять не менее одной минуты (60 секунд) и должен быть кратным 60. Для метрик с высоким разрешением, собираемых через интервалы менее одной минуты, период может быть 1, 5, 10, 30, 60 или любым кратным 60. Метрики с высоким разрешением — это метрики, хранящиеся вызовом PutMetricData, который включает StorageResolution 1 секунды.

Stat -> (строка)

Unit -> (строка)

Если вы опустите Unit, то будут возвращены все данные, собранные с любым типом единиц, вместе с соответствующими единицами, которые были указаны при отправке данных в CloudWatch. Если вы указываете единицы измерения, операция возвращает только данные, собранные с указанием этих единиц. Если вы указываете единицу, которая не соответствует собранным данным, результаты операции будут null. CloudWatch не выполняет преобразования единиц.

Expression -> (строка)

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

Математическое выражение может использовать Id других метрик или запросов для ссылки на эти метрики, а также может использовать Id других выражений для использования результатов этих выражений. Дополнительную информацию о математических выражениях метрик см. в разделе «Синтаксис и функции математических выражений метрик» в руководстве пользователя Amazon CloudWatch.

В каждом объекте MetricDataQuery необходимо указать либо Expression, либо MetricStat, но не оба.

Label -> (строка)

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

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

ReturnData -> (булево)

Используйте это только в случае использования математического выражения метрики для SLO. Укажите true для ReturnData для использования только результата одного выражения как значения тревоги. Для всех других метрик и выражений в одной операции CreateServiceLevelObjective укажите ReturnData как false.

Period -> (целое число)

Детализация в секундах возвращаемых точек данных для этой метрики. Для метрик с регулярным разрешением период может составлять не менее одной минуты (60 секунд) и должен быть кратным 60. Для метрик с высоким разрешением, собираемых через интервалы менее одной минуты, период может быть 1, 5, 10, 30, 60 или любым кратным 60. Метрики с высоким разрешением — это метрики, хранящиеся вызовом PutMetricData, который включает StorageResolution 1 секунды.

Если параметр StartTime указывает временную метку, которая старше 3 часов, необходимо указать период следующим образом, иначе точки данных в этом диапазоне времени не будут возвращены:

Время начала между 3 часами и 15 днями назад — используйте кратное 60 секундам (1 минута).
Время начала между 15 и 63 днями назад — используйте кратное 300 секундам (5 минут).
Время начала более чем 63 днями назад — используйте кратное 3600 секундам (1 час).

AccountId -> (строка)

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

DependencyConfig -> (структура)

Идентифицирует зависимость с помощью DependencyKeyAttributes и DependencyOperationName.

DependencyKeyAttributes -> (отображение)

Это отображение строка-строка. Оно может включать следующие поля.

Type обозначает тип объекта.
ResourceType указывает тип ресурса. Это поле используется только при значении поля Type как Resource или AWS::Resource.
Name указывает имя объекта. Это используется только при значении поля Type как Service, RemoteService или AWS::Service.
Identifier идентифицирует объекты ресурсов этого ресурса. Это используется только при значении поля Type как Resource или AWS::Resource.
Environment указывает расположение размещения этого объекта или к чему он относится.

ключ -> (строка)

значение -> (строка)

DependencyOperationName -> (строка)

Имя вызываемой операции в зависимости.

MetricThreshold -> (двойное число)

Этот параметр используется только тогда, когда SLO, основанное на запросах, отслеживает метрику Latency. Укажите пороговое значение, с которым будут сравниваться наблюдаемые значения метрики Latency.

ComparisonOperator -> (строка)

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

Синтаксис JSON:

{
  "SliMetricConfig": {
    "KeyAttributes": {"string": "string"
      ...},
    "OperationName": "string",
    "MetricType": "LATENCY"|"AVAILABILITY",
    "Statistic": "string",
    "PeriodSeconds": integer,
    "MetricDataQueries": [
      {
        "Id": "string",
        "MetricStat": {
          "Metric": {
            "Namespace": "string",
            "MetricName": "string",
            "Dimensions": [
              {
                "Name": "string",
                "Value": "string"
              }
              ...
            ]
          },
          "Period": integer,
          "Stat": "string",
          "Unit": "Microseconds"|"Milliseconds"|"Seconds"|"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"
      }
      ...
    ],
    "DependencyConfig": {
      "DependencyKeyAttributes": {"string": "string"
        ...},
      "DependencyOperationName": "string"
    }
  },
  "MetricThreshold": double,
  "ComparisonOperator": "GreaterThanOrEqualTo"|"GreaterThan"|"LessThan"|"LessThanOrEqualTo"
}

--request-based-sli-config (структура)

Если это SLO основано на запросах, эта структура определяет информацию о метрике производительности, которую будет отслеживать данное SLO.

Вы не можете указать одновременно RequestBasedSliConfig и SliConfig в одной операции.

RequestBasedSliMetricConfig -> (структура)

Используйте эту структуру для указания метрики, которая будет использоваться для SLO.

KeyAttributes -> (отображение)

Если это SLO связано с метрикой, собранной Application Signals, вы должны использовать это поле для указания сервиса, к которому относится метрика SLO. Для этого необходимо указать по крайней мере атрибуты Type, Name и Environment.

Это отображение строка-строка. Оно может содержать следующие поля.

Type обозначает тип объекта.
ResourceType указывает тип ресурса. Это поле используется только в том случае, если значение поля Type равно Resource или AWS::Resource.
Name указывает имя объекта. Это используется только если значение поля Type равно Service, RemoteService или AWS::Service.
Identifier идентифицирует объекты ресурсов этого ресурса. Это используется только если значение поля Type равно Resource или AWS::Resource.
Environment указывает расположение, где размещён объект, или к чему он относится.

ключ -> (строка)

значение -> (строка)

OperationName -> (строка)

Если SLO должен отслеживать определённую операцию сервиса, используйте это поле для указания имени этой операции.

MetricType -> (строка)

Если SLO должен отслеживать метрику LATENCY или AVAILABILITY, собранную Application Signals, используйте это поле для указания, какая из этих метрик используется.

TotalRequestCountMetric -> (список)

Используйте эту структуру для определения метрики, которую вы хотите использовать как количество «всех запросов» для SLO, основанного на запросах. Этот результат будет разделен на значение «хороших запросов» или «плохих запросов», определённых в MonitoredRequestCountMetric.

(структура)

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

Каждый MetricDataQuery в массиве MetricDataQueries указывает либо метрику для получения, либо выражение математических операций над полученными метриками. Один массив MetricDataQueries может содержать до 20 структур MetricDataQuery в массиве. Эти 20 структур могут содержать до 10 структур с параметром MetricStat для получения метрики и до 10 структур с параметром Expression для выполнения математических операций. Из этих структур Expression ровно одна должна иметь значение true для ReturnData. Результат этого выражения используется для SLO.

Дополнительную информацию об выражениях математических операций над метриками см. в CloudWatchUse metric math.

В каждом объекте MetricDataQuery необходимо указать либо Expression, либо MetricStat, но не оба.

Id -> (строка)

Короткое имя, используемое для привязки этого объекта к результатам в ответе. Это Id должно быть уникальным в массиве MetricDataQueries. Если вы выполняете математические выражения над этим набором данных, это имя представляет эти данные и может использоваться в качестве переменной в выражении математических операций над метриками. Допустимые символы — буквы, цифры и символ подчеркивания. Первый символ должен быть строчной буквой.

MetricStat -> (структура)

Метрика, которая будет использоваться напрямую для SLO или которая будет использоваться в математическом выражении, используемом для SLO.

В каждом объекте MetricDataQuery необходимо указать либо Expression, либо MetricStat, но не оба.

Metric -> (структура)

Метрика, используемая в качестве индикатора уровня обслуживания, включая имя метрики, пространство имён и измерения.

Namespace -> (строка)

Пространство имён метрики. Дополнительную информацию см. в Namespaces.

MetricName -> (строка)

Имя метрики, которое нужно использовать.

Dimensions -> (список)

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

(структура)

Измерение — это пара имя/значение, являющаяся частью идентификатора метрики. Поскольку измерения являются частью уникального идентификатора метрики, при добавлении уникальной пары имя/значение в одну из ваших метрик вы создаёте новую вариацию этой метрики. Например, многие метрики Amazon EC2 публикуют InstanceId в качестве имени измерения, а фактический идентификатор экземпляра — в качестве значения этого измерения.

Вы можете назначить до 30 измерений метрике.

Name -> (строка)

Имя измерения. Имена измерений должны содержать только символы ASCII, содержать как минимум один не пробельный символ и не начинаться с двоеточия (:). ASCII-управляющие символы не поддерживаются в именах измерений.

Value -> (строка)

Значение измерения. Значения измерений должны содержать только символы ASCII и содержать как минимум один не пробельный символ. ASCII-управляющие символы не поддерживаются в значениях измерений.

Period -> (целое число)

Грань, в секундах, используемая для метрики. Для метрик с регулярным разрешением период может быть как минимум одной минутой (60 секунд) и должен быть кратен 60. Для метрик с высоким разрешением, собираемых с интервалами менее одной минуты, период может быть 1, 5, 10, 30, 60 или любым кратным 60. Метрики с высоким разрешением — это метрики, хранящиеся с помощью вызова PutMetricData, который включает StorageResolution в 1 секунду.

Stat -> (строка)

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

Unit -> (строка)

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

Expression -> (строка)

Это поле может содержать выражение математических операций над метриками, которые вы получаете в этой структуре MetricDataQueries.

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

В каждом объекте MetricDataQuery необходимо указать либо Expression, либо MetricStat, но не оба.

Label -> (строка)

Человекопонятное имя для этой метрики или выражения. Это особенно полезно, если это выражение, чтобы вы знали, что представляет собой значение. Если метрика или выражение отображается в виджете панели мониторинга CloudWatch, отображается имя. Если Label опущено, CloudWatch сгенерирует значение по умолчанию.

Вы можете поместить динамические выражения в имя, чтобы оно было более описательным. Дополнительную информацию см. в разделе Использование динамических имён.

ReturnData -> (булево значение)

Используйте это только в том случае, если вы используете выражение математических операций над метриками для SLO. Укажите true для ReturnData, чтобы получить только результат одного выражения для использования в сигнале тревоги. Для всех других метрик и выражений в той же операции CreateServiceLevelObjective укажите ReturnData как false.

Period -> (целое число)

Грань, в секундах, возвращаемых точек данных для этой метрики. Для метрик с регулярным разрешением период может быть как минимум одной минутой (60 секунд) и должен быть кратен 60. Для метрик с высоким разрешением, собираемых с интервалами менее одной минуты, период может быть 1, 5, 10, 30, 60 или любым кратным 60. Метрики с высоким разрешением — это метрики, хранящиеся с помощью вызова PutMetricData, который включает StorageResolution в 1 секунду.

Если параметр StartTime указывает временную метку, которая старше 3 часов, вы должны указать период следующим образом, иначе точки данных в этом временном диапазоне не будут возвращены:

Время начала между 3 часами и 15 днями назад — используйте кратное 60 секундам (1 минута).
Время начала между 15 и 63 днями назад — используйте кратное 300 секундам (5 минут).
Время начала более 63 дней назад — используйте кратное 3600 секундам (1 час).

AccountId -> (строка)

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

MonitoredRequestCountMetric -> (структура помеченного объединения)

Используйте эту структуру для определения метрики, которую вы хотите использовать в качестве значения «хороший запрос» или «плохой запрос» для уровня обслуживания, основанного на запросах. Это значение, наблюдаемое для метрики, определенной в TotalRequestCountMetric, будет разделено на число, найденное для MonitoredRequestCountMetric, чтобы определить процент успешных запросов, отслеживаемых этим уровнем обслуживания.

Примечание

Это структура помеченного объединения. Можно задать только один из следующих ключей верхнего уровня: GoodCountMetric, BadCountMetric.

GoodCountMetric -> (список)

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

(структура)

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

Каждое MetricDataQuery в массиве MetricDataQueries определяет либо метрику для извлечения, либо математическое выражение метрики для выполнения над извлеченными метриками. Один массив MetricDataQueries может содержать до 20 структур MetricDataQuery в массиве. Эти 20 структур могут содержать до 10 структур, содержащих параметр MetricStat для извлечения метрики, и до 10 структур, содержащих параметр Expression для выполнения математического выражения. Из этих структур Expression ровно одна должна иметь значение true для ReturnData. Результат этого выражения используется для уровня обслуживания.

Дополнительную информацию о математических выражениях метрик см. в CloudWatchUse metric math.

В каждом объекте MetricDataQuery необходимо указать либо Expression, либо MetricStat, но не оба.

Id -> (строка)

Короткое имя, используемое для привязки этого объекта к результатам в ответе. Эта Id должна быть уникальной в массиве MetricDataQueries. Если вы выполняете математические выражения над этим набором данных, это имя представляет эти данные и может служить переменной в математическом выражении метрики. Допустимыми символами являются буквы, цифры и знак подчеркивания. Первый символ должен быть строчной буквой.

MetricStat -> (структура)

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

В одном объекте MetricDataQuery необходимо указать либо Expression, либо MetricStat, но не оба.

Metric -> (структура)

Метрика, используемая в качестве показателя уровня обслуживания, включая имя метрики, пространство имен и измерения.

Namespace -> (строка)

Пространство имен метрики. Дополнительную информацию см. в разделах Namespaces.

MetricName -> (строка)

Имя метрики для использования.

Dimensions -> (список)

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

(структура)

Измерение — это имя/значение, являющееся частью идентификатора метрики. Поскольку измерения являются частью уникального идентификатора метрики, каждый раз, когда вы добавляете уникальную пару имя/значение в одну из своих метрик, вы создаете новую вариацию этой метрики. Например, многие метрики Amazon EC2 публикуют InstanceId в качестве имени измерения, а фактический идентификатор экземпляра — в качестве значения этого измерения.

Вы можете назначить до 30 измерений метрике.

Name -> (строка)

Имя измерения. Имена измерений должны содержать только символы ASCII, содержать как минимум один символ, отличный от пробела, и не должны начинаться с двоеточия (:). Управляющие символы ASCII не поддерживаются как часть имен измерений.

Value -> (строка)

Значение измерения. Значения измерений должны содержать только символы ASCII и содержать как минимум один символ, отличный от пробела. Управляющие символы ASCII не поддерживаются как часть значений измерений.

Period -> (целое число)

Детализация в секундах, которая должна использоваться для метрики. Для метрик с регулярным разрешением период может быть не короче одной минуты (60 секунд) и должен быть кратным 60. Для высокоразрешающих метрик, которые собираются с интервалами менее одной минуты, период может быть 1, 5, 10, 30, 60 или любым кратным 60. Высокоразрешающие метрики — это те метрики, которые хранятся вызовом PutMetricData, включающим StorageResolution в 1 секунду.

Stat -> (строка)

Unit -> (строка)

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

Expression -> (строка)

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

Математическое выражение может использовать Id других метрик или запросов для ссылки на эти метрики, а также может использовать Id других выражений для использования результата этих выражений. Дополнительную информацию о математических выражениях метрик см. в разделе «Синтаксис и функции математических выражений метрик» в руководстве пользователя Amazon CloudWatch.

В каждом объекте MetricDataQuery необходимо указать либо Expression, либо MetricStat, но не оба.

Label -> (строка)

Человекопонятное метка для этой метрики или выражения. Это особенно полезно, если это выражение, чтобы вы знали, что оно представляет. Если метрика или выражение отображается в виджете панели мониторинга CloudWatch, метка отображается. Если Label опущена, CloudWatch генерирует значение по умолчанию.

Вы можете поместить динамические выражения в метку, чтобы она была более описательной. Дополнительную информацию см. в разделе «Использование динамических меток».

ReturnData -> (булево значение)

Используйте это только в том случае, если вы используете математическое выражение метрики для уровня обслуживания. Укажите true для ReturnData, чтобы использовать только один результат выражения в качестве сигнала тревоги. Для всех других метрик и выражений в той же операции CreateServiceLevelObjective укажите ReturnData как false.

Period -> (целое число)

Детализация в секундах возвращаемых точек данных для этой метрики. Для метрик с регулярным разрешением период может быть не короче одной минуты (60 секунд) и должен быть кратным 60. Для высокоразрешающих метрик, которые собираются с интервалами менее одной минуты, период может быть 1, 5, 10, 30, 60 или любым кратным 60. Высокоразрешающие метрики — это те метрики, которые хранятся вызовом PutMetricData, включающим StorageResolution в 1 секунду.

Если параметр StartTime указывает отметку времени, которая больше, чем 3 часа назад, необходимо указать период следующим образом, в противном случае точки данных в этом диапазоне времени не будут возвращены:

Время начала от 3 часов до 15 дней назад — используйте кратное 60 секундам (1 минута).
Время начала от 15 до 63 дней назад — используйте кратное 300 секундам (5 минут).
Время начала более чем 63 дня назад — используйте кратное 3600 секундам (1 час).

AccountId -> (строка)

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

BadCountMetric -> (список)

Если вы хотите посчитать «плохие запросы», чтобы определить процент успешных запросов для этого SLO на основе запросов, укажите метрику, которая будет использоваться в качестве «плохих запросов» в этой структуре.

(структура)

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

Каждый MetricDataQuery в массиве MetricDataQueries определяет либо метрику для извлечения, либо выражение математической обработки метрик, которое должно быть выполнено над извлечёнными метриками. Один массив MetricDataQueries может содержать до 20 структур MetricDataQuery. Эти 20 структур могут содержать до 10 структур с параметром MetricStat для извлечения метрики и до 10 структур с параметром Expression для выполнения математического выражения. Из этих структур Expression ровно одна должна иметь значение true для ReturnData. Результат этого выражения используется для SLO.

Дополнительную информацию об выражениях математической обработки метрик см. в CloudWatchUse metric math.

В каждом объекте MetricDataQuery необходимо указать либо Expression, либо MetricStat, но не оба.

Id -> (строка)

Короткое имя, используемое для привязки этого объекта к результатам в ответе. Это Id должно быть уникальным в массиве MetricDataQueries. Если вы выполняете математические выражения над этим набором данных, это имя представляет эти данные и может служить переменной в выражении математической обработки метрик. Допустимые символы — буквы, цифры и символ подчеркивания. Первый символ должен быть строчной буквой.

MetricStat -> (структура)

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

В одном объекте MetricDataQuery необходимо указать либо Expression, либо MetricStat, но не оба.

Metric -> (структура)

Namespace -> (строка)

Пространство имён метрики. Дополнительную информацию см. в Разделы.

MetricName -> (строка)

Имя используемой метрики.

Dimensions -> (список)

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

(структура)

Измерение — это пара «имя/значение», являющаяся частью идентификатора метрики. Поскольку измерения являются частью уникального идентификатора метрики, каждый раз, когда вы добавляете уникальную пару «имя/значение» в одну из своих метрик, вы создаёте новую вариацию этой метрики. Например, многие метрики Amazon EC2 публикуют InstanceId как имя измерения, а фактический идентификатор экземпляра — как значение этого измерения.

Вы можете назначить до 30 измерений метрике.

Name -> (строка)

Имя измерения. Имена измерений должны содержать только символы ASCII, содержать как минимум один не пробельный символ и не начинаться с двоеточия (:). Символы управления ASCII не поддерживаются в качестве части имён измерений.

Value -> (строка)

Значение измерения. Значения измерений должны содержать только символы ASCII и содержать как минимум один не пробельный символ. Символы управления ASCII не поддерживаются в качестве части значений измерений.

Period -> (целое число)

Детализация в секундах, используемая для метрики. Для метрик с регулярным разрешением период может быть не короче одной минуты (60 секунд) и должен быть кратен 60. Для метрик с высоким разрешением, которые собираются с интервалами менее одной минуты, период может быть 1, 5, 10, 30, 60 или любым кратным 60. Метрики с высоким разрешением — это те метрики, которые хранятся с помощью вызова PutMetricData, включающего StorageResolution в 1 секунду.

Stat -> (строка)

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

Unit -> (строка)

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

Expression -> (строка)

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

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

В каждом объекте MetricDataQuery необходимо указать либо Expression, либо MetricStat, но не оба.

Label -> (строка)

Чловеко-понятное метка для этой метрики или выражения. Это особенно полезно, если это выражение, чтобы вы знали, что представляет значение. Если метрика или выражение отображается в виджете панели мониторинга CloudWatch, метка отображается. Если Label опущено, CloudWatch генерирует значение по умолчанию.

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

ReturnData -> (булево)

Используйте только в том случае, если вы используете выражение математической обработки метрик для SLO. Укажите true для ReturnData, чтобы использовать только результат одного выражения в качестве сигнала тревоги. Для всех других метрик и выражений в той же операции CreateServiceLevelObjective укажите ReturnData как false.

Period -> (целое число)

Детализация в секундах возвращаемых точек данных для этой метрики. Для метрик с регулярным разрешением период может быть не короче одной минуты (60 секунд) и должен быть кратен 60. Для метрик с высоким разрешением, которые собираются с интервалами менее одной минуты, период может быть 1, 5, 10, 30, 60 или любым кратным 60. Метрики с высоким разрешением — это те метрики, которые хранятся с помощью вызова PutMetricData, включающего StorageResolution в 1 секунду.

Если параметр StartTime указывает отметку времени более чем за 3 часа назад, необходимо указать период следующим образом, иначе точки данных в этом диапазоне времени не будут возвращены:

Время начала между 3 часами и 15 днями назад — используйте кратное 60 секундам (1 минуте).
Время начала между 15 и 63 днями назад — используйте кратное 300 секундам (5 минутам).
Время начала более чем 63 днями назад — используйте кратное 3600 секундам (1 часу).

AccountId -> (строка)

DependencyConfig -> (структура)

Определяет зависимость с использованием DependencyKeyAttributes и DependencyOperationName.

DependencyKeyAttributes -> (отображение)

Это отображение строки к строке. Оно может содержать следующие поля.

Type обозначает тип объекта.
ResourceType определяет тип ресурса. Это поле используется только тогда, когда значение поля Type равно Resource или AWS::Resource.
Name определяет имя объекта. Это используется только в том случае, если значение поля Type равно Service, RemoteService или AWS::Service.
Identifier определяет объекты ресурсов данного ресурса. Это используется только в том случае, если значение поля Type равно Resource или AWS::Resource.
Environment указывает расположение, где размещён данный объект, или к чему он относится.

key -> (строка)

value -> (строка)

DependencyOperationName -> (строка)

Имя вызываемой операции в зависимости.

MetricThreshold -> (двойное значение)

Значение, с которым сравнивается метрика SLI. Этот параметр требуется, если данное SLO отслеживает метрику Latency.

ComparisonOperator -> (строка)

Арифметическая операция, используемая при сравнении указанной метрики с пороговым значением. Этот параметр требуется, если данное SLO отслеживает метрику Latency.

Синтаксис JSON:

{
  "RequestBasedSliMetricConfig": {
    "KeyAttributes": {"string": "string"
      ...},
    "OperationName": "string",
    "MetricType": "LATENCY"|"AVAILABILITY",
    "TotalRequestCountMetric": [
      {
        "Id": "string",
        "MetricStat": {
          "Metric": {
            "Namespace": "string",
            "MetricName": "string",
            "Dimensions": [
              {
                "Name": "string",
                "Value": "string"
              }
              ...
            ]
          },
          "Period": integer,
          "Stat": "string",
          "Unit": "Microseconds"|"Milliseconds"|"Seconds"|"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"
      }
      ...
    ],
    "MonitoredRequestCountMetric": {
      "GoodCountMetric": [
        {
          "Id": "string",
          "MetricStat": {
            "Metric": {
              "Namespace": "string",
              "MetricName": "string",
              "Dimensions": [
                {
                  "Name": "string",
                  "Value": "string"
                }
                ...
              ]
            },
            "Period": integer,
            "Stat": "string",
            "Unit": "Microseconds"|"Milliseconds"|"Seconds"|"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"
        }
        ...
      ],
      "BadCountMetric": [
        {
          "Id": "string",
          "MetricStat": {
            "Metric": {
              "Namespace": "string",
              "MetricName": "string",
              "Dimensions": [
                {
                  "Name": "string",
                  "Value": "string"
                }
                ...
              ]
            },
            "Period": integer,
            "Stat": "string",
            "Unit": "Microseconds"|"Milliseconds"|"Seconds"|"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"
        }
        ...
      ]
    },
    "DependencyConfig": {
      "DependencyKeyAttributes": {"string": "string"
        ...},
      "DependencyOperationName": "string"
    }
  },
  "MetricThreshold": double,
  "ComparisonOperator": "GreaterThanOrEqualTo"|"GreaterThan"|"LessThan"|"LessThanOrEqualTo"
}

--goal (структура)

Эта структура содержит атрибуты, определяющие цель SLO.

Interval -> (структура помеченного объединения)

Период времени, используемый для оценки SLO. Он может быть либо календарным интервалом, либо скользящим интервалом.

Если этот параметр опущен, используется скользящий интервал в 7 дней.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть установлен: RollingInterval, CalendarInterval.

RollingInterval -> (структура)

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

DurationUnit -> (строка)

Указывает единицу измерения скользящего интервала.

Duration -> (целое число)

Указывает продолжительность каждого скользящего интервала. Например, если Duration является 7 и DurationUnit является DAY, каждый скользящий интервал составляет семь дней.

CalendarInterval -> (структура)

Если интервал является календарным, эта структура содержит спецификации интервала.

StartTime -> (метка времени)

Дата и время, когда должен начаться первый интервал. Убедитесь, что выбрано время, которое настраивает интервалы так, как вам нужно. Например, если вы хотите еженедельные интервалы, начинающиеся по понедельникам в 6:00 утра, убедитесь, что указано время начала - понедельник в 6:00 утра.

При использовании в API сырых HTTP-запросов он форматируется как время эпохи во секундах. Например: 1698778057

Как только один календарный интервал заканчивается, другой автоматически начинается.

DurationUnit -> (строка)

Указывает единицу измерения календарного интервала.

Duration -> (целое число)

Указывает продолжительность каждого календарного интервала. Например, если Duration является 1 и DurationUnit является MONTH, каждый интервал составляет один месяц, согласованный с календарем.

AttainmentGoal -> (двойное значение)

Порог, определяющий, достигается ли цель.

Если это SLO на основе периода, целевое значение достижения — это процент хороших периодов, удовлетворяющих требованиям порога, по отношению ко всем периодам в интервале. Например, целевое значение достижения 99,9% означает, что в вашем интервале вы нацелены на 99,9% периодов, которые будут находиться в здоровом состоянии.

Если это SLO на основе запросов, целевое значение достижения — это процент запросов, которые должны быть успешными, чтобы достичь целевого значения.

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

WarningThreshold -> (двойное значение)

Процент оставшегося бюджета от общего бюджета, для которого вы хотите получить предупреждения. Если этот параметр опущен, используется значение по умолчанию 50,0.

Сокращенная синтаксическая запись:

Interval={RollingInterval={DurationUnit=string,Duration=integer},CalendarInterval={StartTime=timestamp,DurationUnit=string,Duration=integer}},AttainmentGoal=double,WarningThreshold=double

Синтаксис JSON:

{
  "Interval": {
    "RollingInterval": {
      "DurationUnit": "MINUTE"|"HOUR"|"DAY"|"MONTH",
      "Duration": integer
    },
    "CalendarInterval": {
      "StartTime": timestamp,
      "DurationUnit": "MINUTE"|"HOUR"|"DAY"|"MONTH",
      "Duration": integer
    }
  },
  "AttainmentGoal": double,
  "WarningThreshold": double
}

--tags (список)

Список пар «ключ-значение» для связывания со SLO. Вы можете связать до 50 тегов с SLO. Чтобы иметь возможность связывать теги со SLO при создании SLO, у вас должны быть права cloudwatch:TagResource.

Теги могут помочь вам организовать и категоризировать ваши ресурсы. Вы также можете использовать их для ограничения прав пользователей, предоставляя пользователю разрешение на доступ к ресурсам или изменения только ресурсов с определёнными значениями тегов.

(структура)

Пара «ключ-значение», связанная с ресурсом. Теги могут помочь вам организовать и категоризировать ваши ресурсы.

Key -> (строка)

Строка, которую вы можете использовать для назначения значения. Комбинация ключей и значений тегов может помочь вам организовать и категоризировать ваши ресурсы.

Value -> (строка)

Значение для указанного ключа тега.

Сокращенная синтаксическая запись:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--burn-rate-configurations (список)

Используйте этот массив для создания темпов прироста для данного SLO. Каждый темп прироста — это метрика, которая указывает, насколько быстро служба потребляет бюджет ошибок по отношению к целевому значению достижения SLO.

(структура)

Этот объект определяет длину окна обратного просмотра, используемого для расчета одной метрики темпа прироста для этого SLO. Темп прироста показывает, насколько быстро служба потребляет бюджет ошибок относительно целевого значения достижения SLO. Темп прироста, равный точно 1, указывает, что цель SLO будет достигнута точно.

Например, если вы укажете 60 минут как длину окна обратного просмотра, темп прироста вычисляется следующим образом:

темп прироста = скорость ошибки за окно обратного просмотра / (100% - процент целевого значения достижения)

Дополнительную информацию о темпах прироста см. в разделе Calculate burn rates.

LookBackWindowMinutes -> (целое число)

Количество минут, используемых в качестве окна обратного просмотра.

Сокращенная синтаксическая запись:

LookBackWindowMinutes=integer ...

Синтаксис JSON:

[
  {
    "LookBackWindowMinutes": integer
  }
  ...
]

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

Вывод

Slo -> (структура)

Структура, содержащая информацию о созданном SLO.

Arn -> (строка)

ARN данного SLO.

Name -> (строка)

Имя данного SLO.

Description -> (строка)

Описание, созданное для данного SLO.

CreatedTime -> (метка времени)

Дата и время создания SLO. При использовании в сыром HTTP-запросе API он форматируется как yyyy-MM-dd'T'HH:mm:ss. Например, 2019-07-01T23:59:59.

LastUpdatedTime -> (метка времени)

Время последнего обновления SLO. При использовании в сыром HTTP-запросе API он форматируется как yyyy-MM-dd'T'HH:mm:ss. Например, 2019-07-01T23:59:59.

Sli -> (структура)

Структура, содержащая информацию об измерителе производительности, за которым следит данное целевое значение уровня обслуживания (SLO), если это SLO на основе периода.

SliMetric -> (структура)

Структура, содержащая информацию об измерителе, за которым следит SLO.

KeyAttributes -> (карта)

Это карта «строка-строка», содержащая информацию о типе объекта, к которому относится данное SLO. Она может включать следующие поля.

Type указывает тип объекта, к которому относится данное SLO.
ResourceType указывает тип ресурса. Это поле используется только в случае, если значение поля Type равно Resource или AWS::Resource.
Name указывает имя объекта. Это используется только в случае, если значение поля Type равно Service, RemoteService или AWS::Service.
Identifier идентифицирует объекты ресурсов данного ресурса. Это используется только в случае, если значение поля Type равно Resource или AWS::Resource.
Environment указывает местоположение, где размещен этот объект, или к чему он относится.

ключ -> (строка)

значение -> (строка)

OperationName -> (строка)

Если SLO отслеживает определённую операцию службы, это поле отображает имя этой операции.

MetricType -> (строка)

Если SLO отслеживает либо метрику LATENCY, либо метрику AVAILABILITY, которые собирает Application Signals, это поле показывает, какая из этих метрик используется.

MetricDataQueries -> (список)

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

(структура)

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

Каждый элемент MetricDataQuery в массиве MetricDataQueries указывает либо метрику для извлечения, либо математическое выражение над извлечёнными метриками. Один массив MetricDataQueries может содержать до 20 элементов структуры MetricDataQuery. Эти 20 структур могут включать до 10 структур, содержащих параметр MetricStat для извлечения метрики, и до 10 структур, содержащих параметр Expression для выполнения математического выражения. Из этих структур Expression ровно одна должна иметь значение true для параметра ReturnData. Результат этого выражения используется для SLO.

Дополнительную информацию о математических выражениях над метриками см. в документации CloudWatch по математическим выражениям над метриками.

В каждом элементе MetricDataQuery необходимо указать либо Expression, либо MetricStat, но не оба.

Id -> (строка)

Короткое имя, используемое для привязки этого объекта к результатам в ответе. Это Id должно быть уникальным в массиве MetricDataQueries. Если вы выполняете математические выражения над этим набором данных, это имя представляет эти данные и может служить переменной в математическом выражении над метриками. Допустимые символы — буквы, цифры и знак подчеркивания. Первый символ должен быть строчной буквой.

MetricStat -> (структура)

В одном элементе MetricDataQuery необходимо указать либо Expression, либо MetricStat, но не оба.

Metric -> (структура)

Метрика, используемая в качестве показателя уровня обслуживания, включая имя метрики, пространство имён и измерения.

Namespace -> (строка)

Пространство имён метрики. Дополнительную информацию см. в разделе Пространства имён.

MetricName -> (строка)

Имя метрики, которую следует использовать.

Dimensions -> (список)

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

(структура)

Измерение — это пара «имя/значение», которая является частью идентификатора метрики. Поскольку измерения являются частью уникального идентификатора метрики, каждый раз, когда вы добавляете уникальную пару «имя/значение» к одной из ваших метрик, вы создаёте новую вариацию этой метрики. Например, многие метрики Amazon EC2 публикуют InstanceId в качестве имени измерения, а фактический идентификатор экземпляра — в качестве значения этого измерения.

Вы можете назначить до 30 измерений метрике.

Name -> (строка)

Value -> (строка)

Period -> (целое число)

Грань, в секундах, для метрики. Для метрик с регулярным разрешением грань может составлять одну минуту (60 секунд) и должна быть кратной 60. Для метрик с высоким разрешением, которые собираются с интервалами менее одной минуты, грань может составлять 1, 5, 10, 30, 60 или любое кратное 60. Метрики с высоким разрешением — это метрики, хранящиеся с помощью вызова PutMetricData, который включает параметр StorageResolution в 1 секунду.

Stat -> (строка)

Unit -> (строка)

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

Expression -> (строка)

Это поле может содержать математическое выражение над метриками, которые вы извлекаете в этой структуре MetricDataQueries.

Математическое выражение может использовать Id других метрик или запросов для ссылки на эти метрики и также может использовать Id других выражений для использования результата этих выражений. Дополнительную информацию о математических выражениях над метриками см. в разделе Синтаксис и функции математических выражений над метриками в руководстве пользователя Amazon CloudWatch.

В каждом элементе MetricDataQuery необходимо указать либо Expression, либо MetricStat, но не оба.

Label -> (строка)

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

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

ReturnData -> (логическое значение)

Используйте это только в том случае, если вы используете математическое выражение над метриками для SLO. Укажите true для ReturnData, чтобы получить только результат одного выражения для использования в качестве сигнала тревоги. Для всех других метрик и выражений в той же операции CreateServiceLevelObjective укажите ReturnData в качестве значения false.

Period -> (целое число)

Грань, в секундах, возвращаемых точек данных для этой метрики. Для метрик с регулярным разрешением грань может составлять одну минуту (60 секунд) и должна быть кратной 60. Для метрик с высоким разрешением, которые собираются с интервалами менее одной минуты, грань может составлять 1, 5, 10, 30, 60 или любое кратное 60. Метрики с высоким разрешением — это метрики, хранящиеся с помощью вызова PutMetricData, который включает параметр StorageResolution в 1 секунду.

Если параметр StartTime указывает отметку времени более чем 3 часа назад, вы должны указать грань следующим образом, иначе точки данных в этом диапазоне времени не будут возвращены:

Время начала между 3 часами и 15 днями назад — используйте кратное 60 секундам (1 минуте).
Время начала между 15 и 63 днями назад — используйте кратное 300 секундам (5 минутам).
Время начала более 63 дней назад — используйте кратное 3600 секундам (1 часу).

AccountId -> (строка)

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

DependencyConfig -> (структура)

Идентифицирует зависимость, используя DependencyKeyAttributes и DependencyOperationName.

DependencyKeyAttributes -> (карта)

Это карта «строка-строка». Она может включать следующие поля.

Type указывает тип объекта.
ResourceType указывает тип ресурса. Это поле используется только в случае, если значение поля Type равно Resource или AWS::Resource.
Name указывает имя объекта. Это используется только в случае, если значение поля Type равно Service, RemoteService или AWS::Service.
Identifier идентифицирует объекты ресурсов данного ресурса. Это используется только в случае, если значение поля Type равно Resource или AWS::Resource.
Environment указывает местоположение размещения объекта или к чему он относится.

ключ -> (строка)

значение -> (строка)

DependencyOperationName -> (строка)

Имя вызываемой операции в зависимости.

MetricThreshold -> (двойное число)

Значение, к которому сравнивается метрика SLI.

ComparisonOperator -> (строка)

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

RequestBasedSli -> (структура)

Структура, содержащая информацию о метрике производительности, которую отслеживает данное SLO, если это SLO на основе запросов.

RequestBasedSliMetric -> (структура)

Структура, содержащая информацию о метрике, которую отслеживает SLO.

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

Это словарь «строка-строка», содержащий информацию о типе объекта, к которому относится данное SLO. Он может содержать следующие поля.

Type указывает тип объекта, к которому относится данное SLO.
ResourceType определяет тип ресурса. Это поле используется только в том случае, если значение поля Type равно Resource или AWS::Resource .
Name указывает имя объекта. Это используется только в том случае, если значение поля Type равно Service , RemoteService или AWS::Service .
Identifier идентифицирует объекты ресурсов данного ресурса. Это используется только в том случае, если значение поля Type равно Resource или AWS::Resource .
Environment указывает расположение, в котором размещен этот объект, или к чему он принадлежит.

ключ -> (строка)

значение -> (строка)

OperationName -> (строка)

Если SLO отслеживает определённую операцию сервиса, в этом поле отображается имя этой операции.

MetricType -> (строка)

Если SLO отслеживает метрику LATENCY или AVAILABILITY, собираемую Application Signals, в этом поле отображается используемая метрика.

TotalRequestCountMetric -> (список)

Эта структура определяет метрику, используемую в качестве количества «всех запросов» для SLO на основе запросов. Значение, наблюдаемое для этой метрики, делится на количество «хороших запросов» или «плохих запросов», наблюдаемых для метрики, определённой в MonitoredRequestCountMetric.

(структура)

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

Каждый MetricDataQuery в массиве MetricDataQueries указывает либо метрику для извлечения, либо математическое выражение метрики, которое нужно выполнить над извлечёнными метриками. Один массив MetricDataQueries может включать до 20 структур MetricDataQuery в массиве. 20 структур могут включать до 10 структур с параметром MetricStat для извлечения метрики и до 10 структур с параметром Expression для выполнения математического выражения. Из этих структур Expression ровно одна должна иметь значение «истина» для параметра ReturnData . Результат этого выражения используется для SLO.

Дополнительную информацию о математических выражениях метрик см. в CloudWatchUse metric math.

В каждом объекте MetricDataQuery вы должны указать либо Expression, либо MetricStat, но не оба.

Id -> (строка)

Короткое имя, используемое для привязки этого объекта к результатам в ответе. Это Id должно быть уникальным в массиве MetricDataQueries. Если вы выполняете математические выражения над этим набором данных, это имя представляет эти данные и может служить переменной в математическом выражении метрики. Допустимые символы — буквы, цифры и символ подчеркивания. Первый символ должен быть строчной буквой.

MetricStat -> (структура)

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

В каждом объекте MetricDataQuery вы должны указать либо Expression, либо MetricStat, но не оба.

Metric -> (структура)

Namespace -> (строка)

Пространство имен метрики. Дополнительную информацию см. в Namespaces.

MetricName -> (строка)

Имя используемой метрики.

Dimensions -> (список)

(структура)

Измерение — это пара «имя/значение», являющаяся частью идентификатора метрики. Поскольку измерения являются частью уникального идентификатора метрики, каждый раз, когда вы добавляете уникальную пару «имя/значение» в одну из своих метрик, вы создаете новую разновидность этой метрики. Например, многие метрики Amazon EC2 публикуют InstanceId в качестве имени измерения, а фактический идентификатор экземпляра в качестве значения этого измерения.

Вы можете назначить до 30 измерений метрике.

Name -> (строка)

Имя измерения. Имена измерений должны содержать только символы ASCII, должны содержать по крайней мере один символ, отличный от пробела, и не должны начинаться с двоеточия (:). ASCII-управляющие символы не поддерживаются как часть имён измерений.

Value -> (строка)

Значение измерения. Значения измерений должны содержать только символы ASCII и должны содержать по крайней мере один символ, отличный от пробела. ASCII-управляющие символы не поддерживаются в качестве части значений измерений.

Period -> (целое число)

Грань, в секундах, используемая для метрики. Для метрик с регулярным разрешением период может быть так мал, как одна минута (60 секунд), и должен быть кратен 60. Для метрик с высоким разрешением, собираемых с интервалами менее одной минуты, период может быть 1, 5, 10, 30, 60 или любым кратным 60. Метрики с высоким разрешением — это метрики, хранящиеся с помощью вызова PutMetricData, содержащего StorageResolution 1 секунды.

Stat -> (строка)

Статистика, используемая для сравнения с порогом. Это может быть любая статистика CloudWatch или расширенная статистика. Дополнительную информацию о статистике см. в CloudWatch statistics definitions.

Unit -> (строка)

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

Expression -> (строка)

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

Математическое выражение может использовать Id других метрик или запросов для ссылки на эти метрики, а также может использовать Id других выражений для использования результата этих выражений. Дополнительную информацию о математических выражениях метрик см. в Metric Math Syntax and Functions в Руководстве пользователя Amazon CloudWatch.

В каждом объекте MetricDataQuery вы должны указать либо Expression, либо MetricStat, но не оба.

Label -> (строка)

Человеко-читаемое имя метрики или выражения. Это особенно полезно, если это выражение, чтобы вы знали, что представляет значение. Если метрика или выражение отображается в виджете панели мониторинга CloudWatch, отображается имя. Если Label опущено, CloudWatch генерирует значение по умолчанию.

Вы можете вводить динамические выражения в имя, чтобы оно было более описательным. Дополнительную информацию см. в Using Dynamic Labels.

ReturnData -> (логическое значение)

Используйте это только если вы используете математическое выражение метрики для SLO. Установите true для ReturnData, чтобы получить только результат одного выражения для использования в качестве сигнала тревоги. Для всех других метрик и выражений в той же операции CreateServiceLevelObjective укажите ReturnData как false.

Period -> (целое число)

Грань, в секундах, возвращаемых точек данных для данной метрики. Для метрик с регулярным разрешением период может быть так мал, как одна минута (60 секунд), и должен быть кратен 60. Для метрик с высоким разрешением, собираемых с интервалами менее одной минуты, период может быть 1, 5, 10, 30, 60 или любым кратным 60. Метрики с высоким разрешением — это метрики, хранящиеся с помощью вызова PutMetricData, содержащего StorageResolution 1 секунды.

Если параметр StartTime указывает отметку времени, которая больше, чем 3 часа назад, необходимо указать период следующим образом, иначе точки данных в этом временном диапазоне не будут возвращены:

Время начала между 3 часами и 15 днями назад — использовать кратное 60 секундам (1 минуте).
Время начала между 15 и 63 днями назад — использовать кратное 300 секундам (5 минутам).
Время начала более 63 дней назад — использовать кратное 3600 секундам (1 часу).

AccountId -> (строка)

Идентификатор учётной записи, где расположена эта метрика. Если вы выполняете эту операцию в учётной записи мониторинга, используйте это для указания учётной записи-источника, из которой нужно извлечь эту метрику.

MonitoredRequestCountMetric -> (структура тегированного объединения)

Эта структура определяет метрику, используемую в качестве значения «хороший запрос» или «плохой запрос» для SLO на основе запросов. Это значение, наблюдаемое для метрики, определенной в TotalRequestCountMetric, делится на число, найденное для MonitoredRequestCountMetric, чтобы определить процент успешных запросов, отслеживаемых этим SLO.

Примечание

Это структура помеченных объединений. Только один из следующих ключей верхнего уровня может быть установлен: GoodCountMetric, BadCountMetric.

GoodCountMetric -> (список)

Если вы хотите посчитать «хорошие запросы», чтобы определить процент успешных запросов для этого SLO на основе запросов, укажите метрику, которую следует использовать как «хорошие запросы» в этой структуре.

(структура)

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

Каждый MetricDataQuery в массиве MetricDataQueries указывает либо метрику для извлечения, либо математическое выражение метрики, которое нужно выполнить над извлечёнными метриками. Один массив MetricDataQueries может включать до 20 структур MetricDataQuery в массиве. 20 структур могут включать до 10 структур, содержащих параметр MetricStat для извлечения метрики, и до 10 структур, содержащих параметр Expression для выполнения математического выражения. Из этих структур Expression ровно одна должна иметь значение true для ReturnData. Результат этого выражения используется для SLO.

Дополнительную информацию о математических выражениях метрик см. в CloudWatchUse metric math.

В каждом объекте MetricDataQuery вы должны указать либо Expression, либо MetricStat, но не оба.

Id -> (строка)

Короткое имя, используемое для связи этого объекта с результатами в ответе. Это Id должно быть уникальным в массиве MetricDataQueries. Если вы выполняете математические выражения над этим набором данных, это имя представляет эти данные и может служить переменной в математическом выражении метрики. Допустимые символы — буквы, цифры и знак подчеркивания. Первый символ должен быть строчной буквой.

MetricStat -> (структура)

В одном объекте MetricDataQuery вы должны указать либо Expression, либо MetricStat, но не оба.

Metric -> (структура)

Namespace -> (строка)

Пространство имён метрики. Дополнительную информацию см. в разделах Namespaces.

MetricName -> (строка)

Имя метрики для использования.

Dimensions -> (список)

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

(структура)

Измерение — это пара «имя/значение», являющаяся частью идентификатора метрики. Поскольку измерения являются частью уникального идентификатора метрики, при добавлении уникальной пары «имя/значение» к одной из ваших метрик вы создаёте новую вариацию этой метрики. Например, многие метрики Amazon EC2 публикуют InstanceId в качестве имени измерения, а фактический идентификатор экземпляра — в качестве значения для этого измерения.

Вы можете назначить до 30 измерений метрике.

Name -> (строка)

Имя измерения. Имена измерений должны содержать только символы ASCII, должны включать как минимум один символ, отличный от пробела, и не могут начинаться с двоеточия (:). Символы управления ASCII не поддерживаются в качестве части имён измерений.

Value -> (строка)

Значение измерения. Значения измерений должны содержать только символы ASCII и должны включать как минимум один символ, отличный от пробела. Символы управления ASCII не поддерживаются в качестве части значений измерений.

Period -> (целое число)

Гранность в секундах, используемая для метрики. Для метрик с регулярным разрешением период может быть как минимум одной минутой (60 секунд) и должен быть кратным 60. Для метрик с высоким разрешением, которые собираются через интервалы менее одной минуты, период может быть 1, 5, 10, 30, 60 или любым кратным 60. Метрики с высоким разрешением — это те метрики, которые хранятся вызовом PutMetricData, который включает StorageResolution в 1 секунду.

Stat -> (строка)

Статистика для сравнения с пороговым значением. Это может быть любая статистика CloudWatch или расширенная статистика. Дополнительную информацию о статистике см. в CloudWatch statistics definitions.

Unit -> (строка)

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

Expression -> (строка)

Это поле может содержать математическое выражение метрики, которое нужно выполнить над другими метриками, которые вы извлекаете в этой структуре MetricDataQueries.

Математическое выражение может использовать Id других метрик или запросов для ссылки на эти метрики, а также может использовать Id других выражений для использования результата этих выражений. Дополнительную информацию о математических выражениях метрик см. в разделе Синтаксис и функции математических выражений метрик в Руководстве пользователя Amazon CloudWatch.

В каждом объекте MetricDataQuery вы должны указать либо Expression, либо MetricStat, но не оба.

Label -> (строка)

Понятное для человека имя метрики или выражения. Это особенно полезно, если это выражение, чтобы вы знали, что представляет значение. Если метрика или выражение отображаются в виджете панели мониторинга CloudWatch, отображается метка. Если Label опущено, CloudWatch генерирует значение по умолчанию.

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

ReturnData -> (булево)

Используйте это только в том случае, если вы используете математическое выражение метрики для SLO. Укажите true для ReturnData, чтобы использовать только один результат выражения в качестве сигнала тревоги. Для всех других метрик и выражений в той же операции CreateServiceLevelObjective укажите ReturnData как false.

Period -> (целое число)

Гранность в секундах возвращаемых точек данных для этой метрики. Для метрик с регулярным разрешением период может быть как минимум одной минутой (60 секунд) и должен быть кратным 60. Для метрик с высоким разрешением, которые собираются через интервалы менее одной минуты, период может быть 1, 5, 10, 30, 60 или любым кратным 60. Метрики с высоким разрешением — это те метрики, которые хранятся вызовом PutMetricData, который включает StorageResolution в 1 секунду.

Если параметр StartTime указывает метку времени, которая больше, чем 3 часа назад, вы должны указать период следующим образом, иначе точки данных в этом диапазоне времени не будут возвращены:

Время начала между 3 часами и 15 днями назад — используйте кратное 60 секундам (1 минута).
Время начала между 15 и 63 днями назад — используйте кратное 300 секундам (5 минут).
Время начала более 63 дней назад — используйте кратное 3600 секундам (1 час).

AccountId -> (строка)

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

BadCountMetric -> (список)

Если вы хотите подсчитать «плохие запросы», чтобы определить процент успешных запросов для этого SLO на основе запросов, укажите метрику, которую следует использовать для «плохих запросов» в этой структуре.

(структура)

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

Каждый MetricDataQuery в массиве MetricDataQueries указывает либо метрику для извлечения, либо математическое выражение метрики для выполнения над извлеченными метриками. Один массив MetricDataQueries может включать до 20 структур MetricDataQuery в массиве. 20 структур могут включать до 10 структур, содержащих параметр MetricStat для извлечения метрики, и до 10 структур, содержащих параметр Expression для выполнения математического выражения. Из этих структур Expression ровно одна должна иметь значение true для ReturnData . Результат этого выражения используется для SLO.

Дополнительную информацию о математических выражениях метрик см. в CloudWatchUse metric math.

В каждом объекте MetricDataQuery вы должны указать либо Expression, либо MetricStat, но не оба.

Id -> (строка)

Короткое имя, используемое для привязки этого объекта к результатам в ответе. Это Id должно быть уникальным в массиве MetricDataQueries. Если вы выполняете математические выражения над этим набором данных, это имя представляет эти данные и может служить переменной в математическом выражении метрики. Допустимые символы — буквы, цифры и знак подчеркивания. Первый символ должен быть строчной буквой.

MetricStat -> (структура)

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

В одном объекте MetricDataQuery вы должны указать либо Expression, либо MetricStat, но не оба.

Metric -> (структура)

Метрика, используемая в качестве индикатора уровня обслуживания, включая имя метрики, пространство имен и измерения.

Namespace -> (строка)

Пространство имен метрики. Дополнительную информацию см. в Namespaces.

MetricName -> (строка)

Имя метрики для использования.

Dimensions -> (список)

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

(структура)

Измерение — это пара имя/значение, которая является частью идентификатора метрики. Поскольку измерения являются частью уникального идентификатора метрики, каждый раз, когда вы добавляете уникальную пару имя/значение к одной из ваших метрик, вы создаете новую разновидность этой метрики. Например, многие метрики Amazon EC2 публикуют InstanceId в качестве имени измерения, а фактический идентификатор экземпляра — в качестве значения этого измерения.

Вы можете назначить до 30 измерений метрике.

Name -> (строка)

Имя измерения. Имена измерений должны содержать только символы ASCII, содержать по крайней мере один не пробельный символ и не начинаться с двоеточия (: ). Управляющие символы ASCII не поддерживаются в качестве части имен измерений.

Value -> (строка)

Значение измерения. Значения измерений должны содержать только символы ASCII и содержать по крайней мере один не пробельный символ. Управляющие символы ASCII не поддерживаются в качестве части значений измерений.

Period -> (целое число)

Грань, в секундах, используемая для метрики. Для метрик с обычным разрешением период может быть не короче одной минуты (60 секунд) и должен быть кратен 60. Для метрик с высоким разрешением, которые собираются с интервалами менее одной минуты, период может составлять 1, 5, 10, 30, 60 или любое кратное 60. Метрики с высоким разрешением — это те метрики, которые хранятся вызовом PutMetricData, который включает StorageResolution в 1 секунду.

Stat -> (строка)

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

Unit -> (строка)

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

Expression -> (строка)

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

Математическое выражение может использовать Id других метрик или запросов для ссылки на эти метрики и также может использовать Id других выражений для использования результата этих выражений. Дополнительную информацию о математических выражениях метрик см. в разделе «Синтаксис и функции математических выражений метрик» в руководстве пользователя Amazon CloudWatch.

В каждом объекте MetricDataQuery вы должны указать либо Expression, либо MetricStat, но не оба.

Label -> (строка)

Человекопонятное имя метрики или выражения. Это особенно полезно, если это выражение, чтобы вы понимали, что представляет значение. Если метрика или выражение отображаются в виджете панели мониторинга CloudWatch, отображается метка. Если Label опущено, CloudWatch генерирует значение по умолчанию.

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

ReturnData -> (булево)

Используйте это только в том случае, если вы используете математическое выражение метрики для SLO. Укажите true для ReturnData, чтобы получить только результат одного выражения для использования в качестве сигнала тревоги. Для всех других метрик и выражений в той же операции CreateServiceLevelObjective укажите ReturnData как false.

Period -> (целое число)

Грань, в секундах, возвращаемых точек данных для этой метрики. Для метрик с обычным разрешением период может быть не короче одной минуты (60 секунд) и должен быть кратен 60. Для метрик с высоким разрешением, которые собираются с интервалами менее одной минуты, период может составлять 1, 5, 10, 30, 60 или любое кратное 60. Метрики с высоким разрешением — это метрики, которые хранятся вызовом PutMetricData, который включает StorageResolution в 1 секунду.

Если параметр StartTime указывает отметку времени, превышающую 3 часа назад, необходимо указать период следующим образом, иначе точки данных в этом диапазоне времени не возвращаются:

Время начала между 3 часами и 15 днями назад — Используйте кратное 60 секундам (1 минута).
Время начала между 15 и 63 днями назад — Используйте кратное 300 секундам (5 минут).
Время начала более 63 дней назад — Используйте кратное 3600 секундам (1 час).

AccountId -> (строка)

DependencyConfig -> (структура)

Определяет зависимость, используя DependencyKeyAttributes и DependencyOperationName.

DependencyKeyAttributes -> (карта)

Это карта «строка-строка». Она может включать следующие поля.

Type обозначает тип объекта.
ResourceType указывает тип ресурса. Это поле используется только при значении поля Type равно Resource или AWS::Resource.
Name указывает имя объекта. Используется только при значении поля Type равно Service, RemoteService или AWS::Service.
Identifier определяет объекты ресурсов данного ресурса. Используется только при значении поля Type равно Resource или AWS::Resource.
Environment указывает расположение размещения этого объекта или к чему он принадлежит.

key -> (строка)

value -> (строка)

DependencyOperationName -> (строка)

Имя вызываемой операции в зависимости.

MetricThreshold -> (двойное число)

Это значение — порог, к которому сравниваются наблюдаемые значения метрики метрики SLI.

ComparisonOperator -> (строка)

Арифметическая операция, используемая при сравнении заданной метрики с порогом.

EvaluationType -> (строка)

Отображает, является ли это SLO на основе периода или на основе запроса.

Goal -> (структура)

Эта структура содержит атрибуты, определяющие цель SLO. Включает временной интервал для оценки и порог достижения.

Interval -> (структура помеченных союзов)

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

Если этот параметр опущен, используется интервал скользящего среднего 7 дней.

Примечание

Это структура помеченных союзов. Можно задать только один из следующих ключей верхнего уровня: RollingInterval, CalendarInterval.

RollingInterval -> (структура)

Если интервал — интервал скользящего среднего, эта структура содержит параметры интервала.

DurationUnit -> (строка)

Указывает единицу измерения интервала скользящего среднего.

Duration -> (целое число)

Указывает продолжительность каждого интервала скользящего среднего. Например, если Duration равен 7, а DurationUnit равен DAY, каждый интервал скользящего среднего равен семи дням.

CalendarInterval -> (структура)

Если интервал — календарный интервал, эта структура содержит параметры интервала.

StartTime -> (метка времени)

Дата и время начала первого интервала. Убедитесь, что время выбрано так, чтобы настроить интервалы нужным образом. Например, если вы хотите еженедельные интервалы, начинающиеся в понедельник в 6:00, убедитесь, что указано время понедельника в 6:00.

При использовании в API сырых HTTP-запросов оно форматируется как время эпохи в секундах. Например: 1698778057

Как только один календарный интервал заканчивается, автоматически начинается другой.

DurationUnit -> (строка)

Указывает единицу измерения календарного интервала.

Duration -> (целое число)

Указывает продолжительность каждого календарного интервала. Например, если Duration равен 1, а DurationUnit равен MONTH, каждый интервал составляет один месяц, согласованный с календарем.

AttainmentGoal -> (вещественное число)

Порог, определяющий, достигнута ли цель.

Если это SLO на основе периода, то цель достижения — процент хороших периодов, которые соответствуют требованиям порога, по отношению к общему количеству периодов в интервале. Например, цель достижения 99,9% означает, что в вашем интервале вы нацелены на 99,9% периодов, находящихся в здоровом состоянии.

Если это SLO на основе запросов, то цель достижения — процент запросов, которые должны быть успешными, чтобы достичь цели достижения.

Если этот параметр опущен, используется 99 для представления 99% как цели достижения.

WarningThreshold -> (вещественное число)

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

BurnRateConfigurations -> (список)

Каждый объект в этом массиве определяет длину окна обратной связи, используемого для расчета одного показателя скорости расхода для данного SLO. Скорость расхода измеряет, насколько быстро служба расходует бюджет ошибок по отношению к цели достижения SLO.

(структура)

Этот объект определяет длину окна обратной связи, используемого для расчета одного показателя скорости расхода для данного SLO. Скорость расхода измеряет, насколько быстро служба расходует бюджет ошибок по отношению к цели достижения SLO. Скорость расхода ровно 1 указывает, что цель SLO будет достигнута ровно.

Например, если вы укажете 60 как количество минут в окне обратной связи, скорость расхода рассчитывается следующим образом:

скорость расхода = скорость ошибок за окно обратной связи / (100% - процент цели достижения)

Дополнительную информацию о скорости расхода см. в разделе Расчет скоростей расхода.

LookBackWindowMinutes -> (целое число)

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

MetricSourceType -> (строка)

Отображает тип источника метрики SLI для данного SLO. Поддерживаемые типы:

Операция службы
Зависимость службы
Метрика CloudWatch