Skip to content

docs(stackable-telemetry): Add missing env vars to doc comment #1016

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 22, 2025
Merged

docs(stackable-telemetry): Add missing env vars to doc comment #1016

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d956cc6
docs(stackable-telemetry): Add missing env vars to doc comment
Techassi Apr 22, 2025
eb61dcc
docs: Simplify warning in doc comment
Techassi Apr 22, 2025
367580c
docs: Add notice about clap feature in doc comment
Techassi Apr 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 19 additions & 8 deletions crates/stackable-telemetry/src/tracing/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -72,8 +72,10 @@ pub enum Error {
/// to hold onto the guard as long as required.
///
/// <div class="warning">
/// Name the guard variable appropriately, do not just use <code>let _ =</code>, as that will drop
///
/// Name the guard variable appropriately, do not just use `let _ = ...`, as that will drop
/// immediately.
///
/// </div>
///
/// ```
Expand Down Expand Up @@ -219,26 +221,35 @@ pub enum Error {
///
/// ## Environment Variables and CLI Arguments
///
/// <div class="warning">
///
/// It should be noted that the CLI arguments (listed in parentheses) are only available when the
/// `clap` feature is enabled.
///
/// </div>
///
/// ### 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
///
Expand Down