Skip to content

Commit ee19a2e

Browse files
authored
docs(stackable-telemetry): Add missing env vars to doc comment (#1016)
* docs(stackable-telemetry): Add missing env vars to doc comment * docs: Simplify warning in doc comment * docs: Add notice about clap feature in doc comment
1 parent ecadb8e commit ee19a2e

File tree

1 file changed

+19
-8
lines changed
  • crates/stackable-telemetry/src/tracing

1 file changed

+19
-8
lines changed

crates/stackable-telemetry/src/tracing/mod.rs

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! This module contains functionality to initialise tracing Subscribers for
1+
//! This module contains functionality to initialize tracing Subscribers for
22
//! console output, file output, and OpenTelemetry OTLP export for traces and logs.
33
//!
44
//! It is intended to be used by the Stackable Data Platform operators and
@@ -72,8 +72,10 @@ pub enum Error {
7272
/// to hold onto the guard as long as required.
7373
///
7474
/// <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
7677
/// immediately.
78+
///
7779
/// </div>
7880
///
7981
/// ```
@@ -219,26 +221,35 @@ pub enum Error {
219221
///
220222
/// ## Environment Variables and CLI Arguments
221223
///
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+
///
222231
/// ### Console logs
223232
///
224233
/// - `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.
225235
/// - `CONSOLE_LOG_LEVEL`: Set the log level for the console logs.
226236
///
227237
/// ### File logs
228238
///
229239
/// - `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.
232243
///
233244
/// ### OTEL logs
234245
///
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.
237248
///
238249
/// ### OTEL traces
239250
///
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.
242253
///
243254
/// # Additional Configuration
244255
///

0 commit comments

Comments
 (0)