chore: fulfill comments

Signed-off-by: MrCroxx <[email protected]>
risingwavelabs · Jul 4, 2024 · 0111559 · 0111559
1 parent bcee450
commit 0111559
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/utils/runtime/src/logger.rs b/src/utils/runtime/src/logger.rs
@@ -511,6 +511,15 @@ pub fn init_risingwave_logger(settings: LoggerSettings) {
 
         layers.push(layer.boxed());
 
+        // The reporter is used by minitrace in foyer for dynamically tail-based tracing.
+        //
+        // Code here only setup the OpenTelemetry reporter. To enable/disable the function, please use risectl.
+        //
+        // e.g.
+        //
+        // ```bash
+        // risectl hummock tiered-cache-tracing -h
+        // ```
         let reporter = OpenTelemetryReporter::new(
             exporter,
             SpanKind::Server,