Struct opendal::layers::LoggingLayer

pub struct LoggingLayer { /* private fields */ }

LoggingLayer will add logging for OpenDAL.

Logging

• OpenDAL will log in structural way.
• Every operation will start with a started log entry.
• Every operation will finish with the following status:
  • finished: the operation is successful.
  • errored: the operation returns an expected error like NotFound.
  • failed: the operation returns an unexpected error.

Todo

We should migrate to log’s kv api after it’s ready.

Tracking issue: https://github.com/rust-lang/log/issues/328

Examples

use anyhow::Result;
use opendal::layers::LoggingLayer;
use opendal::Operator;
use opendal::Scheme;

let _ = Operator::from_env(Scheme::Fs)
    .expect("must init")
    .layer(LoggingLayer::default());

Implementations

impl LoggingLayer

pub fn with_error_level(self, level: Option<Level>) -> Self

Setting the log level while expected error happened.

For example: accessor returns ObjectNotFound.

None means disable the log for error.

pub fn with_failure_level(self, level: Option<Level>) -> Self

Setting the log level while unexpected failure happened.

For example: accessor returns Unexpected network error.

None means disable the log for failure.

Trait Implementations

impl Clone for LoggingLayer

fn clone(&self) -> LoggingLayer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LoggingLayer

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

Formats the value using the given formatter.

impl Default for LoggingLayer

fn default() -> Self

Returns the “default value” for a type.

impl Layer for LoggingLayer

fn layer(&self, inner: Arc<dyn Accessor>) -> Arc<dyn Accessor>

Intercept the operations on the underlying storage.

impl Copy for LoggingLayer