xray/aws.sdk.kotlin.services.xray.model/SamplingRule

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.

Types

Builder

class Builder

Companion

object Companion

Properties

attributes

val attributes: Map<String, String>?

Matches attributes derived from the request.

fixedRate

val fixedRate: Double

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

host

val host: String

Matches the hostname from a request URL.

httpMethod

val httpMethod: String

Matches the HTTP method of a request.

priority

val priority: Int

The priority of the sampling rule.

reservoirSize

val reservoirSize: Int

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.

resourceArn

val resourceArn: String

Matches the ARN of the Amazon Web Services resource on which the service runs.

ruleArn

val ruleArn: String?

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

ruleName

val ruleName: String?

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

samplingRateBoost

val samplingRateBoost: SamplingRateBoost?

Specifies the multiplier applied to the base sampling rate. This boost allows you to temporarily increase sampling without changing the rule's configuration.

serviceName

val serviceName: String

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

serviceType

val serviceType: String

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

urlPath

val urlPath: String

Matches the path from a request URL.

version

val version: Int

The version of the sampling rule format (1).