Create Glog Exporter (#1929)

Summary:

Stack context:
```
Our tracing subscriber has 3 layers:
- File logging
- Scuba
- Sqlite (usually off)

Although the actual Scuba logging is done in a background thread and we are using a non-blocking file writer, we still have a good chunk of work that happens for events & spans. The solution to this, is to create a `UnifiedLayer` that just sends everything into a background worker, that then delivers all traces to each `Exporter` to handle.

In this diff, we will create an initial `UnifiedLayer` and incrementally move each existing layer into an `Exporter`.

To test correctness, we will run both the old and unified implementations for initializing telemetry on a variety of workloads, and ensure that both are producing the same results
```

In this diff we will create an `Exporter` meant to replace `file_layer` and update our correctness test to ensure that files produced by both the existing and the new implementation are the same

Differential Revision: D87363775

Author: thomasywang

hyperactor_telemetry/benches/correctness_test.rs

@@ -9,17 +9,22 @@
 //! Correctness test harness comparing old vs unified telemetry implementations.
 //!
 //! This test harness runs identical workloads through both implementations and
-//! verifies that the outputs are equivalent across all exporters
+//! verifies that the outputs are equivalent across all exporters:
+//! - Glog: Read log files and compare lines
 //!
 //! Usage:
 //!   buck2 run //monarch/hyperactor_telemetry:correctness_test
 
 #![allow(clippy::disallowed_methods)] // don't want to take a dependency on `hyperactor`` just for `hyperactor::clock::Clock`
 
+use std::path::PathBuf;
+
 use anyhow::Result;
 use hyperactor_telemetry::*;
 
-struct TestResults {}
+struct TestResults {
+    glog_path: Option<PathBuf>,
+}
 
 struct CorrectnessTestHarness {}
 
@@ -37,7 +42,104 @@ impl CorrectnessTestHarness {
 
         std::thread::sleep(std::time::Duration::from_millis(300));
 
-        Ok(TestResults {})
+        Ok(TestResults {
+            glog_path: Self::find_glog_path(),
+        })
+    }
+
+    fn find_glog_path() -> Option<PathBuf> {
+        let username = whoami::username();
+        let suffix = std::env::var(hyperactor_telemetry::MONARCH_LOG_SUFFIX_ENV)
+            .map(|s| format!("_{}", s))
+            .unwrap_or_default();
+        let possible_paths = vec![
+            format!("/tmp/{}/monarch_log{}.log", username, suffix),
+            format!("/tmp/monarch_log{}.log", suffix),
+            format!("/logs/dedicated_log_monarch{}.log", suffix),
+        ];
+
+        for path in possible_paths {
+            if std::path::Path::new(&path).exists() {
+                return Some(PathBuf::from(path));
+            }
+        }
+        None
+    }
+
+    /// Normalize a glog line by removing timestamp, thread ID, file:line, and prefix for comparison.
+    /// Both old and unified implementations should now use the same format:
+    /// "[prefix]Lmmdd HH:MM:SS.ffffff thread_id file:line] message, fields"
+    ///
+    /// Normalized to: "L] message, fields" (prefix removed)
+    fn normalize_glog_line(line: &str) -> String {
+        // Find the level character position
+        if let Some(level_pos) = line
+            .chars()
+            .position(|c| matches!(c, 'I' | 'D' | 'E' | 'W' | 'T'))
+        {
+            // Find the closing bracket that comes AFTER the level character (not the one in the prefix)
+            if let Some(close_bracket) = line[level_pos..].find(']') {
+                let actual_bracket_pos = level_pos + close_bracket;
+                let level = &line[level_pos..=level_pos]; // e.g., "I"
+                let rest = &line[actual_bracket_pos + 1..].trim_start(); // Everything after the real "]"
+                // Don't include prefix - just level + content
+                return format!("{}] {}", level, rest);
+            }
+        }
+
+        line.to_string()
+    }
+
+    fn compare_glog_files(&self, old_file: &PathBuf, unified_file: &PathBuf) -> Result<()> {
+        println!("\n[Comparing Glog Files]");
+        println!("  Old: {}", old_file.display());
+        println!("  Unified: {}", unified_file.display());
+
+        let old_content = std::fs::read_to_string(old_file)?;
+        let unified_content = std::fs::read_to_string(unified_file)?;
+
+        println!("  Old lines: {}", old_content.lines().count());
+        println!("  Unified lines: {}", unified_content.lines().count());
+
+        let old_lines: Vec<String> = old_content.lines().map(Self::normalize_glog_line).collect();
+
+        let unified_lines: Vec<String> = unified_content
+            .lines()
+            .map(Self::normalize_glog_line)
+            .collect();
+
+        if old_lines.len() != unified_lines.len() {
+            return Err(anyhow::anyhow!(
+                "Line count mismatch: old={} unified={}",
+                old_lines.len(),
+                unified_lines.len()
+            ));
+        }
+
+        let skip_lines = 1;
+
+        for (i, (old_line, unified_line)) in old_lines
+            .iter()
+            .zip(unified_lines.iter())
+            .enumerate()
+            .skip(skip_lines)
+        {
+            if old_line != unified_line {
+                return Err(anyhow::anyhow!(
+                    "Line #{} mismatch:\n  old:     {}\n  unified: {}",
+                    i,
+                    old_line,
+                    unified_line
+                ));
+            }
+        }
+
+        println!(
+            "  ✓ All {} lines match (skipped {} initialization lines)!",
+            old_lines.len() - skip_lines,
+            skip_lines
+        );
+        Ok(())
     }
 }
 
