Struct dipstick::Log

pub struct Log { /* private fields */ }

Buffered metrics log output.

Implementations

impl Log

pub fn to_log() -> Log

Write metric values to the standard log using info!.

Examples found in repository

examples/raw_log.rs (line 12)

pub fn raw_write() {
    // setup dual metric channels
    let metrics_log = dipstick::Log::to_log().metrics();

    // define and send metrics using raw channel API
    let counter = metrics_log.new_metric("count_a".into(), dipstick::InputKind::Counter);
    counter.write(1, labels![]);
}

pub fn level(&self, level: Level) -> Self

Sets the log target to use when logging metrics. See the (log!)[https://docs.rs/log/0.4.6/log/macro.log.html] documentation.

pub fn target(&self, target: &str) -> Self

Sets the log target to use when logging metrics. See the (log!)[https://docs.rs/log/0.4.6/log/macro.log.html] documentation.

Trait Implementations

impl Buffered for Log

fn buffered(&self, buffering: Buffering) -> Self

Return a clone with the specified buffering set.

fn get_buffering(&self) -> Buffering

Return the current buffering strategy.

fn is_buffered(&self) -> bool

Returns false if the current buffering strategy is Buffering::Unbuffered. Returns true otherwise.

impl CachedInput for Log

fn cached(self, max_size: usize) -> InputCache

Wrap an input with a metric definition cache. This can provide performance benefits for metrics that are dynamically defined at runtime on each access. Caching is useless if all metrics are statically declared or instantiated programmatically in advance and referenced by a long living variable.

impl Clone for Log

fn clone(&self) -> Log

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Formatting for Log

fn formatting(&self, format: impl LineFormat + 'static) -> Self

Specify formatting of output.

impl Input for Log

type SCOPE = LogScope

The type of Scope returned byt this input.

fn metrics(&self) -> Self::SCOPE

Open a new scope from this input.

fn input(&self) -> Self::SCOPE

👎Deprecated since 0.7.2: Use metrics()

Open a new scope from this input.

fn new_scope(&self) -> Self::SCOPE

👎Deprecated since 0.8.0: Use metrics()

Open a new scope from this input.

impl QueuedInput for Log

fn queued(self, max_size: usize) -> InputQueue

Wrap this output with an asynchronous dispatch queue of specified length.

impl WithAttributes for Log

fn get_attributes(&self) -> &Attributes

Return attributes of component.

fn mut_attributes(&mut self) -> &mut Attributes

Return attributes of component for mutation.

fn with_attributes<F: Fn(&mut Attributes)>(&self, edit: F) -> Self

Clone the component and mutate its attributes at once.