Struct Logger

pub struct Logger { /* private fields */ }

Server log processor

Implementations

impl Logger

pub fn new(config: &AppConfig) -> (Self, Receiver<UnifiedLogEntry>)

Create a new Logger instance Returns Logger and corresponding Receiver

pub fn get_queue_capacity(&self) -> usize

get the queue capacity This function returns the queue capacity.

Returns

The queue capacity

Example

use rustfs_obs::Logger;
async fn example(logger: &Logger) {
   let _ = logger.get_queue_capacity();
}

pub async fn log_server_entry( &self, entry: ServerLogEntry, ) -> Result<(), GlobalError>

Log a server entry

pub async fn log_audit_entry( &self, entry: AuditLogEntry, ) -> Result<(), GlobalError>

Log an audit entry

pub async fn log_console_entry( &self, entry: ConsoleLogEntry, ) -> Result<(), GlobalError>

Log a console entry

pub async fn log_entry(&self, entry: UnifiedLogEntry) -> Result<(), GlobalError>

Asynchronous logging of unified log entries

pub async fn write_with_context( &self, message: &str, source: &str, level: Level, request_id: Option<String>, user_id: Option<String>, fields: Vec<(String, String)>, ) -> Result<(), GlobalError>

Write log with context information This function writes log messages with context information.

Parameters

• message: Message to be logged
• source: Source of the log
• request_id: Request ID
• user_id: User ID
• fields: Additional fields

Returns

Result indicating whether the operation was successful

Example

use tracing_core::Level;
use rustfs_obs::Logger;

async fn example(logger: &Logger) {
   let _ = logger.write_with_context("This is an information message", "example",Level::INFO, Some("req-12345".to_string()), Some("user-6789".to_string()), vec![("endpoint".to_string(), "/api/v1/data".to_string())]).await;
}

pub async fn write( &self, message: &str, source: &str, level: Level, ) -> Result<(), GlobalError>

Write log This function writes log messages.

Parameters

• message: Message to be logged
• source: Source of the log
• level: Log level

Returns

Result indicating whether the operation was successful

Example

use rustfs_obs::Logger;
use tracing_core::Level;

async fn example(logger: &Logger) {
  let _ = logger.write("This is an information message", "example", Level::INFO).await;
}

pub async fn shutdown(self) -> Result<(), GlobalError>

Shutdown the logger This function shuts down the logger.

Returns

Result indicating whether the operation was successful

Example

use rustfs_obs::Logger;

async fn example(logger: Logger) {
 let _ = logger.shutdown().await;
}

Trait Implementations

impl Debug for Logger

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

Formats the value using the given formatter.