|
1 |
| -//! This module contains functionality to initialise tracing Subscribers for |
| 1 | +//! This module contains functionality to initialize tracing Subscribers for |
2 | 2 | //! console output, file output, and OpenTelemetry OTLP export for traces and logs.
|
3 | 3 | //!
|
4 | 4 | //! It is intended to be used by the Stackable Data Platform operators and
|
@@ -72,8 +72,10 @@ pub enum Error {
|
72 | 72 | /// to hold onto the guard as long as required.
|
73 | 73 | ///
|
74 | 74 | /// <div class="warning">
|
75 |
| -/// Name the guard variable appropriately, do not just use <code>let _ =</code>, as that will drop |
| 75 | +/// |
| 76 | +/// Name the guard variable appropriately, do not just use `let _ = ...`, as that will drop |
76 | 77 | /// immediately.
|
| 78 | +/// |
77 | 79 | /// </div>
|
78 | 80 | ///
|
79 | 81 | /// ```
|
@@ -219,26 +221,35 @@ pub enum Error {
|
219 | 221 | ///
|
220 | 222 | /// ## Environment Variables and CLI Arguments
|
221 | 223 | ///
|
| 224 | +/// <div class="warning"> |
| 225 | +/// |
| 226 | +/// It should be noted that the CLI arguments (listed in parentheses) are only available when the |
| 227 | +/// `clap` feature is enabled. |
| 228 | +/// |
| 229 | +/// </div> |
| 230 | +/// |
222 | 231 | /// ### Console logs
|
223 | 232 | ///
|
224 | 233 | /// - `CONSOLE_LOG_DISABLED` (`--console-log-disabled`): Disables console logs when set to `true`.
|
| 234 | +/// - `CONSOLE_LOG_FORMAT` (`--console-log-format`): Set the format for the console logs. |
225 | 235 | /// - `CONSOLE_LOG_LEVEL`: Set the log level for the console logs.
|
226 | 236 | ///
|
227 | 237 | /// ### File logs
|
228 | 238 | ///
|
229 | 239 | /// - `FILE_LOG_DIRECTORY` (`--file-log-directory`): Enable the file logs and set the file log directory.
|
230 |
| -/// - `FILE_LOG_ROTATION_PERIOD` (`--file-log-rotation-period`): Set the rotation period of log files |
231 |
| -/// - `FILE_LOG_LEVEL`: Set the log level for file logs |
| 240 | +/// - `FILE_LOG_ROTATION_PERIOD` (`--file-log-rotation-period`): Set the rotation period of log files. |
| 241 | +/// - `FILE_LOG_MAX_FILES` (`--file-log-max-files`): Set the maximum number of log files to keep. |
| 242 | +/// - `FILE_LOG_LEVEL`: Set the log level for file logs. |
232 | 243 | ///
|
233 | 244 | /// ### OTEL logs
|
234 | 245 | ///
|
235 |
| -/// - `OTEL_LOG_EXPORTER_ENABLED` (`--otel-log-exporter-enabled`): Enable exporting OTEL logs |
236 |
| -/// - `OTEL_LOG_EXPORTER_LEVEL`: Set the log level for OTEL logs |
| 246 | +/// - `OTEL_LOG_EXPORTER_ENABLED` (`--otel-log-exporter-enabled`): Enable exporting OTEL logs. |
| 247 | +/// - `OTEL_LOG_EXPORTER_LEVEL`: Set the log level for OTEL logs. |
237 | 248 | ///
|
238 | 249 | /// ### OTEL traces
|
239 | 250 | ///
|
240 |
| -/// - `OTEL_TRACE_EXPORTER_ENABLED` (`--otel-trace-exporter-enabled`): Enable exporting OTEL traces |
241 |
| -/// - `OTEL_TRACE_EXPORTER_LEVEL`: Set the log level for OTEL traces |
| 251 | +/// - `OTEL_TRACE_EXPORTER_ENABLED` (`--otel-trace-exporter-enabled`): Enable exporting OTEL traces. |
| 252 | +/// - `OTEL_TRACE_EXPORTER_LEVEL`: Set the log level for OTEL traces. |
242 | 253 | ///
|
243 | 254 | /// # Additional Configuration
|
244 | 255 | ///
|
|
0 commit comments