You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SamplingRule as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#attributes ⇒ Hash<String,String>

Matches attributes derived from the request.

Returns:

  • (Hash<String,String>) —

    Matches attributes derived from the request.

#fixed_rate ⇒ Float

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

Returns:

  • (Float) —

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

#host ⇒ String

Matches the hostname from a request URL.

Returns:

  • (String) —

    Matches the hostname from a request URL.

#http_method ⇒ String

Matches the HTTP method of a request.

Returns:

  • (String) —

    Matches the HTTP method of a request.

#priority ⇒ Integer

The priority of the sampling rule.

Returns:

  • (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. The reservoir is not used directly by services, but applies to all services using the rule collectively.

Returns:

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

Returns:

  • (String) —

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

#rule_arn ⇒ String

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

Returns:

  • (String) —

    The ARN of the sampling rule.

#rule_name ⇒ String

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

Returns:

  • (String) —

    The name of the sampling rule.

#service_name ⇒ String

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

Returns:

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

Returns:

  • (String) —

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

#url_path ⇒ String

Matches the path from a request URL.

Returns:

  • (String) —

    Matches the path from a request URL.

#version ⇒ Integer

The version of the sampling rule format (1).

Returns:

  • (Integer) —

    The version of the sampling rule format (1).