Spec-Zone.ru › AWS CLI v2

[ aws . codeguruprofiler ]

configure-agent

Описание

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

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

Синтаксис

  configure-agent
[--fleet-instance-id <value>]
[--metadata <value>]
--profiling-group-name <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]

Параметры

--fleet-instance-id (строка)

Универсальный уникальный идентификатор (UUID) экземпляра профилирования. Например, если экземпляр профилирования — это виртуальная машина Amazon EC2, то это идентификатор экземпляра. Если это контейнер AWS Fargate, то это идентификатор задачи контейнера.

--metadata (словарь)

Метаданные, собранные об платформе вычислений, на которой работает агент. Он включает информацию о выборке и отчёте. Допустимые поля:

  • COMPUTE_PLATFORM — платформа вычислений, на которой работает агент
  • AGENT_ID — идентификатор экземпляра агента
  • AWS_REQUEST_ID — идентификатор запроса AWS вызова Lambda
  • EXECUTION_ENVIRONMENT — среда выполнения Lambda-функции
  • LAMBDA_FUNCTION_ARN — Amazon Resource Name (ARN), используемый для вызова Lambda-функции
  • LAMBDA_MEMORY_LIMIT_IN_MB — объём памяти, выделенный Lambda-функции
  • LAMBDA_REMAINING_TIME_IN_MILLISECONDS — время в миллисекундах до истечения времени ожидания выполнения Lambda-функции
  • LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS — время в миллисекундах между двумя вызовами Lambda-функции
  • LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS — время в миллисекундах для предыдущего вызова Lambda-функции

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

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

Сокращённый синтаксис:

  KeyName1=string,KeyName2=string

Where valid key names are:
  ComputePlatform
  AgentId
  AwsRequestId
  ExecutionEnvironment
  LambdaFunctionArn
  LambdaMemoryLimitInMB
  LambdaRemainingTimeInMilliseconds
  LambdaTimeGapBetweenInvokesInMilliseconds
  LambdaPreviousExecutionTimeInMilliseconds

Синтаксис JSON:

{"ComputePlatform"|"AgentId"|"AwsRequestId"|"ExecutionEnvironment"|"LambdaFunctionArn"|"LambdaMemoryLimitInMB"|"LambdaRemainingTimeInMilliseconds"|"LambdaTimeGapBetweenInvokesInMilliseconds"|"LambdaPreviousExecutionTimeInMilliseconds": "string"
  ...}

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

Название группы профилирования, для которой настроенный агент собирает данные профилирования.

--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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображающего двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для заданного cli-binary-format.

  • base64
  • raw-in-base64-out

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

Отключить вывод CLI pager.

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

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

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

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

Вывод

конфигурация -> (структура)

Объект ` AgentConfiguration https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AgentConfiguration.html`__ , который указывает, осуществляет ли агент профилирование и на какой период возвращать данные профилирования.

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

Параметры, используемые профилировщиком. Допустимые параметры:

  • MaxStackDepth — максимальная глубина стека кода, представленного в профиле. Например, если CodeGuru Profiler обнаруживает метод A, который вызывает метод B, который вызывает метод C, который вызывает метод D, то глубина равна 4. Если maxDepth установлен на 2, то профилировщик оценивает A и B.
  • MemoryUsageLimitPercent — процент памяти, используемый профилировщиком.
  • MinimumTimeForReportingInMilliseconds — минимальное время в миллисекундах между отправкой отчётов.
  • ReportingIntervalInMilliseconds — интервал отчёта в миллисекундах, используемый для отправки профилей.
  • SamplingIntervalInMilliseconds — интервал выборки в миллисекундах, используемый для профилирования выборок.

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

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

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

Сколько времени агент профилирования должен отправлять данные профилирования, используя ` ConfigureAgent https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html`__. Например, если это установлено в 300, агент профилирования вызывает ` ConfigureAgent https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html`__ каждые 5 минут, чтобы отправить данные, собранные во время этого периода.

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

Логическое значение, определяющее, собирает ли агент профилирования данные профилирования или нет. Установите в значение true, чтобы включить профилирование.

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

Spec-Zone.ru

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