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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-xray/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#fixed_rateFloat

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

Returns:

  • (Float)


2139
2140
2141
2142
2143
2144
2145
2146
2147
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 2139

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

#intervalInteger

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

Returns:

  • (Integer)


2139
2140
2141
2142
2143
2144
2145
2146
2147
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 2139

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

#reservoir_quotaInteger

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

Returns:

  • (Integer)


2139
2140
2141
2142
2143
2144
2145
2146
2147
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 2139

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

#reservoir_quota_ttlTime

When the reservoir quota expires.

Returns:

  • (Time)


2139
2140
2141
2142
2143
2144
2145
2146
2147
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 2139

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

#rule_nameString

The name of the sampling rule.

Returns:

  • (String)


2139
2140
2141
2142
2143
2144
2145
2146
2147
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 2139

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