Struct splinter::tap::influx::InfluxRecorder

pub struct InfluxRecorder { /* private fields */ }

Enables using the metrics macros and sending the metrics data to a running Influx database

Implementations

impl InfluxRecorder

pub fn init(
    db_url: &str,
    db_name: &str,
    username: &str,
    password: &str
) -> Result<(), InternalError>

Initialize metric collection by creating the InfluxRecorder that will connect to the InfluxDB instance. The record is then added to the metrics library as the recorder which enables sending the metrics data to the database.

Arguments

• db_url - The URL to connect the InfluxDB database for metrics collection
• db_name - The name of the InfluxDB database for metrics Collection.
• username - The username used for authorization with the InfluxDB.
• password - The password used for authorization with the InfluxDB.

Trait Implementations

impl Recorder for InfluxRecorder

fn increment_counter(&self, key: &Key, value: u64)

Increments a counter.

fn update_gauge(&self, key: &Key, value: GaugeValue)

Updates a gauge.

fn record_histogram(&self, key: &Key, value: f64)

Records a histogram.

fn register_counter(
    &self,
    key: &Key,
    _unit: Option<Unit>,
    _description: Option<&'static str>
)

Registers a counter.

fn register_gauge(
    &self,
    key: &Key,
    _unit: Option<Unit>,
    _description: Option<&'static str>
)

Registers a gauge.

fn register_histogram(
    &self,
    key: &Key,
    _unit: Option<Unit>,
    _description: Option<&'static str>
)

Registers a histogram.

impl ShutdownHandle for InfluxRecorder

fn signal_shutdown(&mut self)

Instructs the component to begin shutting down.

fn wait_for_shutdown(self) -> Result<(), InternalError>

Waits until the the component has completely shutdown.