[ aws . codeguruprofiler ]

configure-agent

Description

Used by profiler agents to report their current state and to receive remote configuration updates. For example, ConfigureAgent can be used to tell an agent whether to profile or not and for how long to return profiling data.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  configure-agent
[--fleet-instance-id <value>]
[--metadata <value>]
--profiling-group-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--fleet-instance-id (string)

A universally unique identifier (UUID) for a profiling instance. For example, if the profiling instance is an Amazon EC2 instance, it is the instance ID. If it is an AWS Fargate container, it is the container’s task ID.

--metadata (map)

Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are:

• COMPUTE_PLATFORM - The compute platform on which the agent is running

• AGENT_ID - The ID for an agent instance.

• AWS_REQUEST_ID - The AWS request ID of a Lambda invocation.

• EXECUTION_ENVIRONMENT - The execution environment a Lambda function is running on.

• LAMBDA_FUNCTION_ARN - The Amazon Resource Name (ARN) that is used to invoke a Lambda function.

• LAMBDA_MEMORY_LIMIT_IN_MB - The memory allocated to a Lambda function.

• LAMBDA_REMAINING_TIME_IN_MILLISECONDS - The time in milliseconds before execution of a Lambda function times out.

• LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS - The time in milliseconds between two invocations of a Lambda function.

• LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS - The time in milliseconds for the previous Lambda invocation.

key -> (string)

value -> (string)

Shorthand Syntax:

  KeyName1=string,KeyName2=string

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

JSON Syntax:

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

--profiling-group-name (string)

The name of the profiling group for which the configured agent is collecting profiling data.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

configuration -> (structure)

An ` AgentConfiguration https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AgentConfiguration.html`__ object that specifies if an agent profiles or not and for how long to return profiling data.

agentParameters -> (map)

Parameters used by the profiler. The valid parameters are:

• MaxStackDepth - The maximum depth of the stacks in the code that is represented in the profile. For example, if CodeGuru Profiler finds a method A , which calls method B , which calls method C , which calls method D , then the depth is 4. If the maxDepth is set to 2, then the profiler evaluates A and B .

• MemoryUsageLimitPercent - The percentage of memory that is used by the profiler.

• MinimumTimeForReportingInMilliseconds - The minimum time in milliseconds between sending reports.

• ReportingIntervalInMilliseconds - The reporting interval in milliseconds used to report profiles.

• SamplingIntervalInMilliseconds - The sampling interval in milliseconds that is used to profile samples.

key -> (string)

value -> (string)

periodInSeconds -> (integer)

How long a profiling agent should send profiling data using ` ConfigureAgent https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html`__ . For example, if this is set to 300, the profiling agent calls ` ConfigureAgent https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html`__ every 5 minutes to submit the profiled data collected during that period.

shouldProfile -> (boolean)

A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling.