Struct SamplingRule

#[non_exhaustive]
pub struct SamplingRule {

    pub rule_name: Option<String>,
    pub rule_arn: Option<String>,
    pub resource_arn: String,
    pub priority: i32,
    pub fixed_rate: f64,
    pub reservoir_size: i32,
    pub service_name: String,
    pub service_type: String,
    pub host: String,
    pub http_method: String,
    pub url_path: String,
    pub version: i32,
    pub attributes: Option<HashMap<String, String>>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

rule_name: Option<String>

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

rule_arn: Option<String>

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

resource_arn: String

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

priority: i32

The priority of the sampling rule.

fixed_rate: f64

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

reservoir_size: i32

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.

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.

host: String

Matches the hostname from a request URL.

http_method: String

Matches the HTTP method of a request.

url_path: String

Matches the path from a request URL.

version: i32

The version of the sampling rule format (1).

attributes: Option<HashMap<String, String>>

Matches attributes derived from the request.

Implementations

impl SamplingRule

pub fn rule_name(&self) -> Option<&str>

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

pub fn rule_arn(&self) -> Option<&str>

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

pub fn resource_arn(&self) -> &str

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

pub fn priority(&self) -> i32

The priority of the sampling rule.

pub fn fixed_rate(&self) -> f64

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

pub fn reservoir_size(&self) -> i32

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.

pub fn service_name(&self) -> &str

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

pub fn service_type(&self) -> &str

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

pub fn host(&self) -> &str

Matches the hostname from a request URL.

pub fn http_method(&self) -> &str

Matches the HTTP method of a request.

pub fn url_path(&self) -> &str

Matches the path from a request URL.

pub fn version(&self) -> i32

The version of the sampling rule format (1).

pub fn attributes(&self) -> Option<&HashMap<String, String>>

Matches attributes derived from the request.

impl SamplingRule

pub fn builder() -> SamplingRuleBuilder

Creates a new builder-style object to manufacture SamplingRule.

Trait Implementations

impl Clone for SamplingRule

fn clone(&self) -> SamplingRule

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SamplingRule

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for SamplingRule

fn eq(&self, other: &SamplingRule) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SamplingRule