Class: Aws::XRay::Types::SamplingRuleUpdate
- Inherits:
-
Struct
- Object
- Struct
- Aws::XRay::Types::SamplingRuleUpdate
- Defined in:
- gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb
Overview
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
-
#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 AWS resource on which the service runs.
-
#rule_arn ⇒ String
The ARN of the sampling rule.
-
#rule_name ⇒ String
The name of the sampling rule.
-
#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.
Instance Attribute Details
#attributes ⇒ Hash<String,String>
Matches attributes derived from the request.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 2555 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_rate ⇒ Float
The percentage of matching requests to instrument, after the reservoir is exhausted.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 2555 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 |
#host ⇒ String
Matches the hostname from a request URL.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 2555 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_method ⇒ String
Matches the HTTP method of a request.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 2555 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 |
#priority ⇒ Integer
The priority of the sampling rule.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 2555 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_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.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 2555 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_arn ⇒ String
Matches the ARN of the AWS resource on which the service runs.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 2555 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_arn ⇒ String
The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 2555 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_name ⇒ String
The name of the sampling rule. Specify a rule by either name or ARN, but not both.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 2555 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_name ⇒ String
Matches the name
that the service uses to identify itself in
segments.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 2555 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_type ⇒ String
Matches the origin
that the service uses to identify its type in
segments.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 2555 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_path ⇒ String
Matches the path from a request URL.
2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 |
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 2555 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 |