Struct GlobalLogBuilder

pub struct GlobalLogBuilder { /* private fields */ }

The global log builder. See the GlobalLog struct for more information.

Implementations

impl GlobalLogBuilder

pub fn build(self) -> RResult<GlobalLog, AnyErr>

Build the global log from the configured builder.

pub fn stdout(self, pretty: bool, include_loc: bool) -> Self

Write to stdout:

Arguments:

• pretty: When enabled, logs are formatted more verbosely, but easier on the eyes.
• include_loc: When enabled, log contains write location (file and line).

pub fn file( self, file_prefix: impl Into<String>, dir: impl Into<PathBuf>, ) -> Self

Available on non-WebAssembly only.

Write to a file:

Arguments:

• file_prefix: The prefix for the filenames, e.g. “graphs.log” which will come out as “graphs.log.2021-01-21,
• dir: The directory to hold the log files, e.g. “./logs/”, will create if missing.

pub fn custom( self, pretty: bool, include_loc: bool, include_color: bool, include_ts: bool, writer: fn(&[u8]), ) -> Self

Write to a custom writer.

Arguments:

• pretty: When enabled, logs are formatted more verbosely, but easier on the eyes.
• include_loc: When enabled, log contains write location (file and line).
• include_color: When enabled, log contains colors.
• include_ts: When enabled, log contains timestamp.
• writer: The fn to handle writing, passed the raw byte string.

If needing a string in the writer, can do:

let log = String::from_utf8_lossy(log);

pub fn otlp_grpc( self, port: u16, service_name: impl Into<String>, service_version: impl Into<String>, ) -> Self

Available on crate feature opentelemetry-grpc only.

Write to an open telemetry provider via grpc. This works with the tokio runtime.

Arguments:

• port: The localhost port the open telemetry collector is running on and accepting grpc connections:
• service_name: The name of the service:
• service_version: The active version/deployment of the service:

pub fn otlp_http( self, endpoint: impl Into<String>, service_name: impl Into<String>, service_version: impl Into<String>, ) -> Self

Available on crate feature opentelemetry-http only.

Write to an open telemetry provider via http. This works with wasm!

Arguments:

• endpoint: The url string to connect via http to, e.g. “/otlp” or “http://localhost/otlp”:
• service_name: The name of the service:
• service_version: The active version/deployment of the service:

pub fn header(self, key: impl Into<String>, value: impl Into<String>) -> Self

Available on crate feature opentelemetry-http only.

Add a header to the last configured otlp http requests, this will be a no-op if the last output is not an otlp http output.

pub fn level_from(self, level: Level) -> RResult<Self, AnyErr>

Set the minimum level to log for.

NOTE: Applies to the last set output type only.

pub fn loc_matcher(self, loc_matcher: Regex) -> RResult<Self, AnyErr>

Available on crate feature log-filter only.

A regex that must be satisfied for a log to be accepted by this target. E.g. if regex is ‘logging::tests’ then only locations containing this will be logged by this target. Note that when None, will match all locations other than those matched by other layers with a loc_matcher.

NOTE: Applies to the last set output type only.

Trait Implementations

impl Default for GlobalLogBuilder

fn default() -> GlobalLogBuilder

Returns the “default value” for a type.