Struct LoggingLayer 

pub struct LoggingLayer<I = DefaultLoggingInterceptor> { /* private fields */ }

LoggingLayer records every operation with log.

Logging

• OpenDAL emits structured logs.
• Every operation starts with a started log entry.
• Every operation ends with one of the following statuses:
  • succeeded: The operation succeeded but might have more work to perform.
  • finished: The whole operation finished.
  • failed: The operation returned an error.
• The default log level for expected errors is Warn.
• The default log level for unexpected errors is Error.

Examples

let _ = Operator::new(services::Memory::default())?
    .layer(LoggingLayer::default());

Output

OpenDAL uses log internally.

To enable logging output, please set RUST_LOG:

RUST_LOG=debug ./app

To config logging output, please refer to Configure Logging:

RUST_LOG="info,opendal::services=debug" ./app

Logging Interceptor

You can implement your own logging interceptor to customize the logging behavior.

#[derive(Debug, Clone)]
struct MyLoggingInterceptor;

impl LoggingInterceptor for MyLoggingInterceptor {
    fn log(
        &self,
        info: &raw::ServiceInfo,
        operation: raw::Operation,
        context: &[(&str, &str)],
        message: &str,
        err: Option<&Error>,
    ) {
        // log something
    }
}

let _ = Operator::new(services::Memory::default())?
    .layer(LoggingLayer::new(MyLoggingInterceptor));

Implementations

impl LoggingLayer

pub fn new<I: LoggingInterceptor>(logger: I) -> LoggingLayer<I>

Create the layer with specific logging interceptor.

Trait Implementations

impl<I: Clone> Clone for LoggingLayer<I>

fn clone(&self) -> LoggingLayer<I>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I: Copy> Copy for LoggingLayer<I>

impl<I: Debug> Debug for LoggingLayer<I>

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<I: LoggingInterceptor> Layer for LoggingLayer<I>

fn apply_service(&self, inner: Servicer) -> Servicer

Intercept the operation service stack.

fn apply_context( &self, srv: Arc<dyn ServiceDyn>, inner: OperationContext, ) -> OperationContext

Intercept the operation context (HTTP transport and executor).