Class: Aws::XRay::Types::SamplingRuleUpdate

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

Overview

Note:

When making an API call, you may pass SamplingRuleUpdate data as a hash:

{
  rule_name: "RuleName",
  rule_arn: "String",
  resource_arn: "ResourceARN",
  priority: 1,
  fixed_rate: 1.0,
  reservoir_size: 1,
  host: "Host",
  service_name: "ServiceName",
  service_type: "ServiceType",
  http_method: "HTTPMethod",
  url_path: "URLPath",
  attributes: {
    "AttributeKey" => "AttributeValue",
  },
}

A document specifying changes to a sampling rule's configuration.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attributesHash<String,String>

Matches attributes derived from the request.

Returns:

  • (Hash<String,String>)


1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1773

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

#fixed_rateFloat

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

Returns:

  • (Float)


1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1773

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

#hostString

Matches the hostname from a request URL.

Returns:

  • (String)


1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1773

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

#http_methodString

Matches the HTTP method of a request.

Returns:

  • (String)


1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1773

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

#priorityInteger

The priority of the sampling rule.

Returns:

  • (Integer)


1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1773

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

#reservoir_sizeInteger

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)


1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1773

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

#resource_arnString

Matches the ARN of the AWS resource on which the service runs.

Returns:

  • (String)


1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1773

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

#rule_arnString

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

Returns:

  • (String)


1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1773

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

#rule_nameString

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

Returns:

  • (String)


1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1773

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

#service_nameString

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

Returns:

  • (String)


1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1773

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

#service_typeString

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

Returns:

  • (String)


1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1773

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

#url_pathString

Matches the path from a request URL.

Returns:

  • (String)


1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1773

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