Spec-Zone.ru › AWS CLI v2

[ aws . pi ]

get-resource-metrics

Описание

Получение метрик Performance Insights для набора источников данных за определенный период времени. Можно указать конкретные группы измерений и измерения, а также критерии фильтрации для каждой группы. Необходимо указать агрегационную функцию для каждой метрики.

Примечание

Каждый элемент ответа возвращает не более 500 байт. Для более крупных элементов, таких как SQL-запросы, возвращается только первые 500 байт.

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

Синтаксис

  get-resource-metrics
--service-type <value>
--identifier <value>
--metric-queries <value>
--start-time <value>
--end-time <value>
[--period-in-seconds <value>]
[--max-results <value>]
[--next-token <value>]
[--period-alignment <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]

Параметры

--service-type (строка)

Сервис Amazon Web Services, для которого Performance Insights возвращает метрики. Допустимые значения:

  • RDS
  • DOCDB

Возможные значения:

  • RDS
  • DOCDB

--identifier (строка)

Неизменяемый идентификатор источника данных, уникальный для региона Amazon Web Services. Performance Insights собирает метрики из этого источника данных. В консоли идентификатор отображается как ResourceID. При вызове DescribeDBInstances идентификатор возвращается как DbiResourceId.

Чтобы использовать экземпляр базы данных в качестве источника данных, укажите его значение DbiResourceId. Например, укажите db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

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

Массив одного или нескольких запросов для выполнения. Каждый запрос должен указать метрику Performance Insights и функцию агрегации, а также критерии фильтрации. Функцию агрегации необходимо добавить к метрике. Например, чтобы найти среднее значение для метрики db.load, необходимо использовать db.load.avg. Допустимые значения для функций агрегации включают .avg, .min, .max и .sum.

(структура)

Один запрос для обработки. Необходимо указать метрику для запроса и добавить функцию агрегации к метрике. Например, чтобы найти среднее значение для метрики db.load, необходимо использовать db.load.avg. Допустимые значения для функций агрегации включают .avg, .min, .max и .sum. Если не указаны другие параметры, Performance Insights возвращает все точки данных для указанной метрики. Дополнительно можно запросить агрегацию точек данных по группе измерений (GroupBy) и вернуть только те точки данных, которые соответствуют критериям (Filter).

Метрика -> (строка)

Имя метрики Performance Insights, подлежащей измерению.

Допустимые значения для Metric:

  • db.load.avg — масштабированное представление количества активных сессий для движка базы данных.
  • db.sampledload.avg — фактическое количество активных сессий для движка базы данных.
  • Метрики счетчиков, перечисленные в Performance Insights операционных счетчиках в Руководстве пользователя Amazon Aurora.
  • Метрики счетчиков, перечисленные в Performance Insights операционных счетчиках в Руководстве пользователя Amazon RDS.

Если количество активных сессий меньше внутреннего порога Performance Insights, db.load.avg и db.sampledload.avg имеют одинаковое значение. Если количество активных сессий превышает внутренний порог, Performance Insights отбирает активные сессии, причем db.load.avg показывает масштабированные значения, db.sampledload.avg показывает фактические значения, а db.sampledload.avg меньше, чем db.load.avg. Для большинства случаев использования можно запросить только db.load.avg.

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

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

Группа -> (строка)

