Struct AgentConfiguration

#[non_exhaustive]
pub struct AgentConfiguration {
    pub should_profile: bool,
    pub period_in_seconds: i32,
    pub agent_parameters: Option<HashMap<AgentParameterField, String>>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

should_profile: bool

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

period_in_seconds: i32

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

agent_parameters: Option<HashMap<AgentParameterField, 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.

Implementations

impl AgentConfiguration

pub fn should_profile(&self) -> bool

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

pub fn period_in_seconds(&self) -> i32

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

pub fn agent_parameters(&self) -> Option<&HashMap<AgentParameterField, 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.

impl AgentConfiguration

pub fn builder() -> AgentConfigurationBuilder

Creates a new builder-style object to manufacture AgentConfiguration.

Trait Implementations

impl Clone for AgentConfiguration

fn clone(&self) -> AgentConfiguration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AgentConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for AgentConfiguration

fn eq(&self, other: &AgentConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AgentConfiguration