Class: Aws::XRay::Types::SamplingTargetDocument

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

Overview

Temporary changes to a sampling rule configuration. To meet the global sampling target for a rule, X-Ray calculates a new reservoir for each service based on the recent sampling results of all services that called [GetSamplingTargets].

[1]: docs.aws.amazon.com/xray/latest/api/API_GetSamplingTargets.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#fixed_rate ⇒ Float

The percentage of matching requests to instrument, after the reservoir is exhausted.

Returns:

  • (Float) 


2978
2979
2980
2981
2982
2983
2984
2985
2986
 
# File 'lib/aws-sdk-xray/types.rb', line 2978

class SamplingTargetDocument < Struct.new(
  :rule_name,
  :fixed_rate,
  :reservoir_quota,
  :reservoir_quota_ttl,
  :interval)
  SENSITIVE = []
  include Aws::Structure
end

#interval ⇒ Integer

The number of seconds for the service to wait before getting sampling targets again.

Returns:

  • (Integer) 


2978
2979
2980
2981
2982
2983
2984
2985
2986
 
# File 'lib/aws-sdk-xray/types.rb', line 2978

class SamplingTargetDocument < Struct.new(
  :rule_name,
  :fixed_rate,
  :reservoir_quota,
  :reservoir_quota_ttl,
  :interval)
  SENSITIVE = []
  include Aws::Structure
end

#reservoir_quota ⇒ Integer

The number of requests per second that X-Ray allocated for this service.

Returns:

  • (Integer) 


2978
2979
2980
2981
2982
2983
2984
2985
2986
 
# File 'lib/aws-sdk-xray/types.rb', line 2978

class SamplingTargetDocument < Struct.new(
  :rule_name,
  :fixed_rate,
  :reservoir_quota,
  :reservoir_quota_ttl,
  :interval)
  SENSITIVE = []
  include Aws::Structure
end

#reservoir_quota_ttl ⇒ Time

When the reservoir quota expires.

Returns:

  • (Time) 


2978
2979
2980
2981
2982
2983
2984
2985
2986
 
# File 'lib/aws-sdk-xray/types.rb', line 2978

class SamplingTargetDocument < Struct.new(
  :rule_name,
  :fixed_rate,
  :reservoir_quota,
  :reservoir_quota_ttl,
  :interval)
  SENSITIVE = []
  include Aws::Structure
end

#rule_name ⇒ String

The name of the sampling rule.

Returns:

  • (String) 


2978
2979
2980
2981
2982
2983
2984
2985
2986
 
# File 'lib/aws-sdk-xray/types.rb', line 2978

class SamplingTargetDocument < Struct.new(
  :rule_name,
  :fixed_rate,
  :reservoir_quota,
  :reservoir_quota_ttl,
  :interval)
  SENSITIVE = []
  include Aws::Structure
end