Имя группы измерений. Допустимые значения:

  • db — имя базы данных, к которой подключен клиент. Разрешены следующие значения:
    • Aurora PostgreSQL
    • Amazon RDS PostgreSQL
    • Aurora MySQL
    • Amazon RDS MySQL
    • Amazon RDS MariaDB
    • Amazon DocumentDB
  • db.application — имя приложения, подключенного к базе данных. Разрешены следующие значения:
    • Aurora PostgreSQL
    • Amazon RDS PostgreSQL
    • Amazon DocumentDB
  • db.blocking_sql — SQL-запросы, блокирующие наибольшую нагрузку на базу данных.
  • db.blocking_session — сессии, блокирующие наибольшую нагрузку на базу данных.
  • db.blocking_object — ресурсы объектов, полученные другими сессиями, блокирующие наибольшую нагрузку на базу данных.
  • db.host — имя хоста подключенного клиента (все движки).
  • db.plans — планы выполнения запросов (только Aurora PostgreSQL).
  • db.query — запрос, который в данный момент выполняется (только Amazon DocumentDB).
  • db.query_tokenized — запрос дайджеста (только Amazon DocumentDB).
  • db.session_type — тип текущей сессии (только Aurora PostgreSQL и RDS PostgreSQL).
  • db.sql — текст SQL-запроса, который в данный момент выполняется (все движки, кроме Amazon DocumentDB).
  • db.sql_tokenized — дайджест SQL-запроса (все движки, кроме Amazon DocumentDB).
  • db.user — пользователь, вошедший в базу данных (все движки, кроме Amazon DocumentDB).
  • db.wait_event — событие, в ожидании которого находится бэкенд базы данных (все движки, кроме Amazon DocumentDB).
  • db.wait_event_type — тип события, в ожидании которого находится бэкенд базы данных (все движки, кроме Amazon DocumentDB).
  • db.wait_state — событие, в ожидании которого находится бэкенд базы данных (только Amazon DocumentDB).

Измерения -> (список)

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

Допустимые значения элементов в массиве Dimensions:

  • db.application.name — имя приложения, подключенного к базе данных. Допустимые значения:
    • Aurora PostgreSQL
    • Amazon RDS PostgreSQL
    • Amazon DocumentDB
  • db.blocking_sql.id — идентификатор каждого из SQL-запросов, блокирующих наибольшую нагрузку на базу данных.
  • db.blocking_sql.sql — текст SQL-запроса для каждого из SQL-запросов, блокирующих наибольшую нагрузку на базу данных.
  • db.blocking_session.id — идентификатор каждой из сессий, блокирующих наибольшую нагрузку на базу данных.
  • db.blocking_object.id — идентификатор каждого из ресурсов объектов, полученных другими сессиями, которые блокируют наибольшую нагрузку на базу данных.
  • db.blocking_object.type — тип объекта для каждого из ресурсов объектов, полученных другими сессиями, блокирующих наибольшую нагрузку на базу данных.
  • db.blocking_object.value — значение для каждого из ресурсов объектов, полученных другими сессиями, блокирующих наибольшую нагрузку на базу данных.
  • db.host.id — идентификатор хоста подключенного клиента (все движки).
  • db.host.name — имя хоста подключенного клиента (все движки).
  • db.name — имя базы данных, к которой подключен клиент. Допустимые значения:
    • Aurora PostgreSQL
    • Amazon RDS PostgreSQL
    • Aurora MySQL
    • Amazon RDS MySQL
    • Amazon RDS MariaDB
    • Amazon DocumentDB
  • db.query.id — идентификатор запроса, сгенерированный Performance Insights (только Amazon DocumentDB).
  • db.query.db_id — идентификатор запроса, сгенерированный базой данных (только Amazon DocumentDB).
  • db.query.statement — текст запроса, выполняемого (только Amazon DocumentDB).
  • db.query.tokenized_id
  • db.query.tokenized.id — идентификатор дайджеста запроса, сгенерированный Performance Insights (только Amazon DocumentDB).
  • db.query.tokenized.db_id — идентификатор дайджеста запроса, сгенерированный Performance Insights (только Amazon DocumentDB).
  • db.query.tokenized.statement — текст дайджеста запроса (только Amazon DocumentDB).
  • db.session_type.name — тип текущей сессии (только Amazon DocumentDB).
  • db.sql.id — хеш полного, нетокенезированного SQL-запроса, сгенерированный Performance Insights (все движки, кроме Amazon DocumentDB).
  • db.sql.db_id — либо идентификатор SQL-запроса, сгенерированный движком базы данных, либо значение, сгенерированное Performance Insights, которое начинается с pi- (все движки, кроме Amazon DocumentDB).
  • db.sql.statement — полный текст выполняемого SQL-запроса, как в SELECT * FROM employees (все движки, кроме Amazon DocumentDB)
  • db.sql.tokenized_id — хеш дайджеста SQL-запроса, сгенерированный Performance Insights (все движки, кроме Amazon DocumentDB). Измерение db.sql.tokenized_id извлекает значение измерения db.sql_tokenized.id. Amazon RDS возвращает db.sql.tokenized_id из группы измерений db.sql.
  • db.sql_tokenized.id — хеш дайджеста SQL-запроса, сгенерированный Performance Insights (все движки, кроме Amazon DocumentDB). В консоли db.sql_tokenized.id называется идентификатором поддержки, так как служба поддержки Amazon Web Services может использовать эти данные для устранения неполадок в базе данных.
  • db.sql_tokenized.db_id — либо собственный идентификатор базы данных, используемый для ссылки на SQL-запрос, либо синтетический идентификатор, например pi-2372568224, сгенерированный Performance Insights, если собственный идентификатор базы данных недоступен (все движки, кроме Amazon DocumentDB).
  • db.sql_tokenized.statement — текст дайджеста SQL-запроса, как в SELECT * FROM employees WHERE employee_id = ? (все движки, кроме Amazon DocumentDB)
  • db.user.id — идентификатор пользователя, вошедшего в базу данных (все движки, кроме Amazon DocumentDB).
  • db.user.name — имя пользователя, вошедшего в базу данных (все движки, кроме Amazon DocumentDB).
  • db.wait_event.name — событие, в ожидании которого находится бэкенд (все движки, кроме Amazon DocumentDB).
  • db.wait_event.type — тип события, в ожидании которого находится бэкенд (все движки, кроме Amazon DocumentDB).
  • db.wait_event_type.name — имя типа события, в ожидании которого находится бэкенд (все движки, кроме Amazon DocumentDB).
  • db.wait_state.name — событие, в ожидании которого находится бэкенд (только Amazon DocumentDB).

