Spec-Zone.ru › AWS CLI v2

[ aws . xray ]

get-service-graph

Описание

Извлекает документ, описывающий службы, обрабатывающие входящие запросы, и дочерние службы, к которым они обращаются в результате. Корневые службы обрабатывают входящие запросы и обращаются к дочерним службам. Корневые службы — это приложения, использующие Amazon Web Services X-Ray SDK. Дочерние службы могут быть другими приложениями, ресурсами Amazon Web Services, HTTP-веб-API или базами данных SQL.

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

get-service-graph — это постраничная операция. Для получения всего набора результатов могут быть выпущены несколько API-запросов. Вы можете отключить постраничную обработку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой аргумент --query должен извлечь данные из результатов следующих выражений запроса: Services

Синтаксис

  get-service-graph
--start-time <value>
--end-time <value>
[--group-name <value>]
[--group-arn <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 (отметка времени)

Конец временного интервала для построения графика.

--group-name (строка)

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

--group-arn (строка)

Amazon Resource Name (ARN) группы, на основе которой необходимо построить график.

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, указанному в --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в формате JSON. Невозможно передавать произвольные двоичные данные с помощью значения, предоставленного в формате JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

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

Маркер для указания начала постраничной обработки. Это NextToken из ранее усеченного ответа.

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

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

Общее количество элементов, которые необходимо вернуть в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

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

--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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Примеры

Примечание

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

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

Получение графика службы

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

aws xray get-service-graph \
    --start-time 1568835392.0
    --end-time 1568835446.0

Вывод:

{
    "Services": [
        {
            "ReferenceId": 0,
            "Name": "Scorekeep",
            "Names": [
                "Scorekeep"
            ],
            "Root": true,
            "Type": "AWS::ElasticBeanstalk::Environment",
            "State": "active",
            "StartTime": 1568835392.0,
            "EndTime": 1568835446.0,
            "Edges": [
                {
                    "ReferenceId": 1,
                    "StartTime": 1568835392.0,
                    "EndTime": 1568835446.0,
                    "SummaryStatistics": {
                        "OkCount": 14,
                        "ErrorStatistics": {
                            "ThrottleCount": 0,
                            "OtherCount": 0,
                            "TotalCount": 0
                        },
                        "FaultStatistics": {
                            "OtherCount": 0,
                            "TotalCount": 0
                        },
                        "TotalCount": 14,
                        "TotalResponseTime": 0.13
                    },
                    "ResponseTimeHistogram": [
                        {
                            "Value": 0.008,
                            "Count": 1
                        },
                        {
                            "Value": 0.005,
                            "Count": 7
                        },
                        {
                            "Value": 0.009,
                            "Count": 1
                        },
                        {
                            "Value": 0.021,
                            "Count": 1
                        },
                        {
                            "Value": 0.038,
                            "Count": 1
                        },
                        {
                            "Value": 0.007,
                            "Count": 1
                        },
                        {
                            "Value": 0.006,
                            "Count": 2
                        }
                    ],
                    "Aliases": []
                },

                ... TRUNCATED FOR BREVITY ...

            ]
        }
    ],
    "StartTime": 1568835392.0,
    "EndTime": 1568835446.0,
    "ContainsOldGroupVersions": false
}

Дополнительную информацию см. в разделе «Использование API AWS X-Ray с AWS CLI» в Руководстве разработчика AWS X-Ray.

Вывод

Время начала -> (отметка времени)

Начало временного интервала, для которого была сгенерирована диаграмма.

Время окончания -> (отметка времени)

Конец временного интервала, для которого была сгенерирована диаграмма.

Услуги -> (список)

Услуги, которые обработали отслеженный запрос в течение указанного временного интервала.

(структура)

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

Идентификатор ссылки -> (целое число)

Идентификатор службы. Уникален в рамках карты служб.

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

Каноническое имя службы.

Имена -> (список)

Список имен службы, включая каноническое имя.

(строка)

Корневой -> (логическое значение)

Указывает, что служба была первой службой, обработшей запрос.

Идентификатор учетной записи -> (строка)

Идентификатор учетной записи Amazon Web Services, в которой работает служба.

Тип -> (строка)

Тип службы.

  • Ресурс Amazon Web Services - Тип ресурса Amazon Web Services. Например, AWS::EC2::Instance для приложения, работающего в Amazon EC2, или AWS::DynamoDB::Table для таблицы Amazon DynamoDB, которую использовало приложение.
  • Служба Amazon Web Services - Тип службы Amazon Web Services. Например, AWS::DynamoDB для вызовов вниз по потоку к Amazon DynamoDB, не нацеленных на конкретную таблицу.
  • client - Представляет клиентов, которые отправили запросы в корневую службу.
  • remote - Служба вниз по потоку неопределенного типа.

Состояние -> (строка)

Состояние службы.

Время начала -> (отметка времени)

Время начала первого сегмента, сгенерированного службой.

Время окончания -> (отметка времени)

Время окончания последнего сегмента, сгенерированного службой.

Связи -> (список)

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

(структура)

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

Идентификатор ссылки -> (целое число)

Идентификатор связи. Уникален в рамках карты служб.

Время начала -> (отметка времени)

Время начала первого сегмента на связи.

Время окончания -> (отметка времени)

Время окончания последнего сегмента на связи.

Статистические данные резюме -> (структура)

Статистические данные ответа для сегментов на связи.

Количество успешных ответов -> (длинное целое число)

Количество запросов, завершенных со статусом кода успешного ответа 2xx.

Статистика ошибок -> (структура)

Информация о запросах, завершенных с кодом ошибки клиента 4xx.

Количество запросов, завершенных с кодом 429 (ограничение) -> (длинное целое число)

Количество запросов, завершенных с кодом ошибки 429 (ограничение).

Другое количество -> (длинное целое число)

Количество запросов, завершенных с неотслеженными кодами ошибок клиента 4xx.

Общее количество -> (длинное целое число)

Общее количество запросов, завершенных с кодом ошибки клиента 4xx.

Статистика ошибок -> (структура)

Информация о запросах, завершенных с кодом ошибки сервера 5xx.

Другое количество -> (длинное целое число)

Количество запросов, завершенных с неотслеженными кодами ошибок сервера 5xx.

Общее количество -> (длинное целое число)

Общее количество запросов, завершенных с кодом ошибки сервера 5xx.

Общее количество -> (длинное целое число)

Общее количество завершенных запросов.

Общее время ответа -> (двойное значение)

Суммарное время ответа завершенных запросов.

Гистограмма времени ответа -> (список)

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

(структура)

Элемент гистограммы для статистики. Гистограмма отображает диапазон наблюдаемых значений по оси X и частоту каждого значения по оси Y.

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

Значение элемента.

Количество -> (целое число)

Частота элемента.

Псевдонимы -> (список)

Псевдонимы связи.

(структура)

Псевдоним связи.

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

Каноническое имя псевдонима.

Имена -> (список)

Список имен псевдонима, включая каноническое имя.

(строка)

Тип -> (строка)

Тип псевдонима.

Тип связи -> (строка)

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

Гистограмма возраста события при получении -> (список)

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

(структура)

Элемент гистограммы для статистики. Гистограмма отображает диапазон наблюдаемых значений по оси X и частоту каждого значения по оси Y.

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

Значение элемента.

Количество -> (целое число)

Частота элемента.

Статистические данные резюме -> (структура)

Сводные статистические данные для службы.

Количество успешных ответов -> (длинное целое число)

Количество запросов, завершенных со статусом кода успешного ответа 2xx.

Статистика ошибок -> (структура)

Информация о запросах, завершенных с кодом ошибки клиента 4xx.

Количество запросов, завершенных с кодом 429 (ограничение) -> (длинное целое число)

Количество запросов, завершенных с кодом ошибки 429 (ограничение).

Другое количество -> (длинное целое число)

Количество запросов, завершенных с неотслеженными кодами ошибок клиента 4xx.

Общее количество -> (длинное целое число)

Общее количество запросов, завершенных с кодом ошибки клиента 4xx.

Статистика ошибок -> (структура)

Информация о запросах, завершенных с кодом ошибки сервера 5xx.

Другое количество -> (длинное целое число)

Количество запросов, завершенных с неотслеженными кодами ошибок сервера 5xx.

Общее количество -> (длинное целое число)

Общее количество запросов, завершенных с кодом ошибки сервера 5xx.

Общее количество -> (длинное целое число)

Общее количество завершенных запросов.

Общее время ответа -> (двойное значение)

Суммарное время ответа завершенных запросов.

Гистограмма продолжительности -> (список)

Гистограмма, отображающая распределение продолжительности работы службы.

(структура)

Элемент гистограммы для статистики. Гистограмма отображает диапазон наблюдаемых значений по оси X и частоту каждого значения по оси Y.

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

Значение элемента.

Количество -> (целое число)

Частота элемента.

Гистограмма времени ответа -> (список)

Гистограмма, отображающая распределение времени ответа службы.

(структура)

Элемент гистограммы для статистики. Гистограмма отображает диапазон наблюдаемых значений по оси X и частоту каждого значения по оси Y.

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

Значение элемента.

Количество -> (целое число)

Частота элемента.

Содержит старые версии групп -> (логическое значение)

Флаг, указывающий, была ли выражение фильтра группы постоянным, или возвращаемая диаграмма служб может показывать трассировки из более старой версии выражения фильтра группы.

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

Маркер пагинации.

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

Spec-Zone.ru

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