Struct InfluxiveWriterConfig

#[non_exhaustive]
pub struct InfluxiveWriterConfig {
    pub batch_duration: Duration,
    pub batch_buffer_size: usize,
    pub backend: Arc<dyn BackendFactory + Send + Sync>,
}

InfluxDB metric writer configuration.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

batch_duration: Duration

Max time span over which metric writes will be buffered before actually being written to InfluxDB to facilitate batching. Defaults to 100ms.

batch_buffer_size: usize

The size of the metric write batch buffer. If a metric to be written goes beyond this buffer, the batch will be sent early. If the buffer is again full before the previous batch finishes sending, the metric will be ignored and a trace will be written at “debug” level. Defaults to 4096.

backend: Arc<dyn BackendFactory + Send + Sync>

Backend driving this writer instance. This is currently driven by the influxdb crate, but that is subject to change without notice.

Implementations

impl InfluxiveWriterConfig

pub fn create_with_influx_file(path: PathBuf) -> InfluxiveWriterConfig

Construct a Config that uses a LineProtocolFileBackendFactory

pub fn with_batch_duration( self, batch_duration: Duration, ) -> InfluxiveWriterConfig

Apply InfluxiveWriterConfig::batch_duration.

pub fn with_batch_buffer_size( self, batch_buffer_size: usize, ) -> InfluxiveWriterConfig

Apply InfluxiveWriterConfig::batch_buffer_size.

pub fn with_backend( self, backend: Arc<dyn BackendFactory + Send + Sync>, ) -> InfluxiveWriterConfig

Apply InfluxiveWriterConfig::backend.

Trait Implementations

impl Clone for InfluxiveWriterConfig

fn clone(&self) -> InfluxiveWriterConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InfluxiveWriterConfig

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

Formats the value using the given formatter.

impl Default for InfluxiveWriterConfig

fn default() -> InfluxiveWriterConfig

Returns the “default value” for a type.