(строка)

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

Предел -> (целое число)

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

Фильтр -> (карта)

Один или несколько фильтров для применения в запросе. Ограничения:

  • Любое количество фильтров по одному и тому же измерению, как указано в параметре GroupBy.
  • Один фильтр для любого другого измерения в этой группе измерений.

Примечание

Фильтр db.sql.db_id недоступен для экземпляров баз данных RDS для SQL Server.

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

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

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

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

Metric=string,GroupBy={Group=string,Dimensions=[string,string],Limit=integer},Filter={KeyName1=string,KeyName2=string} ...

Синтаксис JSON:

[
  {
    "Metric": "string",
    "GroupBy": {
      "Group": "string",
      "Dimensions": ["string", ...],
      "Limit": integer
    },
    "Filter": {"string": "string"
      ...}
  }
  ...
]

--start-time (отметка времени)

Дата и время, определяющие начало диапазона запрошенного временного ряда. Вы не можете указать StartTime, которое предшествует 7 дням назад. По умолчанию Performance Insights сохраняет данные в течение 7 дней, но вы можете расширить этот диапазон до 2 лет. Указанное значение является включительно. Таким образом, команда возвращает точки данных, равные или большие, чем StartTime.

Значение для StartTime должно быть раньше значения для EndTime.

--end-time (отметка времени)

Дата и время, определяющие конец диапазона запрошенного временного ряда. Указанное значение является исключительно. Таким образом, команда возвращает точки данных, меньшие, чем (но не равные) EndTime.

Значение для EndTime должно быть позже значения для StartTime.

--period-in-seconds (целое число)

Гранularity (разрешение), в секундах, точек данных, возвращаемых из Performance Insights. Период может быть как от одной секунды, так и до одного дня (86400 секунд). Допустимые значения:

  • 1 (одна секунда)
  • 60 (одна минута)
  • 300 (пять минут)
  • 3600 (один час)
  • 86400 (сутки)

Если вы не указываете PeriodInSeconds, Performance Insights выберет значение за вас, с целью возвращения примерно 100-200 точек данных в ответе.

--max-results (целое число)

Максимальное количество элементов для возврата в ответе.

--next-token (строка)

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

--period-alignment (строка)

Возвращаемая отметка времени, которая является начальным или конечным временем временных периодов. Значение по умолчанию — END_TIME.

Возможные значения:

  • END_TIME
  • START_TIME

--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
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • вкл
  • выкл
  • авто

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

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Подробнее см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования, характерные для Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. Подробнее см. раздел "Использование кавычек со строками" в Руководстве пользователя AWS CLI.

