Struct relay_metrics::BucketView

pub struct BucketView<'a> { /* private fields */ }

A view into a metrics bucket. Sometimes also called a partial bucket. A view contains a subset of datapoints of the original bucket.

            Full Bucket
/-------------------------------\
[0, 1, 2, 3, 5, 5, 5, 10, 11, 11]
\----------------/\-------------/
      View 1          View 2

A view can be split again into multiple smaller views.

Implementations

impl<'a> BucketView<'a>

pub fn new(bucket: &'a Bucket) -> Self

Creates a new bucket view of a bucket.

The resulting view contains the entire bucket.

pub fn timestamp(&self) -> UnixTimestamp

Timestamp of the bucket.

See also: Bucket::timestamp

pub fn width(&self) -> u64

Width of the bucket.

See also: Bucket::width

pub fn name(&self) -> &'a MetricName

Name of the bucket.

See also: Bucket::name

pub fn value(&self) -> BucketViewValue<'a>

Value of the bucket view.

pub fn ty(&self) -> MetricType

Type of the value of the bucket view.

pub fn tags(&self) -> &'a BTreeMap<String, String>

Name of the bucket.

See also: Bucket::tags

pub fn tag(&self, name: &str) -> Option<&'a str>

Returns the value of the specified tag if it exists.

See also: Bucket::tag()

pub fn metadata(&self) -> &BucketMetadata

Returns the metadata for this bucket.

See also: Bucket::metadata.

pub fn len(&self) -> usize

Number of raw datapoints in this view.

See also: BucketValue::len()

pub fn is_empty(&self) -> bool

Returns true if this bucket view contains no values.

pub fn select(self, range: Range<usize>) -> Option<Self>

Selects a sub-view of the current view.

Returns None when:

• the passed range is not contained in the current view.
• trying to split a counter or gauge bucket.

pub fn estimated_size(&self) -> usize

Estimates the number of bytes needed to serialize the bucket.

Note that this does not match the exact size of the serialized payload. Instead, the size is approximated through the number of contained values, assuming an average size of serialized values.

pub fn split( self, size: usize, max_size: Option<usize> ) -> (Option<Self>, Option<Self>)

Calculates a split for this bucket if its estimated serialization size exceeds a threshold.

There are three possible return values:

• (Some, None) if the bucket fits entirely into the size budget. There is no split.
• (None, Some) if the size budget cannot even hold the bucket name and tags. There is no split, the entire bucket is moved.
• (Some, Some) if the bucket fits partially. Remaining values are moved into a new bucket with all other information cloned.

This is an approximate function. The bucket is not actually serialized, but rather its footprint is estimated through the number of data points contained. See estimated_size for more information.

Trait Implementations

impl<'a> Clone for BucketView<'a>

fn clone(&self) -> BucketView<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BucketView<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a Bucket> for BucketView<'a>

fn from(value: &'a Bucket) -> Self

Converts to this type from the input type.

impl<'a> Serialize for BucketView<'a>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.