Skip to content

oxlog: Glob match zone names #8008

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

oxlog: Glob match zone names #8008

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions dev-tools/oxlog/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ anyhow.workspace = true
camino.workspace = true
chrono.workspace = true
clap.workspace = true
glob.workspace = true
jiff.workspace = true
rayon.workspace = true
sigpipe.workspace = true
uuid.workspace = true
omicron-workspace-hack.workspace = true
Expand Down
106 changes: 71 additions & 35 deletions dev-tools/oxlog/src/bin/oxlog.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,18 @@
//! 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::num::NonZeroUsize;
use std::str::FromStr;

/// The number of threads to given to the Rayon thread pool.
/// The default thread-per-physical core is excessive on a Gimlet.
const MAX_THREADS: usize = 12;

#[derive(Debug, Parser)]
#[command(version)]
Expand All @@ -25,8 +32,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>,
Expand All @@ -49,15 +56,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 {
Expand Down Expand Up @@ -109,6 +127,12 @@ fn parse_timestamp(
fn main() -> Result<(), anyhow::Error> {
sigpipe::reset();

let num_threads = std::thread::available_parallelism()
.map(NonZeroUsize::get)
.unwrap_or(MAX_THREADS)
.min(MAX_THREADS);
rayon::ThreadPoolBuilder::new().num_threads(num_threads).build_global()?;

let cli = Cli::parse();

match cli.command {
Expand All @@ -118,7 +142,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,
Expand All @@ -145,44 +176,46 @@ fn main() -> Result<(), anyhow::Error> {
);
};

let logs = zones.zone_logs(&zone, filter);
for (svc_name, svc_logs) in logs {
if let Some(service) = &service {
if svc_name != service.as_str() {
continue;
let zones = zones.matching_zone_logs(&zone_glob.0, filter);
for logs in zones {
for (svc_name, svc_logs) in logs {
if let Some(service) = &service {
if svc_name != service.as_str() {
continue;
}
}
}
if filter.current {
if let Some(current) = &svc_logs.current {
if metadata {
print_metadata(current);
} else {
println!("{}", current.path);
if filter.current {
if let Some(current) = &svc_logs.current {
if metadata {
print_metadata(current);
} else {
println!("{}", current.path);
}
}
}
}
if filter.archived {
for f in &svc_logs.archived {
if metadata {
print_metadata(f);
} else {
println!("{}", f.path);
if filter.archived {
for f in &svc_logs.archived {
if metadata {
print_metadata(f);
} else {
println!("{}", f.path);
}
}
}
}
if filter.extra {
for f in &svc_logs.extra {
if metadata {
print_metadata(f);
} else {
println!("{}", f.path);
if filter.extra {
for f in &svc_logs.extra {
if metadata {
print_metadata(f);
} else {
println!("{}", f.path);
}
}
}
}
}
Ok(())
}
Commands::Services { zone } => {
Commands::Services { zone_glob } => {
let zones = Zones::load()?;

// We want all logs that exist, anywhere, so we can find their
Expand All @@ -197,8 +230,11 @@ 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();
let services: BTreeSet<String> = zones
.matching_zone_logs(&zone_glob.0, filter)
.into_iter()
.flat_map(|l| l.into_keys())
.collect();

for svc in services {
println!("{}", svc);
Expand Down
20 changes: 17 additions & 3 deletions dev-tools/oxlog/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@

use anyhow::Context;
use camino::{Utf8DirEntry, Utf8Path, Utf8PathBuf};
use glob::Pattern;
use jiff::Timestamp;
use rayon::prelude::*;
use std::collections::BTreeMap;
use std::io;
use uuid::Uuid;
Expand Down Expand Up @@ -186,8 +188,8 @@ impl SvcLogs {
/// scattered across several different directories -- and we care more
/// about filename than which directory they are in.
pub fn sort_by_file_name(&mut self) {
self.archived.sort_unstable_by(LogFile::file_name_cmp);
self.extra.sort_unstable_by(LogFile::file_name_cmp);
self.archived.par_sort_unstable_by(LogFile::file_name_cmp);
self.extra.par_sort_unstable_by(LogFile::file_name_cmp);
}
}

Expand Down Expand Up @@ -347,9 +349,21 @@ impl Zones {
}

sort_logs(&mut output);

output
}

/// Return log files for all zones whose names match `zone_pattern`
pub fn matching_zone_logs(
&self,
zone_pattern: &Pattern,
filter: Filter,
) -> Vec<BTreeMap<ServiceName, SvcLogs>> {
self.zones
.par_iter()
.filter(|(zone, _)| zone_pattern.matches(zone))
.map(|(zone, _)| self.zone_logs(zone, filter))
.collect()
}
}

fn sort_logs(output: &mut BTreeMap<String, SvcLogs>) {
Expand Down
Loading