Enum SamplingReason 

#[non_exhaustive]
#[repr(i32)]
pub enum SamplingReason {
    Unspecified = 0,
    HeadRate = 1,
    TailError = 2,
    Slow = 3,
    Forensic = 4,
    Audit = 5,
    Runtime = 6,
    Override = 7,
}

Provenance recorded on the envelope explaining why an event was kept.

Head-sampler-dropped events never produce an envelope, so they need no enum value. See 10-data-model.md § 5.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unspecified = 0

Never appears in a well-formed envelope.

HeadRate = 1

Selected by head-rate roll.

TailError = 2

Flushed because a sibling event hit ERROR/FATAL.

Slow = 3

always_log_slower_than_ms triggered.

Forensic = 4

Emitted by obs::forensic! (always retained).

Audit = 5

AUDIT-tier event (always retained).

Runtime = 6

SDK self-event (obs.runtime.v1.*).

Override = 7

Per-event head_rate=1.0 forces always-on.

Implementations

impl SamplingReason

pub const fn as_str(self) -> &'static str

Stable string label.

Trait Implementations

impl Clone for SamplingReason

fn clone(&self) -> SamplingReason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SamplingReason

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

Formats the value using the given formatter.

impl Default for SamplingReason

fn default() -> SamplingReason

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SamplingReason

fn deserialize<__D>( __deserializer: __D, ) -> Result<SamplingReason, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Enumeration for SamplingReason

fn from_i32(value: i32) -> Option<SamplingReason>

Convert from an i32 wire value to the enum.

fn to_i32(&self) -> i32

Convert the enum to its i32 wire value.

fn proto_name(&self) -> &'static str

The name of this enum variant as it appears in the .proto file.

fn from_proto_name(name: &str) -> Option<SamplingReason>

Look up a variant by its protobuf name string.

fn values() -> &'static [SamplingReason]

All known variants of this enum, in proto declaration order.

impl FromStr for SamplingReason

type Err = UnknownVariant

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<SamplingReason, <SamplingReason as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for SamplingReason

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SamplingReason

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for SamplingReason

impl Eq for SamplingReason

impl StructuralPartialEq for SamplingReason