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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
mod append;
mod format;
mod fs;
mod query;
mod rotate;
mod store;
use std::path::PathBuf;
use clap::{Parser, Subcommand};
#[derive(Parser)]
#[command(
name = "timberfs",
version,
about = "Append-only, transparently compressed, write-time-indexed filesystem for log files"
)]
struct Cli {
#[command(subcommand)]
command: Command,
}
#[derive(Subcommand)]
enum Command {
/// Mount a timberfs: files under MOUNTPOINT are stored compressed and
/// time-indexed in BACKING. Runs in the foreground; unmount with
/// fusermount3 -u MOUNTPOINT (or Ctrl-C if auto_unmount is active).
Mount {
/// Backing directory holding the .trunk/.rings pairs
backing: PathBuf,
/// Directory to mount the logical view on
mountpoint: PathBuf,
/// Uncompressed chunk size threshold in bytes
#[arg(long, default_value_t = 256 * 1024)]
chunk_size: usize,
/// zstd compression level
#[arg(long, default_value_t = 3)]
level: i32,
/// Max seconds appended data may sit unflushed; bounds the
/// write-time granularity of the index and crash data loss
#[arg(long, default_value_t = 5.0)]
flush_age: f64,
/// Let other users access the mount (needs user_allow_other in
/// /etc/fuse.conf)
#[arg(long)]
allow_other: bool,
},
/// Append stdin to a log in a backing directory, without FUSE
/// (svlogd-style): `myapp 2>&1 | timberfs append backing/app.log`.
/// One writer per file; appenders for different files share a
/// directory. EOF, SIGTERM or SIGINT flush and sync before exit.
Append {
/// Backing file: logical name, .trunk or .rings path
file: PathBuf,
/// Uncompressed chunk size threshold in bytes
#[arg(long, default_value_t = 256 * 1024)]
chunk_size: usize,
/// zstd compression level
#[arg(long, default_value_t = 3)]
level: i32,
/// Max seconds appended data may sit unflushed; bounds the
/// write-time granularity of the index and crash data loss
#[arg(long, default_value_t = 5.0)]
flush_age: f64,
/// Continuously drop data older than this (e.g. 30d, 12h, 90m)
#[arg(long)]
retain: Option<String>,
/// Keep the on-disk (compressed) size at or under this budget
/// (e.g. 200G, 512M); oldest data is dropped first
#[arg(long)]
retain_size: Option<String>,
},
/// Print the bytes written between --from and --to, reading the backing
/// files directly (works with or without an active mount)
Query {
/// Backing file: logical name, .trunk or .rings path
file: PathBuf,
/// Start of the time window (RFC3339, 'YYYY-MM-DD HH:MM:SS',
/// 'HH:MM[:SS]' = today, or unix seconds); default: beginning
#[arg(long)]
from: Option<String>,
/// End of the time window (same formats); default: end
#[arg(long)]
to: Option<String>,
},
/// Show the write-time chunk index of a backing file
Index {
/// Backing file: logical name, .trunk or .rings path
file: PathBuf,
},
/// Time-based rotation: move every chunk written before --cutoff into
/// DEST (or drop it with --delete), relocating compressed frames
/// verbatim — no recompression. Auto-detects a live mount and routes
/// the request through the daemon when one is running.
Rotate {
/// Source backing file: logical name, .trunk or .rings path
source: PathBuf,
/// Destination log (same backing directory; appended to if it
/// exists); omit when using --delete
dest: Option<String>,
/// Rotate data written before this time (RFC3339,
/// 'YYYY-MM-DD HH:MM[:SS]', 'HH:MM[:SS]' = today, unix seconds)
#[arg(long)]
cutoff: String,
/// Drop the rotated chunks instead of moving them (retention)
#[arg(long, conflicts_with = "dest")]
delete: bool,
/// Preview what would move without changing anything
#[arg(long)]
dry_run: bool,
},
}
fn main() -> anyhow::Result<()> {
let cli = Cli::parse();
match cli.command {
Command::Mount {
backing,
mountpoint,
chunk_size,
level,
flush_age,
allow_other,
} => {
let cfg = store::Config {
chunk_size: chunk_size.max(1),
level,
flush_age_ms: (flush_age * 1000.0).max(0.0) as u64,
};
let s = store::Store::open(&backing, cfg)?;
eprintln!(
"timberfs: serving {} on {} ({} existing file(s), chunk {} B, zstd -{}, flush age {}s)",
backing.display(),
mountpoint.display(),
s.files.len(),
cfg.chunk_size,
cfg.level,
flush_age
);
fs::mount(s, &mountpoint, allow_other)?;
}
Command::Append {
file,
chunk_size,
level,
flush_age,
retain,
retain_size,
} => {
let cfg = store::Config {
chunk_size: chunk_size.max(1),
level,
flush_age_ms: (flush_age * 1000.0).max(0.0) as u64,
};
append::cmd_append(&file, cfg, retain.as_deref(), retain_size.as_deref())?;
}
Command::Query { file, from, to } => {
query::cmd_query(&file, from.as_deref(), to.as_deref())?;
}
Command::Index { file } => {
query::cmd_index(&file)?;
}
Command::Rotate {
source,
dest,
cutoff,
delete,
dry_run,
} => {
rotate::cmd_rotate(&source, dest.as_deref(), &cutoff, delete, dry_run)?;
}
}
Ok(())
}