Class: Aws::XRay::Types::SamplingRule

Inherits:

Struct

• Object
• Struct
• Aws::XRay::Types::SamplingRule

Defined in:

gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb

Overview

A sampling rule that services use to decide whether to instrument a request. Rule fields can match properties of the service, or properties of a request. The service can ignore rules that don't match its properties.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attributes ⇒ Hash<String,String>

  Matches attributes derived from the request.

• #fixed_rate ⇒ Float

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

• #host ⇒ String

  Matches the hostname from a request URL.

• #http_method ⇒ String

  Matches the HTTP method of a request.

• #priority ⇒ Integer

  The priority of the sampling rule.

• #reservoir_size ⇒ Integer

  A fixed number of matching requests to instrument per second, prior to applying the fixed rate.

• #resource_arn ⇒ String

  Matches the ARN of the Amazon Web Services resource on which the service runs.

• #rule_arn ⇒ String

  The ARN of the sampling rule.

• #rule_name ⇒ String

  The name of the sampling rule.

• #sampling_rate_boost ⇒ Types::SamplingRateBoost

  Specifies the multiplier applied to the base sampling rate.

• #service_name ⇒ String

  Matches the name that the service uses to identify itself in segments.

• #service_type ⇒ String

  Matches the origin that the service uses to identify its type in segments.

• #url_path ⇒ String

  Matches the path from a request URL.

• #version ⇒ Integer

  The version of the sampling rule format (1).

Instance Attribute Details

#attributes ⇒ Hash<String,String>

Matches attributes derived from the request.

Returns:

• (Hash<String,String>)

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

class SamplingRule < Struct.new(
  :rule_name,
  :rule_arn,
  :resource_arn,
  :priority,
  :fixed_rate,
  :reservoir_size,
  :service_name,
  :service_type,
  :host,
  :http_method,
  :url_path,
  :version,
  :attributes,
  :sampling_rate_boost)
  SENSITIVE = []
  include Aws::Structure
end

#fixed_rate ⇒ Float

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

Returns:

• (Float)

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

class SamplingRule < Struct.new(
  :rule_name,
  :rule_arn,
  :resource_arn,
  :priority,
  :fixed_rate,
  :reservoir_size,
  :service_name,
  :service_type,
  :host,
  :http_method,
  :url_path,
  :version,
  :attributes,
  :sampling_rate_boost)
  SENSITIVE = []
  include Aws::Structure
end

#host ⇒ String

Matches the hostname from a request URL.

Returns:

• (String)

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

class SamplingRule < Struct.new(
  :rule_name,
  :rule_arn,
  :resource_arn,
  :priority,
  :fixed_rate,
  :reservoir_size,
  :service_name,
  :service_type,
  :host,
  :http_method,
  :url_path,
  :version,
  :attributes,
  :sampling_rate_boost)
  SENSITIVE = []
  include Aws::Structure
end

#http_method ⇒ String

Matches the HTTP method of a request.

Returns:

• (String)

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

class SamplingRule < Struct.new(
  :rule_name,
  :rule_arn,
  :resource_arn,
  :priority,
  :fixed_rate,
  :reservoir_size,
  :service_name,
  :service_type,
  :host,
  :http_method,
  :url_path,
  :version,
  :attributes,
  :sampling_rate_boost)
  SENSITIVE = []
  include Aws::Structure
end

#priority ⇒ Integer

The priority of the sampling rule.

Returns:

• (Integer)

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

class SamplingRule < Struct.new(
  :rule_name,
  :rule_arn,
  :resource_arn,
  :priority,
  :fixed_rate,
  :reservoir_size,
  :service_name,
  :service_type,
  :host,
  :http_method,
  :url_path,
  :version,
  :attributes,
  :sampling_rate_boost)
  SENSITIVE = []
  include Aws::Structure
end

#reservoir_size ⇒ Integer

A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.

Returns:

• (Integer)

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

