class Aws::XRay::Types::SamplingRule

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.

@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",
      },
    }

@!attribute [rw] rule_name

The name of the sampling rule. Specify a rule by either name or ARN,
but not both.
@return [String]

@!attribute [rw] rule_arn

The ARN of the sampling rule. Specify a rule by either name or ARN,
but not both.
@return [String]

@!attribute [rw] resource_arn

Matches the ARN of the Amazon Web Services resource on which the
service runs.
@return [String]

@!attribute [rw] priority

The priority of the sampling rule.
@return [Integer]

@!attribute [rw] fixed_rate

The percentage of matching requests to instrument, after the
reservoir is exhausted.
@return [Float]

@!attribute [rw] reservoir_size

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.
@return [Integer]

@!attribute [rw] service_name

Matches the `name` that the service uses to identify itself in
segments.
@return [String]

@!attribute [rw] service_type

Matches the `origin` that the service uses to identify its type in
segments.
@return [String]

@!attribute [rw] host

Matches the hostname from a request URL.
@return [String]

@!attribute [rw] http_method

Matches the HTTP method of a request.
@return [String]

@!attribute [rw] url_path

Matches the path from a request URL.
@return [String]

@!attribute [rw] version

The version of the sampling rule format (`1`).
@return [Integer]

@!attribute [rw] attributes

Matches attributes derived from the request.
@return [Hash<String,String>]

@see docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/SamplingRule AWS API Documentation

Constants

SENSITIVE