Enum vector_common::request_metadata::GroupedCountByteSize

pub enum GroupedCountByteSize {
    Tagged {
        sizes: HashMap<TaggedEventsSent, CountByteSize>,
    },
    Untagged {
        size: CountByteSize,
    },
}

Keeps track of the estimated json size of a given batch of events by source and service.

Variants

Tagged

When we need to keep track of the events by certain tags we use this variant.

Fields

sizes: HashMap<TaggedEventsSent, CountByteSize>

Untagged

If we don’t need to track the events by certain tags we can use this variant to avoid allocating a HashMap,

Fields

size: CountByteSize

Implementations

impl GroupedCountByteSize

pub fn new_tagged() -> Self

Creates a new Tagged variant for when we need to track events by certain tags.

pub fn new_untagged() -> Self

Creates a new Tagged variant for when we do not need to track events by tags.

pub fn add_event<E>(&mut self, event: &E, json_size: JsonSize)

where E: GetEventCountTags,

Adds the given estimated json size of the event to current count.

pub fn emit_event<T, H>(&self, event_cache: &RegisteredEventCache<(), T>)

where T: RegisterTaggedInternalEvent<Tags = TaggedEventsSent, Fixed = (), Handle = H>, H: InternalEventHandle<Data = CountByteSize>,

Emits our counts to a RegisteredEvent cached event.

pub fn is_tagged(&self) -> bool

Returns true if we are the Tagged variant - keeping track of the byte sizes grouped by their relevant tags.

pub fn is_untagged(&self) -> bool

Returns true if we are the Untagged variant - keeping a single count for all events.

Trait Implementations

impl<'a> Add<&'a GroupedCountByteSize> for GroupedCountByteSize

type Output = GroupedCountByteSize

The resulting type after applying the + operator.

fn add(self, other: &'a Self::Output) -> Self::Output

Performs the + operation.

impl AddAssign for GroupedCountByteSize

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for GroupedCountByteSize

fn clone(&self) -> GroupedCountByteSize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GroupedCountByteSize

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

Formats the value using the given formatter.

impl Default for GroupedCountByteSize

fn default() -> Self

Returns the “default value” for a type.

impl From<CountByteSize> for GroupedCountByteSize

fn from(value: CountByteSize) -> Self

Converts to this type from the input type.