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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-xray/types.rb

Overview

Note:

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

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

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

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 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.

• #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 'lib/aws-sdk-xray/types.rb', line 1453

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)
  include Aws::Structure
end

#fixed_rate ⇒ Float

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

Returns:

• (Float)

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

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)
  include Aws::Structure
end

#host ⇒ String

Matches the hostname from a request URL.

Returns:

• (String)

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

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)
  include Aws::Structure
end

#http_method ⇒ String

Matches the HTTP method of a request.

Returns:

• (String)

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

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)
  include Aws::Structure
end

#priority ⇒ Integer

The priority of the sampling rule.

Returns:

• (Integer)

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

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)
  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 'lib/aws-sdk-xray/types.rb', line 1453

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)
  include Aws::Structure
end

#resource_arn ⇒ String

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

Returns:

• (String)

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

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)
  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 'lib/aws-sdk-xray/types.rb', line 1453

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)
  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 'lib/aws-sdk-xray/types.rb', line 1453

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)
  include Aws::Structure
end

#service_name ⇒ String

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

Returns:

• (String)

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

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)
  include Aws::Structure
end

#service_type ⇒ String

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

Returns:

• (String)

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

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)
  include Aws::Structure
end

#url_path ⇒ String

Matches the path from a request URL.

Returns:

• (String)

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

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)
  include Aws::Structure
end

#version ⇒ Integer

The version of the sampling rule format (‘1`).

Returns:

• (Integer)

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

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)
  include Aws::Structure
end