Class: Aws::CodeGuruProfiler::Types::AgentConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-codeguruprofiler/types.rb

Overview

The response of [ ‘ConfigureAgent` ][1] that specifies if an agent profiles or not and for how long to return profiling data.

[1]: docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#agent_parameters ⇒ Hash<String,String>

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.

Returns:

  • (Hash<String,String>) 


94
95
96
97
98
99
100
 
# File 'lib/aws-sdk-codeguruprofiler/types.rb', line 94

class AgentConfiguration < Struct.new(
  :agent_parameters,
  :period_in_seconds,
  :should_profile)
  SENSITIVE = []
  include Aws::Structure
end

#period_in_seconds ⇒ Integer

How long a profiling agent should send profiling data using [ ‘ConfigureAgent` ][1]. For example, if this is set to 300, the profiling agent calls [ `ConfigureAgent` ][1] every 5 minutes to submit the profiled data collected during that period.

[1]: docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html

Returns:

  • (Integer) 


94
95
96
97
98
99
100
 
# File 'lib/aws-sdk-codeguruprofiler/types.rb', line 94

class AgentConfiguration < Struct.new(
  :agent_parameters,
  :period_in_seconds,
  :should_profile)
  SENSITIVE = []
  include Aws::Structure
end

#should_profile ⇒ Boolean

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

Returns:

  • (Boolean) 


94
95
96
97
98
99
100
 
# File 'lib/aws-sdk-codeguruprofiler/types.rb', line 94

class AgentConfiguration < Struct.new(
  :agent_parameters,
  :period_in_seconds,
  :should_profile)
  SENSITIVE = []
  include Aws::Structure
end