diff --git a/crates/stackable-telemetry/src/tracing/mod.rs b/crates/stackable-telemetry/src/tracing/mod.rs index 0d4562be..0fcb36a9 100644 --- a/crates/stackable-telemetry/src/tracing/mod.rs +++ b/crates/stackable-telemetry/src/tracing/mod.rs @@ -1,4 +1,4 @@ -//! This module contains functionality to initialise tracing Subscribers for +//! This module contains functionality to initialize tracing Subscribers for //! console output, file output, and OpenTelemetry OTLP export for traces and logs. //! //! It is intended to be used by the Stackable Data Platform operators and @@ -72,8 +72,10 @@ pub enum Error { /// to hold onto the guard as long as required. /// ///
-/// Name the guard variable appropriately, do not just use let _ =, as that will drop +/// +/// Name the guard variable appropriately, do not just use `let _ = ...`, as that will drop /// immediately. +/// ///
/// /// ``` @@ -219,26 +221,35 @@ pub enum Error { /// /// ## Environment Variables and CLI Arguments /// +///
+/// +/// It should be noted that the CLI arguments (listed in parentheses) are only available when the +/// `clap` feature is enabled. +/// +///
+/// /// ### Console logs /// /// - `CONSOLE_LOG_DISABLED` (`--console-log-disabled`): Disables console logs when set to `true`. +/// - `CONSOLE_LOG_FORMAT` (`--console-log-format`): Set the format for the console logs. /// - `CONSOLE_LOG_LEVEL`: Set the log level for the console logs. /// /// ### File logs /// /// - `FILE_LOG_DIRECTORY` (`--file-log-directory`): Enable the file logs and set the file log directory. -/// - `FILE_LOG_ROTATION_PERIOD` (`--file-log-rotation-period`): Set the rotation period of log files -/// - `FILE_LOG_LEVEL`: Set the log level for file logs +/// - `FILE_LOG_ROTATION_PERIOD` (`--file-log-rotation-period`): Set the rotation period of log files. +/// - `FILE_LOG_MAX_FILES` (`--file-log-max-files`): Set the maximum number of log files to keep. +/// - `FILE_LOG_LEVEL`: Set the log level for file logs. /// /// ### OTEL logs /// -/// - `OTEL_LOG_EXPORTER_ENABLED` (`--otel-log-exporter-enabled`): Enable exporting OTEL logs -/// - `OTEL_LOG_EXPORTER_LEVEL`: Set the log level for OTEL logs +/// - `OTEL_LOG_EXPORTER_ENABLED` (`--otel-log-exporter-enabled`): Enable exporting OTEL logs. +/// - `OTEL_LOG_EXPORTER_LEVEL`: Set the log level for OTEL logs. /// /// ### OTEL traces /// -/// - `OTEL_TRACE_EXPORTER_ENABLED` (`--otel-trace-exporter-enabled`): Enable exporting OTEL traces -/// - `OTEL_TRACE_EXPORTER_LEVEL`: Set the log level for OTEL traces +/// - `OTEL_TRACE_EXPORTER_ENABLED` (`--otel-trace-exporter-enabled`): Enable exporting OTEL traces. +/// - `OTEL_TRACE_EXPORTER_LEVEL`: Set the log level for OTEL traces. /// /// # Additional Configuration ///