Struct SamplingTargetDocument

#[non_exhaustive]
pub struct SamplingTargetDocument {
    pub rule_name: Option<String>,
    pub fixed_rate: f64,
    pub reservoir_quota: Option<i32>,
    pub reservoir_quota_ttl: Option<DateTime>,
    pub interval: Option<i32>,
}

Temporary changes to a sampling rule configuration. To meet the global sampling target for a rule, X-Ray calculates a new reservoir for each service based on the recent sampling results of all services that called GetSamplingTargets.

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.

fixed_rate: f64

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

reservoir_quota: Option<i32>

The number of requests per second that X-Ray allocated for this service.

reservoir_quota_ttl: Option<DateTime>

When the reservoir quota expires.

interval: Option<i32>

The number of seconds for the service to wait before getting sampling targets again.

Implementations

impl SamplingTargetDocument

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

The name 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_quota(&self) -> Option<i32>

The number of requests per second that X-Ray allocated for this service.

pub fn reservoir_quota_ttl(&self) -> Option<&DateTime>

When the reservoir quota expires.

pub fn interval(&self) -> Option<i32>

The number of seconds for the service to wait before getting sampling targets again.

impl SamplingTargetDocument

pub fn builder() -> SamplingTargetDocumentBuilder

Creates a new builder-style object to manufacture SamplingTargetDocument.

Trait Implementations

impl Clone for SamplingTargetDocument

fn clone(&self) -> SamplingTargetDocument

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SamplingTargetDocument

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

Formats the value using the given formatter.

impl PartialEq for SamplingTargetDocument

fn eq(&self, other: &SamplingTargetDocument) -> 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 SamplingTargetDocument