Crate rlg

RustLogs (RLG)

RustLogs (RLG) is a robust and flexible logging library for Rust applications. It provides a simple, readable output format and offers various features to enhance your application’s logging capabilities.

Features

• Multiple log levels: ALL, DEBUG, DISABLED, ERROR, FATAL, INFO, NONE, TRACE, VERBOSE, and WARN.
• Structured log formats for easy parsing and filtering.
• Support for multiple output formats including:
  • Common Event Format (CEF)
  • Extended Log Format (ELF)
  • Graylog Extended Log Format (GELF)
  • JavaScript Object Notation (JSON)
  • NCSA Common Log Format (CLF)
  • W3C Extended Log File Format (W3C)
  • Syslog Format
  • Apache Access Log Format
  • Logstash Format
  • Log4j XML Format
  • NDJSON (Newline Delimited JSON)
• Configurable logging destinations (file, stdout, network).
• Log rotation support.
• Asynchronous logging for improved performance.

Re-exports

• pub use config::Config;
• pub use config::LogRotation;
• pub use config::LoggingDestination;
• pub use log::Log;
• pub use log_format::LogFormat;
• pub use log_level::LogLevel;
• pub use error::RlgError;
• pub use error::RlgResult;
• pub use utils::generate_timestamp;
• pub use utils::sanitize_log_message;

Modules

• config
  Configuration module for RustLogs. Configuration module for RustLogs (RLG).
• error
  Error handling module
• log
  Core logging functionality.
• log_format
  Log format definitions and implementations.
• log_level
  Log level definitions and implementations.
• macros
  Macros for convenient logging.
• utils
  Utility functions module

Macros

• macro_debug_log
  This macro conditionally logs a debug message if the debug_enabled feature flag is set.
• macro_error_log
  This macro creates an ERROR level log entry with a default session ID and format. The session ID is generated randomly and the log format defaults to CLF.
• macro_fatal_log
  This macro creates a FATAL level log entry with a default session ID and format. The session ID is generated randomly and the log format defaults to CLF.
• macro_info_log
  This macro creates an INFO level log entry with a default session ID and format. The session ID is generated randomly and the log format defaults to CLF.
• macro_log
  This macro simplifies the creation of log entries with specific parameters. It returns a new Log instance based on the provided session ID, time, level, component, description, and format.
• macro_log_if
  This macro conditionally logs a message based on a predicate.
• macro_log_to_file
  This macro asynchronously logs a message to a file. It returns the result of the logging operation, which could be used to check the success or failure of the logging action.
• macro_log_with_metadata
  This macro logs with metadata. It replaces specific keys in the log message with consistent ones.
• macro_print_log
  This macro prints a log entry to the standard output (stdout). It is useful for debugging or simple logging to the console.
• macro_set_log_format_clf
  This macro sets the log format to CLF if it is not already defined.
• macro_trace_log
  This macro creates a TRACE level log entry with a default session ID and format. The session ID is generated randomly and the log format defaults to CLF.
• macro_warn_log
  This macro creates a WARN level log entry with a default session ID and format. The session ID is generated randomly and the log format defaults to CLF.

Constants

• VERSION
  The current version of the RustLogs crate.