oxlog: Glob match zone names

`oxlog logs` currently requires a precise match for the zone name. This
is inconvenient when attempting to search across multiple zones with
similar names. For example, when searching all Crucible downstairs, or
using Pilot to query Nexus logs on multiple sleds.

Use the `glob` crate to take a pattern to match against the zone name
for the `services` and `logs` subcommands, potentially allowing multiple
zones to be returned. If more than one zone is matched, then the logs
and services will be sorted globally.

Example usage:

  $ oxlog services 'oxz_crucible_[!p]*' # All non-pantry Crucible zones
  $ oxlog logs 'oxz_nexus_*' --current  # The nexus zone

Author: wfchandler

Cargo.lock

@@ -12,6 +12,7 @@ anyhow.workspace = true
 camino.workspace = true
 chrono.workspace = true
 clap.workspace = true
+glob.workspace = true
 jiff.workspace = true
 sigpipe.workspace = true
 uuid.workspace = true

dev-tools/oxlog/Cargo.toml

@@ -5,11 +5,13 @@
 //! Tool for discovering oxide related logfiles on sleds
 
 use clap::{ArgAction, Args, Parser, Subcommand};
+use glob::Pattern;
 use jiff::civil::DateTime;
 use jiff::tz::TimeZone;
 use jiff::{Span, Timestamp};
 use oxlog::{DateRange, Filter, LogFile, Zones};
 use std::collections::BTreeSet;
+use std::str::FromStr;
 
 #[derive(Debug, Parser)]
 #[command(version)]
@@ -25,8 +27,8 @@ enum Commands {
 
     /// List logs for a given service
     Logs {
-        /// The name of the zone
-        zone: String,
+        /// The glob pattern to match against zone names
+        zone_glob: GlobPattern,
 
         /// The name of the service to list logs for
         service: Option<String>,
@@ -49,15 +51,26 @@ enum Commands {
         after: Option<Timestamp>,
     },
 
-    /// List the names of all services in a zone, from the perspective of oxlog.
+    /// List the names of all services in matching zones, from the perspective of oxlog.
     /// Use these names with `oxlog logs` to filter output to logs from a
     /// specific service.
     Services {
-        /// The name of the zone
-        zone: String,
+        /// The glob pattern to match against zone names
+        zone_glob: GlobPattern,
     },
 }
 
+#[derive(Clone, Debug)]
+struct GlobPattern(Pattern);
+
+impl FromStr for GlobPattern {
+    type Err = glob::PatternError;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        Pattern::new(s).map(GlobPattern)
+    }
+}
+
 #[derive(Args, Debug)]
 #[group(required = true, multiple = true)]
 struct FilterArgs {
@@ -118,7 +131,14 @@ fn main() -> Result<(), anyhow::Error> {
             }
             Ok(())
         }
-        Commands::Logs { zone, service, metadata, filter, before, after } => {
+        Commands::Logs {
+            zone_glob,
+            service,
+            metadata,
+            filter,
+            before,
+            after,
+        } => {
             let zones = Zones::load()?;
             let date_range = match (before, after) {
                 (None, None) => None,
@@ -145,7 +165,7 @@ fn main() -> Result<(), anyhow::Error> {
                 );
             };
 
-            let logs = zones.zone_logs(&zone, filter);
+            let logs = zones.zone_logs(&zone_glob.0, filter);
             for (svc_name, svc_logs) in logs {
                 if let Some(service) = &service {
                     if svc_name != service.as_str() {
@@ -182,7 +202,7 @@ fn main() -> Result<(), anyhow::Error> {
             }
             Ok(())
         }
-        Commands::Services { zone } => {
+        Commands::Services { zone_glob } => {
             let zones = Zones::load()?;
 
             // We want all logs that exist, anywhere, so we can find their
@@ -198,7 +218,7 @@ fn main() -> Result<(), anyhow::Error> {
             // Collect a unique set of services, based on the logs in the
             // specified zone
             let services: BTreeSet<String> =
-                zones.zone_logs(&zone, filter).into_keys().collect();
+                zones.zone_logs(&zone_glob.0, filter).into_keys().collect();
 
             for svc in services {
                 println!("{}", svc);

dev-tools/oxlog/src/bin/oxlog.rs

@@ -8,6 +8,7 @@
 
 use anyhow::Context;
 use camino::{Utf8DirEntry, Utf8Path, Utf8PathBuf};
+use glob::Pattern;
 use jiff::Timestamp;
 use std::collections::BTreeMap;
 use std::io;
@@ -302,47 +303,48 @@ impl Zones {
         Ok(Zones { zones })
     }
 
-    /// Return log files organized by service name
+    /// Return log files for all matching zone names organized by service name
     pub fn zone_logs(
         &self,
-        zone: &str,
+        zone_pattern: &Pattern,
         filter: Filter,
     ) -> BTreeMap<ServiceName, SvcLogs> {
         let mut output = BTreeMap::new();
-        let Some(paths) = self.zones.get(zone) else {
-            return BTreeMap::new();
-        };
-        // Some rotated files exist in `paths.primary` that we track as
-        // 'archived'. These files have not yet been migrated into the debug
-        // directory.
-        if filter.current || filter.archived {
-            load_svc_logs(
-                paths.primary.clone(),
-                &mut output,
-                filter.show_empty,
-                filter.date_range,
-            );
-        }
-
-        if filter.archived {
-            for dir in paths.debug.clone() {
+        for (_, paths) in
+            self.zones.iter().filter(|(zone, _)| zone_pattern.matches(zone))
+        {
+            // Some rotated files exist in `paths.primary` that we track as
+            // 'archived'. These files have not yet been migrated into the debug
+            // directory.
+            if filter.current || filter.archived {
                 load_svc_logs(
-                    dir,
+                    paths.primary.clone(),
                     &mut output,
                     filter.show_empty,
                     filter.date_range,
                 );
             }
-        }
-        if filter.extra {
-            for (svc_name, dir) in paths.extra.clone() {
-                load_extra_logs(
-                    dir,
-                    svc_name,
-                    &mut output,
-                    filter.show_empty,
-                    filter.date_range,
-                );
+
+            if filter.archived {
+                for dir in paths.debug.clone() {
+                    load_svc_logs(
+                        dir,
+                        &mut output,
+                        filter.show_empty,
+                        filter.date_range,
+                    );
+                }
+            }
+            if filter.extra {
+                for (svc_name, dir) in paths.extra.clone() {
+                    load_extra_logs(
+                        dir,
+                        svc_name,
+                        &mut output,
+                        filter.show_empty,
+                        filter.date_range,
+                    );
+                }
             }
         }