Struct munin_plugin::config::Config

pub struct Config {
    pub plugin_name: String,
    pub plugin_statedir: PathBuf,
    pub plugin_cache: PathBuf,
    pub dirtyconfig: bool,
    pub daemonize: bool,
    pub pidfile: PathBuf,
    pub cfgsize: usize,
    pub fetchsize: usize,
}

Plugin configuration.

Fields

plugin_name: String

The name of the plugin.

Default is “Simple munin plugin in Rust”

plugin_statedir: PathBuf

Plugins state directory

Fallback to /tmp if environment variable MUNIN_PLUGSTATE is not set.

plugin_cache: PathBuf

Cachefile for the plugin

Plugins that daemonize and continuously fetch data need to write them somewhere, so that the MuninPlugin::fetch function can output them. The default is a combination of Config::plugin_statedir and a random string, with munin and value added, in std::format! syntax: "{}.munin.{}.value", [Config::plugin_statedir], randomstring.

dirtyconfig: bool

Does munin support dirtyconfig? (Send data after sending config)

Checks MUNIN_CAP_DIRTYCONFIG environment variable, if set to 1, this is true, otherwise false.

daemonize: bool

Does this plugin need to run in background, continuously fetching data?

Default to false

pidfile: PathBuf

If plugin uses daemonize, whats the pidfile name?

Defaults to Config::plugin_statedir plus “munin-plugin.pid”, using Config::new will set it to Config::plugin_statedir/Config::plugin_name.pid

cfgsize: usize

Size of buffer for BufWriter for MuninPlugin::config.

Defaults to 8192, but if the plugin outputs huge munin configuration (trivial with multigraph plugins), you may want to increase this.

fetchsize: usize

Size of buffer for BufWriter for MuninPlugin::fetch.

Defaults to 8192, but if the plugin outputs large datasets, it is useful to increase this.

Implementations

impl Config

pub fn new(plugin_name: String) -> Self

Create a new Config with defined plugin_name, also setting Config::pidfile and Config::plugin_cache to a sensible value using the Config::plugin_name.

Examples

let config = Config::new(String::from("great-plugin"));
println!("My pidfile is {:?}", config.pidfile);

Trait Implementations

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 Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

Useful defaults, if possible based on munin environment.

fn default() -> Self

Set default values, try to read munin environment variables to fill Config::plugin_statedir and Config::dirtyconfig. Config::plugin_statedir falls back to /tmp if no munin environment variables are present.

impl Hash for Config

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

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 Eq for Config

impl StructuralEq for Config

impl StructuralPartialEq for Config