Struct spirit_dipstick::Config

pub struct Config {
    pub prefix: String,
    pub flush_period: Duration,
    // some fields omitted
}

The Fragment to configure dipsticks backends.

This contains the configuration options to configure where the metrics go.

If you want to be able to turn the metrics off completely, use Option<Config>.

Some of the fields are publicly available and accessible, as they might be useful for other purposes ‒ like generating some metrics at the same frequency as they are being sent.

Examples

use serde::Deserialize;
use spirit_dipstick::Config;

#[derive(Default, Deserialize)]
struct Cfg {
    metrics: Config,
}

Fields

prefix: String

The prefix ‒ first level of the metrics tree, under which all the metrics are stored.

If not specifie, it defaults to the application name (gotten from the CARGO_PKG_NAME environment variable).

flush_period: Duration

An interval at which the metrics are sent in aggregated form.

The metrics are not sent right away, they are buffered and collated for this period of time, then they are sent in a batch.

Trait Implementations

impl PartialEq<Config> for Config

fn eq(&self, other: &Config) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Config) -> bool

This method tests for !=.

impl Default for Config

fn default() -> Self

Returns the "default value" for a type.

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for Config

impl Debug for Config

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

Formats the value using the given formatter.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Fragment for Config

type Driver = CacheEq<Config>

The default driver to be used by the fragment.

type Installer = ()

The default installer to be used unless a transformation or the user doesn't provide one.

type Seed = ()

The intermediate product if the fragment supports two-stage creation of [Resource][Fragment::Resource]s. If not, it can be set to ().

type Resource = Backends

The actual product this [Fragment] creates.

fn make_seed(&self, _name: &str) -> Result<(), Error>

Runs the first stage of creation.

fn make_resource(&self, _seed: &mut (), name: &str) -> Result<Backends, Error>

Runs the second stage of creation.

const RUN_BEFORE_CONFIG: bool

Configuration if the pipeline should be run once even before the config is loaded.

fn create(&self, name: &'static str) -> Result<Self::Resource, Error>

Runs both stages of creation at once.

fn init<B>(builder: B, &'static str) -> Result<B, Error> where
    B: Extensible<Ok = B>,
    <B as Extensible>::Config: DeserializeOwned,
    <B as Extensible>::Config: Send,
    <B as Extensible>::Config: Sync,
    <B as Extensible>::Config: 'static,
    <B as Extensible>::Opts: StructOpt,
    <B as Extensible>::Opts: Send,
    <B as Extensible>::Opts: Sync,
    <B as Extensible>::Opts: 'static, 

An initialization routine.

impl Optional for Config

impl StructDoc for Config

fn document() -> Documentation

Returns the documentation for the type.