refactor!: Adjust CLI surface

Due to initialize_logging being removed and being replaced by
stackable_telemetry, the CLI interface needs to be adjusted as well.
The old --tracing-target argument is removed in favour of more
granular arguments to enable different outputs and exporters.

Author: Techassi

crates/stackable-operator/CHANGELOG.md

@@ -4,6 +4,23 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+### Added
+
+- Add more granular telemetry related arguments to `ProductOperatorRun` ([#977]).
+  - `--enable-console-output`: Enables output of `tracing` events to the console (stdout)
+  - `--enable-file-output`: Enables output `tracing` events to a rotating log file
+  - `--enable-otlp-traces`: Enables exporting of traces via OTLP
+  - `--enable-otlp-logs`: Enables exporting of logs via OTLP
+
+### Removed
+
+- BREAKING: Remove `--tracing-target` argument and field from `ProductOperatorRun`.
+  Use the new, more granular arguments instead ([#977]).
+- BREAKING: Remove `initialize_logging` helper function from `stackable_operator::logging` ([#977]).
+- Remove `opentelemetry-jaeger` dependency ([#977]).
+
+[#977]: https://github.com/stackabletech/operator-rs/pull/977
+
 ## [0.87.3] - 2025-03-14
 
 ### Added
@@ -48,7 +65,7 @@ All notable changes to this project will be documented in this file.
 
 ### Added
 
-- BREAKING: Add `region` field to S3ConnectionSpec (defaults to `us-east-1`) ([#959]).
+- Add `region` field to S3ConnectionSpec ([#959]).
 
 [#959]: https://github.com/stackabletech/operator-rs/pull/959
 

crates/stackable-operator/src/cli.rs

@@ -115,10 +115,7 @@ use clap::Args;
 use product_config::ProductConfigManager;
 use snafu::{ResultExt, Snafu};
 
-use crate::{
-    logging::TracingTarget, namespace::WatchNamespace,
-    utils::cluster_info::KubernetesClusterInfoOpts,
-};
+use crate::{namespace::WatchNamespace, utils::cluster_info::KubernetesClusterInfoOpts};
 
 pub const AUTHOR: &str = "Stackable GmbH - info@stackable.tech";
 
@@ -217,9 +214,8 @@ pub struct ProductOperatorRun {
     #[arg(long, env, default_value = "")]
     pub watch_namespace: WatchNamespace,
 
-    /// Tracing log collector system
-    #[arg(long, env, default_value_t, value_enum)]
-    pub tracing_target: TracingTarget,
+    #[command(flatten)]
+    pub telemetry_arguments: TelemetryArguments,
 
     #[command(flatten)]
     pub cluster_info_opts: KubernetesClusterInfoOpts,
@@ -245,41 +241,58 @@ impl ProductConfigPath {
     /// Load the [`ProductConfigManager`] from the given path, falling back to the first
     /// path that exists from `default_search_paths` if none is given by the user.
     pub fn load(&self, default_search_paths: &[impl AsRef<Path>]) -> Result<ProductConfigManager> {
-        ProductConfigManager::from_yaml_file(resolve_path(
-            self.path.as_deref(),
-            default_search_paths,
-        )?)
-        .context(ProductConfigLoadSnafu)
+        let resolved_path = Self::resolve_path(self.path.as_deref(), default_search_paths)?;
+        ProductConfigManager::from_yaml_file(resolved_path).context(ProductConfigLoadSnafu)
     }
-}
 
-/// Check if the path can be found anywhere:
-/// 1) User provides path `user_provided_path` to file -> 'Error' if not existing.
-/// 2) User does not provide path to file -> search in `default_paths` and
-///    take the first existing file.
-/// 3) `Error` if nothing was found.
-fn resolve_path<'a>(
-    user_provided_path: Option<&'a Path>,
-    default_paths: &'a [impl AsRef<Path> + 'a],
-) -> Result<&'a Path> {
-    // Use override if specified by the user, otherwise search through defaults given
-    let search_paths = if let Some(path) = user_provided_path {
-        vec![path]
-    } else {
-        default_paths.iter().map(|path| path.as_ref()).collect()
-    };
-    for path in &search_paths {
-        if path.exists() {
-            return Ok(path);
+    /// Check if the path can be found anywhere
+    ///
+    /// 1. User provides path `user_provided_path` to file. Return [`Error`] if not existing.
+    /// 2. User does not provide path to file -> search in `default_paths` and
+    ///    take the first existing file.
+    /// 3. Return [`Error`] if nothing was found.
+    fn resolve_path<'a>(
+        user_provided_path: Option<&'a Path>,
+        default_paths: &'a [impl AsRef<Path> + 'a],
+    ) -> Result<&'a Path> {
+        // Use override if specified by the user, otherwise search through defaults given
+        let search_paths = if let Some(path) = user_provided_path {
+            vec![path]
+        } else {
+            default_paths.iter().map(|path| path.as_ref()).collect()
+        };
+        for path in &search_paths {
+            if path.exists() {
+                return Ok(path);
+            }
         }
+        RequiredFileMissingSnafu {
+            search_path: search_paths
+                .into_iter()
+                .map(PathBuf::from)
+                .collect::<Vec<_>>(),
+        }
+        .fail()
     }
-    RequiredFileMissingSnafu {
-        search_path: search_paths
-            .into_iter()
-            .map(PathBuf::from)
-            .collect::<Vec<_>>(),
-    }
-    .fail()
+}
+
+#[derive(Debug, Default, PartialEq, Eq, Args)]
+pub struct TelemetryArguments {
+    /// Disable console output.
+    #[arg(long, env)]
+    no_console_output: bool,
+
+    /// Enable logging to rolling files located in the specified directory
+    #[arg(long, env, value_name = "DIRECTORY")]
+    rolling_logs: Option<PathBuf>,
+
+    /// Enable exporting traces via OTLP.
+    #[arg(long, env)]
+    otlp_traces: bool,
+
+    /// Enable exporting logs via OTLP.
+    #[arg(long, env)]
+    otlp_logs: bool,
 }
 
 #[cfg(test)]
@@ -300,6 +313,7 @@ mod tests {
     #[test]
     fn verify_cli() {
         use clap::CommandFactory;
+        ProductOperatorRun::command().print_long_help().unwrap();
         ProductOperatorRun::command().debug_assert()
     }
 
@@ -342,7 +356,7 @@ mod tests {
 
         let file = File::create(full_path_to_create).expect("create temporary file");
 
-        let found_path = resolve_path(
+        let found_path = ProductConfigPath::resolve_path(
             full_user_provided_path.as_deref(),
             &full_default_locations_ref,
         )?;
@@ -358,13 +372,14 @@ mod tests {
     #[test]
     #[should_panic]
     fn resolve_path_user_path_not_existing() {
-        resolve_path(Some(USER_PROVIDED_PATH.as_ref()), &[DEPLOY_FILE_PATH]).unwrap();
+        ProductConfigPath::resolve_path(Some(USER_PROVIDED_PATH.as_ref()), &[DEPLOY_FILE_PATH])
+            .unwrap();
     }
 
     #[test]
     fn resolve_path_nothing_found_errors() {
         if let Err(Error::RequiredFileMissing { search_path }) =
-            resolve_path(None, &[DEPLOY_FILE_PATH, DEFAULT_FILE_PATH])
+            ProductConfigPath::resolve_path(None, &[DEPLOY_FILE_PATH, DEFAULT_FILE_PATH])
         {
             assert_eq!(
                 search_path,
@@ -396,8 +411,8 @@ mod tests {
             ProductOperatorRun {
                 product_config: ProductConfigPath::from("bar".as_ref()),
                 watch_namespace: WatchNamespace::One("foo".to_string()),
-                tracing_target: TracingTarget::None,
                 cluster_info_opts: Default::default(),
+                telemetry_arguments: Default::default(),
             }
         );
 
@@ -408,8 +423,8 @@ mod tests {
             ProductOperatorRun {
                 product_config: ProductConfigPath::from("bar".as_ref()),
                 watch_namespace: WatchNamespace::All,
-                tracing_target: TracingTarget::None,
                 cluster_info_opts: Default::default(),
+                telemetry_arguments: Default::default(),
             }
         );
 
@@ -421,8 +436,8 @@ mod tests {
             ProductOperatorRun {
                 product_config: ProductConfigPath::from("bar".as_ref()),
                 watch_namespace: WatchNamespace::One("foo".to_string()),
-                tracing_target: TracingTarget::None,
                 cluster_info_opts: Default::default(),
+                telemetry_arguments: Default::default(),
             }
         );
     }