Struct StreamBuilder

pub struct StreamBuilder { /* private fields */ }

A builder for creating Stream objects.

Example

use opentelemetry_sdk::metrics::{Aggregation, Stream};
use opentelemetry::Key;

let stream = Stream::builder()
    .with_name("my_stream")
    .with_aggregation(Aggregation::Sum)
    .with_cardinality_limit(100)
    .build()
    .unwrap();

Implementations

impl StreamBuilder

pub fn with_name(self, name: impl Into<Cow<'static, str>>) -> StreamBuilder

Set the stream name. If this is not set, name provide while creating the instrument will be used.

pub fn with_description( self, description: impl Into<Cow<'static, str>>, ) -> StreamBuilder

Set the stream description. If this is not set, description provided while creating the instrument will be used.

pub fn with_unit(self, unit: impl Into<Cow<'static, str>>) -> StreamBuilder

Set the stream unit. If this is not set, unit provided while creating the instrument will be used.

pub fn with_cardinality_limit(self, limit: usize) -> StreamBuilder

Set the stream cardinality limit. If this is not set, the default limit of 2000 will be used.

pub fn build(self) -> Result<Stream, Box<dyn Error>>

Build a new Stream instance using the configuration in this builder.

Returns

A Result containing the new Stream instance or an error if the build failed.

Trait Implementations

impl Debug for StreamBuilder

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

Formats the value using the given formatter.

impl Default for StreamBuilder

fn default() -> StreamBuilder

Returns the “default value” for a type.