Class: Aws::XRay::Types::SamplingRateBoost

Inherits:

Struct

• Object
• Struct
• Aws::XRay::Types::SamplingRateBoost

Includes:

Structure

Defined in:

lib/aws-sdk-xray/types.rb

Overview

Enable temporary sampling rate increases when you detect anomalies to improve visibility.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cooldown_window_minutes ⇒ Integer

  Sets the time window (in minutes) in which only one sampling rate boost can be triggered.

• #max_rate ⇒ Float

  Defines max temporary sampling rate to apply when a boost is triggered.

Instance Attribute Details

#cooldown_window_minutes ⇒ Integer

Sets the time window (in minutes) in which only one sampling rate boost can be triggered. After a boost occurs, no further boosts are allowed until the next window.

Returns:

• (Integer)

# File 'lib/aws-sdk-xray/types.rb', line 2759

class SamplingRateBoost < Struct.new(
  :max_rate,
  :cooldown_window_minutes)
  SENSITIVE = []
  include Aws::Structure
end

#max_rate ⇒ Float

Defines max temporary sampling rate to apply when a boost is triggered. Calculated boost rate by X-Ray will be less than or equal to this max rate.

Returns:

• (Float)

# File 'lib/aws-sdk-xray/types.rb', line 2759

class SamplingRateBoost < Struct.new(
  :max_rate,
  :cooldown_window_minutes)
  SENSITIVE = []
  include Aws::Structure
end