Configure Agent
codeguruprofiler_configure_agent | R Documentation |
Used by profiler agents to report their current state and to receive remote configuration updates¶
Description¶
Used by profiler agents to report their current state and to receive
remote configuration updates. For example, configure_agent
can be used
to tell an agent whether to profile or not and for how long to return
profiling data.
Usage¶
Arguments¶
fleetInstanceId
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
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 runningAGENT_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.
profilingGroupName
[required] The name of the profiling group for which the configured agent is collecting profiling data.
Value¶
A list with the following syntax:
list(
configuration = list(
agentParameters = list(
"string"
),
periodInSeconds = 123,
shouldProfile = TRUE|FALSE
)
)