get-trace-summaries
Описание
Возвращает идентификаторы и аннотации для трассировок, доступных в указанный временной интервал, используя необязательный фильтр. Чтобы получить полные трассировки, передайте идентификаторы трассировок в BatchGetTraces .
Выражение фильтра может нацеливаться на запросы с трассировкой, которые попадают на конкретные узлы или грани сервисов, имеют ошибки или поступают от известного пользователя. Например, следующее выражение фильтра нацеливается на трассировки, которые проходят через api.example.com :
service("api.example.com")Это выражение фильтра находит трассировки, имеющие аннотацию с именем account и значением 12345 :
annotation.account = "12345"Полный список индексированных полей и ключевых слов, которые можно использовать в выражениях фильтра, см. в разделе Использование выражений фильтра в руководстве разработчика Amazon Web Services X-Ray .
См. также: Документация API AWS
get-trace-summaries — это постраничная операция. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе на запрос с постраничностью аргумент --query должен извлекать данные из результатов следующих выражений запроса: TraceSummaries
Синтаксис
get-trace-summaries
--start-time <value>
--end-time <value>
[--time-range-type <value>]
[--sampling | --no-sampling]
[--sampling-strategy <value>]
[--filter-expression <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--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]
Параметры
--start-time (метка времени)
--end-time (метка времени)
--time-range-type (строка)
Фильтровать трассировки по идентификатору трассировки (время начала трассировки), событию (время обновления трассировки) или сервису (время окончания сегмента трассировки).
Возможные значения:
TraceIdEventService
--sampling | --no-sampling (логическое значение)
true, чтобы получить сводки только для подмножества доступных трассировок.--sampling-strategy (структура)
Параметр для указания, следует ли включить выборку по сводкам трассировок. Входные параметры — Имя и Значение.
Имя -> (строка)
Значение -> (число)
Сокращенный синтаксис:
Name=string,Value=double
Синтаксис JSON:
{
"Name": "PartialScan"|"FixedRate",
"Value": double
}
--filter-expression (строка)
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения, используя значение, предоставленное в JSON, так как строка будет интерпретироваться буквально. Это может не быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Маркер для указания точки начала постраничной обработки. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface .
--max-items (целое число)
Общее количество элементов, которые должны быть возвращены в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface .
--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 .
Получение сводки трассировки
Следующий get-trace-summaries пример получает идентификаторы и метаданные трассировок в заданном временном интервале.
aws xray get-trace-summaries \
--start-time 1568835392.0 \
--end-time 1568835446.0
Вывод:
[
"http://scorekeep-env-1.123456789.us-east-2.elasticbeanstalk.com/api/move/VSAE93HF/GSSD2NTB/DP0PCC09",
"http://scorekeep-env-1.123456789.us-east-2.elasticbeanstalk.com/api/move/GCQ2B35P/FREELDFT/4LRE643M",
"http://scorekeep-env-1.123456789.us-east-2.elasticbeanstalk.com/api/game/VSAE93HF/GSSD2NTB/starttime/1568835513",
"http://scorekeep-env-1.123456789.us-east-2.elasticbeanstalk.com/api/move/4MQNA5NN/L99KK2RF/null"
]
Дополнительную информацию см. в разделе Использование API AWS X-Ray с AWS CLI в Руководстве разработчика AWS X-Ray.
Вывод
TraceSummaries -> (список)
Идентификаторы и аннотации трасс, которые были найдены в указанном временном интервале.
(структура)
Метаданные, сгенерированные из документов сегментов в трассе.
Id -> (строка)
StartTime -> (метка времени)
Duration -> (двойное)
ResponseTime -> (двойное)
HasFault -> (булево)
HasError -> (булево)
HasThrottle -> (булево)
IsPartial -> (булево)
Http -> (структура)
Информация об HTTP-запросе, обработанном в рамках трассы.
HttpURL -> (строка)
HttpStatus -> (целое число)
HttpMethod -> (строка)
UserAgent -> (строка)
ClientIp -> (строка)
Annotations -> (карта)
Аннотации из документов сегментов трассы.
key -> (строка)
value -> (список)
(структура)
Информация об аннотации сегмента.
AnnotationValue -> (структура)
Значения аннотации.
NumberValue -> (двойное)
BooleanValue -> (булево)
StringValue -> (строка)
ServiceIds -> (список)
Услуги, к которым относится аннотация.
(структура)
Name -> (строка)
Names -> (список)
AccountId -> (строка)
Type -> (строка)
Users -> (список)
Пользователи из документов сегментов трассы.
(структура)
Информация о пользователе, записанном в документах сегментов.
UserName -> (строка)
ServiceIds -> (список)
Услуги, к которым обратился запрос пользователя.
(структура)
Name -> (строка)
Names -> (список)
AccountId -> (строка)
Type -> (строка)
ServiceIds -> (список)
Идентификаторы служб из документов сегментов трассы.
(структура)
Name -> (строка)
Names -> (список)
AccountId -> (строка)
Type -> (строка)
ResourceARNs -> (список)
Список ARN ресурсов для любого ресурса, соответствующего сегментам трассы.
(структура)
Список ARN ресурсов, соответствующих сегментам в трассе.
ARN -> (строка)
InstanceIds -> (список)
Список идентификаторов экземпляров EC2 для любого экземпляра, соответствующего сегментам трассы.
(структура)
Список идентификаторов экземпляров EC2, соответствующих сегментам в трассе.
Id -> (строка)
AvailabilityZones -> (список)
Список зон доступности для любой зоны, соответствующей сегментам трассы.
(структура)
Список зон доступности, соответствующих сегментам в трассе.
Name -> (строка)
EntryPoint -> (структура)
Корень трассы.
Name -> (строка)
Names -> (список)
AccountId -> (строка)
Type -> (строка)
FaultRootCauses -> (список)
Коллекция структур FaultRootCause, соответствующих сегментам трассы.
(структура)
Информация о первопричине ошибки сводки трассы.
Services -> (список)
Список соответствующих служб. Служба идентифицирует сегмент и содержит имя, идентификатор учетной записи, тип и флаг вывода.
(структура)
Коллекция полей, идентифицирующих службы в ошибке сводки трассы.
Name -> (строка)
Names -> (список)
Коллекция связанных имен служб.
(строка)
Type -> (строка)
AccountId -> (строка)
EntityPath -> (список)
Путь к сущностям первопричины, найденным в службе.
(структура)
Коллекция сегментов и соответствующих подсегментов, связанных с ошибкой сводки трассы.
Name -> (строка)
Exceptions -> (список)
Типы и сообщения исключений.
(структура)
Исключение, связанное с первопричиной.
Name -> (строка)
Message -> (строка)
Remote -> (булево)
Inferred -> (булево)
ClientImpacting -> (булево)
ErrorRootCauses -> (список)
Коллекция структур ErrorRootCause, соответствующих сегментам трассы.
(структура)
Первопричина ошибки сводки трассы.
Services -> (список)
Список служб, соответствующих ошибке. Служба идентифицирует сегмент и содержит имя, идентификатор учетной записи, тип и флаг вывода.
(структура)
Коллекция полей, идентифицирующих службы в ошибке сводки трассы.
Name -> (строка)
Names -> (список)
Коллекция связанных имен служб.
(строка)
Type -> (строка)
AccountId -> (строка)
EntityPath -> (список)
Путь к сущностям первопричины, найденным в службе.
(структура)
Коллекция сегментов и соответствующих подсегментов, связанных с ошибкой сводки трассы.
Name -> (строка)
Exceptions -> (список)
Типы и сообщения исключений.
(структура)
Исключение, связанное с первопричиной.
Name -> (строка)
Message -> (строка)
Remote -> (булево)
Inferred -> (булево)
ClientImpacting -> (булево)
ResponseTimeRootCauses -> (список)
Коллекция структур ResponseTimeRootCause, соответствующих сегментам трассы.
(структура)
Информация о первопричине предупреждения о времени ответа.
Services -> (список)
Список соответствующих служб. Служба идентифицирует сегмент и содержит имя, идентификатор учетной записи, тип и флаг вывода.
(структура)
Коллекция полей, идентифицирующих службу в предупреждении о времени ответа.
Name -> (строка)
Names -> (список)
Коллекция связанных имен служб.
(строка)
Type -> (строка)
AccountId -> (строка)
EntityPath -> (список)
Путь к сущностям первопричины, найденным в службе.
(структура)
Коллекция сегментов и соответствующих подсегментов, связанных с предупреждением о времени ответа.
Name -> (строка)
Coverage -> (двойное)
Remote -> (булево)
Inferred -> (булево)
ClientImpacting -> (булево)
Revision -> (целое число)
MatchedEventTime -> (метка времени)
ApproximateTime -> (метка времени)
TracesProcessedCount -> (длинное целое)
NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.