Struct Trigger

pub struct Trigger {
    pub name: Option<String>,
    pub producer_name_regex: Option<String>,
    pub stop_delay_ms: Option<u32>,
    pub max_per_24_h: Option<u32>,
    pub skip_probability: Option<f64>,
}

Fields

name: Option<String>

The producer must specify this name to activate the trigger.

producer_name_regex: Option<String>

An std::regex that will match the producer that can activate this trigger. This is optional. If unset any producers can activate this trigger.

stop_delay_ms: Option<u32>

After a trigger is received either in START_TRACING or STOP_TRACING mode then the trace will end |stop_delay_ms| after triggering. In CLONE_SNAPSHOT mode, this is the delay between the trigger and the snapshot. If |prefer_suspend_clock_for_duration| is set, the duration will be based on wall-clock, counting also time in suspend.

max_per_24_h: Option<u32>

Limits the number of traces this trigger can start/stop in a rolling 24 hour window. If this field is unset or zero, no limit is applied and activiation of this trigger always starts/stops the trace.

skip_probability: Option<f64>

A value between 0 and 1 which encodes the probability of skipping a trigger with this name. This is useful for reducing the probability of high-frequency triggers from dominating trace finaization. If this field is unset or zero, the trigger will never be skipped. If this field is greater than or equal to 1, this trigger will always be skipped i.e. it will be as if this trigger was never included in the first place. This probability check is applied before any other limits. For example, if |max_per_24_h| is also set, first we will check if the probability bar is met and only then will we check the |max_per_24_h| limit.

Implementations

impl Trigger

pub fn name(&self) -> &str

Returns the value of name, or the default value if name is unset.

pub fn producer_name_regex(&self) -> &str

Returns the value of producer_name_regex, or the default value if producer_name_regex is unset.

pub fn stop_delay_ms(&self) -> u32

Returns the value of stop_delay_ms, or the default value if stop_delay_ms is unset.

pub fn max_per_24_h(&self) -> u32

Returns the value of max_per_24_h, or the default value if max_per_24_h is unset.

pub fn skip_probability(&self) -> f64

Returns the value of skip_probability, or the default value if skip_probability is unset.

Trait Implementations

impl Clone for Trigger

fn clone(&self) -> Trigger

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Trigger

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

Formats the value using the given formatter.

impl Default for Trigger

fn default() -> Self

Returns the “default value” for a type.

impl Message for Trigger

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Trigger

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