Struct CollectdLoggerBuilder

pub struct CollectdLoggerBuilder { /* private fields */ }

A builder for configuring and installing a collectd logger.

It is recommended to instantiate the logger in PluginManager::plugins.

The use case of multiple rust plugins that instantiate a global logger is supported. Each plugin will have its own copy of a global logger. Thus plugins won’t interefere with others and their logging.

Implementations

impl CollectdLoggerBuilder

pub fn new() -> Self

Creates a new CollectdLoggerBuilder that will forward log messages to collectd.

By default, accepts all log levels and uses the default format. See CollectdLoggerBuilder::filter_level to filter and CollectdLoggerBuilder::format for custom formatting.

pub fn prefix_plugin<T: PluginManager>(self) -> Self

Sets a prefix using the plugin manager’s name.

pub fn filter_level(self, level: LevelFilter) -> Self

Sets the log level filter - only messages at this level and above will be forwarded to collectd.

Example

use collectd_plugin::CollectdLogger;
use log::LevelFilter;

CollectdLogger::new()
    .prefix("myplugin")
    .filter_level(LevelFilter::Info)
    .try_init()?;

log::debug!("This will be filtered out");
log::info!("This will go to collectd");

pub fn format<F>(self, format: F) -> Self

where F: Fn(&mut dyn Write, &Record<'_>) -> Result<()> + Sync + Send + 'static,

Sets the format function for formatting the log output.

Example

use collectd_plugin::CollectdLoggerBuilder;
use std::io::Write;

CollectdLoggerBuilder::new()
    .prefix("myplugin")
    .format(|buf, record| {
        write!(buf, "[{}] {}", record.level(), record.args())
    })
    .try_init()?;

pub fn build(self) -> CollectdLogger

The returned logger implements the Log trait and can be installed manually or nested within another logger.

pub fn try_init(self) -> Result<(), SetLoggerError>

Initializes this logger as the global logger.

All log messages will go to collectd via plugin_log. This is the only appropriate destination for logs in collectd plugins.

Errors

This function will fail if it is called more than once, or if another library has already initialized a global logger.