Struct logcontrol_log::LogController

pub struct LogController<F: LogFactory> { /* private fields */ }

A LogControl1 implementation for log.

This implementation creates a log::Log implementation whose level and underlying logger can be dynamically reconfigured through the LogControl1 interface. It uses a ReloadLog together with a LevelFilter under the hood.

Currently, this implementation only supports for following KnownLogTargets:

• KnownLogTarget::Console
• KnownLogTarget::Journal
• KnownLogTarget::Auto

Any other target fails with LogControl1Error::UnsupportedLogTarget.

Implementations

impl<F: LogFactory> LogController<F>

pub fn new( factory: F, connected_to_journal: bool, syslog_identifier: String, target: KnownLogTarget, level: Level ) -> Result<(Self, ControlledLog), LogControl1Error>

Create a new logger which can be controlled through the log control interface.

factory creates the inner log::Log instances for the selected target which denotes the initial log target. The factory is invoked whenever the log target is changed, to create a new logger for the corresponding target. See LogController for supported log targets.

connected_to_journal indicates whether this process is connected to the systemd journal. Set to true to make KnownLogTarget::Auto use KnownLogTarget::Journal, otherwise it uses KnownLogTarget::Console.

level denotes the default tracing log level to start with.

syslog_identifier is passed to LogFactory::create_journal_log for use as SYSLOG_IDENTIFIER journal field.

Returns an error if target is not supported, of if creating a layer fails, e.g. when selecting KnownLogTarget::Journal on a system where journald is not running, or inside a container which has no direct access to the journald socket.

pub fn new_auto( factory: F, level: Level ) -> Result<(Self, ControlledLog), LogControl1Error>

Create a new logger which can be controlled through the log control interface, using automatic defaults.

Use logcontrol::syslog_identifier() as the syslog identifier, and determine the initial log target automatically according to logcontrol::stderr_connected_to_journal().

level denotes the initial level; for factory and returned errors, see Self::new.

pub fn install_auto(factory: F, level: Level) -> Result<Self, LogControl1Error>

Create and install a controlled logger, with automatic defaults.

See Self::new_auto for arguments and errors. Additionally, this function fails with LogControl1Error::Failure if log::set_boxed_logger fails.

Trait Implementations

impl<F: LogFactory> LogControl1 for LogController<F>

fn level(&self) -> LogLevel

Get the currently configured log level.

fn set_level(&mut self, level: LogLevel) -> Result<(), LogControl1Error>

Set the level of the underlying log framework.

fn target(&self) -> &str

Get the currently configured log target.

fn set_target<S: AsRef<str>>( &mut self, target: S ) -> Result<(), LogControl1Error>

Set the target of the underlying log framework.

fn syslog_identifier(&self) -> &str

Get the syslog identifier.