@@ -140,10 +242,15 @@ fn main() -> Result<()> {
         let mut test_passed = true;
 
         println!("\n[Running OLD implementation...]");
+        let old_log_suffix = format!("{}_old", test_name);
         let old_status = std::process::Command::new(&args[0])
             .arg(test_name)
             .arg("--old")
             .env("TEST_LOG_PREFIX", "test")
+            .env(
+                hyperactor_telemetry::MONARCH_LOG_SUFFIX_ENV,
+                &old_log_suffix,
+            )
             .status()?;
 
         if !old_status.success() {
@@ -153,10 +260,15 @@ fn main() -> Result<()> {
         }
 
         println!("\n[Running UNIFIED implementation...]");
+        let unified_log_suffix = format!("{}_unified", test_name);
         let unified_status = std::process::Command::new(&args[0])
             .arg(test_name)
             .arg("--unified")
             .env("TEST_LOG_PREFIX", "test")
+            .env(
+                hyperactor_telemetry::MONARCH_LOG_SUFFIX_ENV,
+                &unified_log_suffix,
+            )
             .status()?;
 
         if !unified_status.success() {
@@ -165,11 +277,46 @@ fn main() -> Result<()> {
             test_passed = false;
         }
 
+        let username = whoami::username();
+        let harness = CorrectnessTestHarness {};
+
+        // Compare glog files
+        let old_log = PathBuf::from(format!("/tmp/{}/test_{}_old.log", username, test_name));
+        let unified_log =
+            PathBuf::from(format!("/tmp/{}/test_{}_unified.log", username, test_name));
+
+        if !old_log.exists() || !unified_log.exists() {
+            println!("\n⚠ Glog files not found, skipping comparison");
+            if !old_log.exists() {
+                println!("  Missing: {}", old_log.display());
+            }
+            if !unified_log.exists() {
+                println!("  Missing: {}", unified_log.display());
+            }
+            all_passed = false;
+            test_passed = false;
+        } else {
+            match harness.compare_glog_files(&old_log, &unified_log) {
+                Ok(()) => {
+                    println!("\n✓ Glog files match");
+                }
+                Err(e) => {
+                    println!("\n✗ Glog comparison FAILED: {}", e);
+                    all_passed = false;
+                    test_passed = false;
+                }
+            }
+        }
+
         if test_passed {
             println!("\n✓ Test PASSED: {}", test_name_to_display(test_name));
         } else {
             println!("\n✗ Test FAILED: {}", test_name_to_display(test_name));
         }
+
+        // Clean up test files
+        let _ = std::fs::remove_file(&old_log);
+        let _ = std::fs::remove_file(&unified_log);
     }
 
     println!("\n\n{}", "=".repeat(80));
@@ -186,6 +333,32 @@ fn main() -> Result<()> {
 
 /// Called in child process
 fn run_single_test(test_name: &str, impl_type: &str) -> Result<()> {
+    let impl_suffix = if impl_type == "--old" {
+        "old"
+    } else {
+        "unified"
+    };
+    let log_suffix = format!("{}_{}", test_name, impl_suffix);
+    let username = whoami::username();
+    let possible_log_paths = vec![
+        format!("/tmp/{}/monarch_log_{}.log", username, log_suffix),
+        format!("/tmp/monarch_log_{}.log", log_suffix),
+        format!("/logs/dedicated_log_monarch_{}.log", log_suffix),
+    ];
+
+    for path in &possible_log_paths {
+        if std::path::Path::new(path).exists() {
+            let _ = std::fs::remove_file(path);
+            println!("Cleaned up existing log file: {}", path);
+        }
+    }
+
+    let target_log_copy = format!("/tmp/{}/test_{}_{}.log", username, test_name, impl_suffix);
+    if std::path::Path::new(&target_log_copy).exists() {
+        let _ = std::fs::remove_file(&target_log_copy);
+        println!("Cleaned up existing copy file: {}", target_log_copy);
+    }
+
     let harness = CorrectnessTestHarness {};
 
     let workload: fn() = match test_name {
@@ -200,7 +373,7 @@ fn run_single_test(test_name: &str, impl_type: &str) -> Result<()> {
         }
     };
 
-    let _results = match impl_type {
+    let results = match impl_type {
         "--old" => {
             println!("Running with OLD implementation...");
             harness.run(workload)?
@@ -222,6 +395,13 @@ fn run_single_test(test_name: &str, impl_type: &str) -> Result<()> {
         }
     };
 
+    if let Some(glog_path) = results.glog_path {
+        let target_path = format!("/tmp/{}/test_{}_{}.log", username, test_name, impl_suffix);
+
+        std::fs::copy(&glog_path, &target_path)?;
+        println!("Glog file copied to: {}", target_path);
+    }
+
     Ok(())
 }