1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
mod compare;
mod filter;
mod merge_compact;
mod migrate;
mod print;
mod route;
mod stats;
mod verify;
// ---
use anyhow::Context as _;
use clap::Subcommand;
use self::compare::CompareCommand;
use self::filter::FilterCommand;
use self::merge_compact::{CompactCommand, MergeCommand};
use self::migrate::MigrateCommand;
use self::print::PrintCommand;
use self::route::RouteCommand;
use self::stats::StatsCommand;
use self::verify::VerifyCommand;
/// Manipulate the contents of .rrd and .rbl files.
#[derive(Debug, Clone, Subcommand)]
pub enum RrdCommands {
/// Compacts the contents of one or more .rrd/.rbl files/streams and writes the result standard output.
///
/// Reads from standard input if no paths are specified.
///
/// Uses the usual environment variables to control the compaction thresholds:
/// `RERUN_CHUNK_MAX_ROWS`,
/// `RERUN_CHUNK_MAX_ROWS_IF_UNSORTED`,
/// `RERUN_CHUNK_MAX_BYTES`.
///
/// Unless explicit flags are passed, in which case they will override environment values.
///
/// ⚠️ This will automatically migrate the data to the latest version of the RRD protocol, if needed. ⚠️
///
/// Examples:
///
/// * `RERUN_CHUNK_MAX_ROWS=4096 RERUN_CHUNK_MAX_BYTES=1048576 rerun rrd compact /my/recordings/*.rrd -o output.rrd`
///
/// * `rerun rrd compact --max-rows 4096 --max-bytes=1048576 /my/recordings/*.rrd > output.rrd`
Compact(CompactCommand),
/// Compares the data between 2 .rrd files, returning a successful shell exit code if they
/// match.
///
/// This ignores the `log_time` timeline.
Compare(CompareCommand),
/// Filters out data from .rrd/.rbl files/streams, and writes the result to standard output.
///
/// Reads from standard input if no paths are specified.
///
/// This will not affect the chunking of the data in any way.
///
/// Example: `rerun rrd filter --drop-timeline log_tick /my/recordings/*.rrd > output.rrd`
Filter(FilterCommand),
/// Merges the contents of multiple .rrd/.rbl files/streams, and writes the result to standard output.
///
/// Reads from standard input if no paths are specified.
///
/// ⚠️ This will automatically migrate the data to the latest version of the RRD protocol, if needed. ⚠️
///
/// Example: `rerun rrd merge /my/recordings/*.rrd > output.rrd`
Merge(MergeCommand),
/// Migrate one or more .rrd files to the newest Rerun version.
///
/// Example: `rerun rrd migrate foo.rrd`
/// Results in a `foo.backup.rrd` (copy of the old file) and a new `foo.rrd` (migrated).
Migrate(MigrateCommand),
/// Print the contents of one or more .rrd/.rbl files/streams.
///
/// Reads from standard input if no paths are specified.
///
/// Example: `rerun rrd print /my/recordings/*.rrd`
Print(PrintCommand),
/// Manipulates the metadata of log message streams without decoding the payloads.
///
/// This can be used to combine multiple .rrd files into a single recording.
/// Example: `rerun rrd route --recording-id my_recording /my/recordings/*.rrd > output.rrd`
///
/// Note: Because the payload of the messages is never decoded, no migration or verification will performed.
Route(RouteCommand),
/// Compute important statistics for one or more .rrd/.rbl files/streams.
///
/// Reads from standard input if no paths are specified.
///
/// Example: `rerun rrd stats /my/recordings/*.rrd`
Stats(StatsCommand),
/// Verify the that the .rrd file can be loaded and correctly interpreted.
///
/// Can be used to ensure that the current Rerun version can load the data.
Verify(VerifyCommand),
}
impl RrdCommands {
pub fn run(self) -> anyhow::Result<()> {
match self {
Self::Compare(cmd) => {
cmd.run()
// Print current directory, this can be useful for debugging issues with relative paths.
.with_context(|| format!("current directory {:?}", std::env::current_dir()))
}
Self::Compact(cmd) => cmd.run(),
Self::Filter(cmd) => cmd.run(),
Self::Merge(cmd) => cmd.run(),
Self::Migrate(cmd) => cmd.run(),
Self::Print(cmd) => cmd.run(),
Self::Route(cmd) => cmd.run(),
Self::Stats(cmd) => cmd.run(),
Self::Verify(cmd) => cmd.run(),
}
}
}