Struct relay_metrics::BucketMetadata

pub struct BucketMetadata {
    pub merges: u32,
    pub received_at: Option<UnixTimestamp>,
    pub extracted_from_indexed: bool,
}

Relay internal metadata for a metric bucket.

Fields

merges: u32

How many times the bucket was merged.

Creating a new bucket is the first merge. Merging two buckets sums the amount of merges.

For example: Merging two un-merged buckets will yield a total of 2 merges.

Due to how Relay aggregates metrics and later splits them into multiple buckets again, the amount of merges can be zero. When splitting a bucket the total volume of the bucket may only be attributed to one part or distributed across the resulting buckets, in either case values of 0 are possible.

received_at: Option<UnixTimestamp>

Received timestamp of the first metric in this bucket.

This field should be set to the time in which the first metric of a specific bucket was received in the outermost internal Relay.

extracted_from_indexed: bool

Is true if this metric was extracted from a sampled/indexed envelope item.

The final dynamic sampling decision is always made in processing Relays. If a metric was extracted from an item which is sampled (i.e. retained by dynamic sampling), this flag is true.

Since these metrics from samples carry additional information, e.g. they don’t require rate limiting since the sample they’ve been extracted from was already rate limited, this flag must be included in the aggregation key when aggregation buckets.

Implementations

impl BucketMetadata

pub fn new(received_at: UnixTimestamp) -> Self

Creates a fresh metadata instance.

The new metadata is initialized with 1 merge and a given received_at timestamp.

pub fn is_default(&self) -> bool

Whether the metadata does not contain more information than the default.

pub fn merge(&mut self, other: Self)

Merges another metadata object into the current one.

Trait Implementations

impl Clone for BucketMetadata

fn clone(&self) -> BucketMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BucketMetadata

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

Formats the value using the given formatter.

impl Default for BucketMetadata

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BucketMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BucketMetadata

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for BucketMetadata

impl StructuralPartialEq for BucketMetadata