Spec-Zone.ru › AWS CLI v2

[ aws . xray ]

put-trace-segments

Описание

Загружает документы сегментов в Amazon Web Services X-Ray. Документ сегмента может быть завершенным сегментом, сегментом в процессе обработки или массивом подсегментов.

Сегменты должны включать следующие поля. Полную схему документа сегмента см. в разделе Документы сегментов Amazon Web Services X-Ray в руководстве разработчика Amazon Web Services X-Ray.

Обязательные поля документа сегмента
  • name - Название сервиса, который обработала запрос.
  • id - 64-битное идентификатор сегмента, уникальное среди сегментов в одном трассировке, в 16 шестнадцатеричных цифрах.
  • trace_id - Уникальный идентификатор, который связывает все сегменты и подсегменты, исходящие из одного клиентского запроса.
  • start_time - Время создания сегмента или подсегмента, в формате с плавающей точкой секунд в эпохе времени, с точностью до миллисекунд. Например, 1480615200.010 или 1.480615200010E9.
  • end_time - Время закрытия сегмента или подсегмента. Например, 1480615200.090 или 1.480615200090E9. Укажите либо end_time, либо in_progress.
  • in_progress - Установите значение true вместо указания end_time, чтобы записать, что сегмент был начат, но не завершен. Отправьте сегмент в процессе обработки, когда ваше приложение получает запрос, который будет долго обрабатываться, чтобы отследить, что запрос был получен. Когда ответ отправлен, отправьте завершенный сегмент, чтобы перезаписать сегмент в процессе обработки.

trace_id состоит из трех чисел, разделенных дефисами. Например, 1-58406520-a006649127e371903a2de979. Для идентификаторов трассировки, созданных X-Ray SDK или службами Amazon Web Services, интегрированными с X-Ray, идентификатор трассировки включает:

Формат идентификатора трассировки
  • Номер версии, например, 1.
  • Время исходного запроса в временной шкале Unix, в 8 шестнадцатеричных цифрах. Например, 10:00 утра 2 декабря 2016 года по тихоокеанскому времени в эпохе времени - это 1480615200 секунд, или 58406520 в шестнадцатеричном формате.
  • 96-битный идентификатор трассировки, глобально уникальный, в 24 шестнадцатеричных цифрах.

Примечание

Идентификаторы трассировки, созданные с помощью OpenTelemetry, имеют другой формат, основанный на спецификации W3C Trace Context. Идентификатор трассировки W3C должен быть отформатирован в формате идентификатора трассировки X-Ray при отправке в X-Ray. Например, идентификатор трассировки W3C 4efaaf4d1e8720b39541901950019ee5 должен быть отформатирован как 1-4efaaf4d-1e8720b39541901950019ee5 при отправке в X-Ray. Хотя идентификаторы трассировки X-Ray включают отметку времени исходного запроса в временной шкале Unix, это не требуется и не проверяется.

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

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

  put-trace-segments
--trace-segment-documents <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]

Параметры

--trace-segment-documents (список)

Строка, содержащая JSON-документ, определяющий один или несколько сегментов или подсегментов.

(строка)

Синтаксис:

"string" "string" ...

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

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. При отсутствии значения или при значении input выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, при предоставлении yaml-input он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверит входные данные команды и вернет пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (булево)

Включить отладку.

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

Загрузка сегмента

Следующий пример put-trace-segments загружает документы сегментов в AWS X-Ray. Документ сегмента потребляется в виде списка JSON-документов сегментов.

aws xray put-trace-segments \
    --trace-segment-documents "{\"id\":\"20312a0e2b8809f4\",\"name\":\"DynamoDB\",\"trace_id\":\"1-5832862d-a43aafded3334a971fe312db\",\"start_time\":1.479706157195E9,\"end_time\":1.479706157202E9,\"parent_id\":\"79736b962fe3239e\",\"http\":{\"response\":{\"content_length\":60,\"status\":200}},\"inferred\":true,\"aws\":{\"consistent_read\":false,\"table_name\":\"scorekeep-session-xray\",\"operation\":\"GetItem\",\"request_id\":\"SCAU23OM6M8FO38UASGC7785ARVV4KQNSO5AEMVJF66Q9ASUAAJG\",\"resource_names\":[\"scorekeep-session-xray\"]},\"origin\":\"AWS::DynamoDB::Table\"}"

Вывод:

{
    "UnprocessedTraceSegments": []
}

Дополнительную информацию см. в разделе Отправка данных трассировки в AWS X-Ray в руководстве разработчика AWS X-Ray.

Вывод

UnprocessedTraceSegments -> (список)

Сегменты, обработка которых завершилась с ошибкой.

(структура)

Информация о сегменте, обработка которого завершилась с ошибкой.

Id -> (строка)

Идентификатор сегмента.

ErrorCode -> (строка)

Ошибка, которая привела к сбою обработки.

Message -> (строка)

Сообщение об ошибке.

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

Spec-Zone.ru

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