Получение метрик ресурсов

В этом примере запрашиваются точки данных для группы измерений db.wait_event и для измерения db.wait_event.name в этой группе. В ответе соответствующие точки данных группируются по запрошенному измерению (db.wait_event.name).

Команда:

aws pi get-resource-metrics --service-type RDS --identifier db-LKCGOBK26374TPTDFXOIWVCPPM --start-time 1527026400 --end-time 1527080400 --period-in-seconds 300 --metric db.load.avg --metric-queries file://metric-queries.json

Аргументы для --metric-queries хранятся в файле JSON, metric-queries.json. Вот содержимое этого файла:

[
    {
        "Metric": "db.load.avg",
        "GroupBy": {
            "Group":"db.wait_event"
        }
    }
]

Вывод:

{
    "AlignedEndTime": 1.5270804E9,
    "AlignedStartTime": 1.5270264E9,
    "Identifier": "db-LKCGOBK26374TPTDFXOIWVCPPM",
    "MetricList": [
        {
            "Key": {
                "Metric": "db.load.avg"
            },
            "DataPoints": [
                {
                    "Timestamp": 1527026700.0,
                    "Value": 1.3533333333333333
                },
                {
                    "Timestamp": 1527027000.0,
                    "Value": 0.88
                },
                <...remaining output omitted...>
            ]
        },
        {
            "Key": {
                "Metric": "db.load.avg",
                "Dimensions": {
                    "db.wait_event.name": "wait/synch/mutex/innodb/aurora_lock_thread_slot_futex"
                }
            },
            "DataPoints": [
                {
                    "Timestamp": 1527026700.0,
                    "Value": 0.8566666666666667
                },
                {
                    "Timestamp": 1527027000.0,
                    "Value": 0.8633333333333333
                },
                <...remaining output omitted...>
            ],
        },
            <...remaining output omitted...>
    ]
}

Вывод

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

Начальное время возвращаемых метрик после выравнивания по границе разрешения (как указано в PeriodInSeconds). AlignedStartTime будет меньше или равно значению заданного пользователем StartTime.

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

Конечное время возвращаемых метрик после выравнивания по границе разрешения (как указано в PeriodInSeconds). AlignedEndTime будет больше или равно значению заданного пользователем Endtime.

Identifier -> (строка)

Неизменяемый идентификатор источника данных, уникальный для региона Amazon Web Services. Performance Insights собирает метрики из этого источника данных. В консоли идентификатор отображается как ResourceID. При вызове DescribeDBInstances идентификатор возвращается как DbiResourceId.

MetricList -> (список)

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

(структура)

Временной ряд точек данных, соответствующий измерению метрики Performance Insights.

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

Измерения, к которым относятся точки данных.

Metric -> (строка)

Имя метрики Performance Insights, подлежащей измерению.

Допустимые значения для Metric:

  • db.load.avg — Масштабируемое представление количества активных сеансов для движка базы данных.
  • db.sampledload.avg — Необработанное количество активных сеансов для движка базы данных.
  • Метрики счетчиков, перечисленные в счетчиках операционной системы Performance Insights в Руководстве пользователя Amazon Aurora.
  • Метрики счетчиков, перечисленные в счетчиках операционной системы Performance Insights в Руководстве пользователя Amazon RDS.

Если количество активных сеансов меньше внутреннего порога Performance Insights, db.load.avg и db.sampledload.avg имеют одинаковое значение. Если количество активных сеансов превышает внутренний порог, Performance Insights отбирает активные сеансы, при этом db.load.avg отображает отмасштабированные значения, db.sampledload.avg отображает необработанные значения, а db.sampledload.avg меньше, чем db.load.avg. В большинстве случаев достаточно запросить только db.load.avg.

Dimensions -> (карта)

Допустимые измерения для метрики.

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

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

DataPoints -> (список)

Массив пар "отметка времени - значение", представляющих измерения за определенный период.

(структура)

Отметка времени и единственное числовое значение, которые вместе представляют измерение в определенный момент времени.

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

Время в формате эпохи, связанное с конкретной Value.

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

Фактическое значение, связанное с конкретной Timestamp.

NextToken -> (строка)

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

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

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