class SamplingRule < Struct.new(
  :rule_name,
  :rule_arn,
  :resource_arn,
  :priority,
  :fixed_rate,
  :reservoir_size,
  :service_name,
  :service_type,
  :host,
  :http_method,
  :url_path,
  :version,
  :attributes,
  :sampling_rate_boost)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arn ⇒ String

Matches the ARN of the Amazon Web Services resource on which the service runs.

Returns:

• (String)

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

class SamplingRule < Struct.new(
  :rule_name,
  :rule_arn,
  :resource_arn,
  :priority,
  :fixed_rate,
  :reservoir_size,
  :service_name,
  :service_type,
  :host,
  :http_method,
  :url_path,
  :version,
  :attributes,
  :sampling_rate_boost)
  SENSITIVE = []
  include Aws::Structure
end

#rule_arn ⇒ String

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

Returns:

• (String)

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

class SamplingRule < Struct.new(
  :rule_name,
  :rule_arn,
  :resource_arn,
  :priority,
  :fixed_rate,
  :reservoir_size,
  :service_name,
  :service_type,
  :host,
  :http_method,
  :url_path,
  :version,
  :attributes,
  :sampling_rate_boost)
  SENSITIVE = []
  include Aws::Structure
end

#rule_name ⇒ String

The name of the sampling rule. Specify a rule by either name or ARN, but not both.

Returns:

• (String)

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

class SamplingRule < Struct.new(
  :rule_name,
  :rule_arn,
  :resource_arn,
  :priority,
  :fixed_rate,
  :reservoir_size,
  :service_name,
  :service_type,
  :host,
  :http_method,
  :url_path,
  :version,
  :attributes,
  :sampling_rate_boost)
  SENSITIVE = []
  include Aws::Structure
end

#sampling_rate_boost ⇒ Types::SamplingRateBoost

Specifies the multiplier applied to the base sampling rate. This boost allows you to temporarily increase sampling without changing the rule's configuration.

Returns:

• (Types::SamplingRateBoost)

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

class SamplingRule < Struct.new(
  :rule_name,
  :rule_arn,
  :resource_arn,
  :priority,
  :fixed_rate,
  :reservoir_size,
  :service_name,
  :service_type,
  :host,
  :http_method,
  :url_path,
  :version,
  :attributes,
  :sampling_rate_boost)
  SENSITIVE = []
  include Aws::Structure
end

#service_name ⇒ String

Matches the name that the service uses to identify itself in segments.

Returns:

• (String)

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

class SamplingRule < Struct.new(
  :rule_name,
  :rule_arn,
  :resource_arn,
  :priority,
  :fixed_rate,
  :reservoir_size,
  :service_name,
  :service_type,
  :host,
  :http_method,
  :url_path,
  :version,
  :attributes,
  :sampling_rate_boost)
  SENSITIVE = []
  include Aws::Structure
end

#service_type ⇒ String

Matches the origin that the service uses to identify its type in segments.

Returns:

• (String)

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

class SamplingRule < Struct.new(
  :rule_name,
  :rule_arn,
  :resource_arn,
  :priority,
  :fixed_rate,
  :reservoir_size,
  :service_name,
  :service_type,
  :host,
  :http_method,
  :url_path,
  :version,
  :attributes,
  :sampling_rate_boost)
  SENSITIVE = []
  include Aws::Structure
end

#url_path ⇒ String

Matches the path from a request URL.

Returns:

• (String)

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

class SamplingRule < Struct.new(
  :rule_name,
  :rule_arn,
  :resource_arn,
  :priority,
  :fixed_rate,
  :reservoir_size,
  :service_name,
  :service_type,
  :host,
  :http_method,
  :url_path,
  :version,
  :attributes,
  :sampling_rate_boost)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ Integer

The version of the sampling rule format (1).

Returns:

• (Integer)

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

class SamplingRule < Struct.new(
  :rule_name,
  :rule_arn,
  :resource_arn,
  :priority,
  :fixed_rate,
  :reservoir_size,
  :service_name,
  :service_type,
  :host,
  :http_method,
  :url_path,
  :version,
  :attributes,
  :sampling_rate_boost)
  SENSITIVE = []
  include Aws::Structure
end