Struct LoggingConfig

#[non_exhaustive]
pub struct LoggingConfig {
    console: Option<String>,
    journald: Option<String>,
    files: Vec<LogfileConfig>,
    log_sensitive_information: bool,
    time_granularity: Duration,
}

Structure to hold our logging configuration options

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

console: Option<String>

Filtering directives that determine tracing levels as described at https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/targets/struct.Targets.html#impl-FromStr

You can override this setting with the -l, –log-level command line parameter.

Example: “info,tor_proto::channel=trace”

journald: Option<String>

Filtering directives for the journald logger.

Only takes effect if Arti is built with the journald filter.

files: Vec<LogfileConfig>

Configuration for one or more logfiles.

The default is not to log to any files.

log_sensitive_information: bool

If set to true, we disable safe logging on all logs, and store potentially sensitive information at level info or higher.

This can be useful for debugging, but it increases the value of your logs to an attacker. Do not turn this on in production unless you have a good log rotation mechanism.

time_granularity: Duration

An approximate granularity with which log times should be displayed.

This value controls every log time that arti outputs; it doesn’t have any effect on times written by other logging programs like journald.

We may round this value up for convenience: For example, if you say “2.5s”, we may treat it as if you had said “3s.”

The default is “1s”, or one second.

Implementations

impl LoggingConfig

pub fn builder() -> LoggingConfigBuilder

Returns a fresh, default, builder

Trait Implementations

impl Clone for LoggingConfig

fn clone(&self) -> LoggingConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LoggingConfig

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

Formats the value using the given formatter.

impl Default for LoggingConfig

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for LoggingConfig

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for LoggingConfig

impl StructuralPartialEq for LoggingConfig