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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
mod append;
mod bark;
mod export;
mod format;
mod fs;
mod grain;
mod grep;
mod import;
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,
},
/// Create an empty timberfs log with its properties declared up
/// front in a .bark manifest — database-style: `create --index` is
/// CREATE INDEX, and every later import maintains the .grain
/// automatically
Create {
/// Backing file to create: logical name, .trunk or .rings path
dest: PathBuf,
/// Declare the token index for this log
#[arg(long)]
index: bool,
/// Set a manifest property (key=value, e.g. host=foo.bar.com);
/// repeatable, free-form
#[arg(long = "set", value_name = "KEY=VALUE")]
sets: Vec<String>,
},
/// 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>,
},
/// Import existing plain log files into a timberfs log, stamping
/// chunks with timestamps parsed from the log lines (auto-detects
/// RFC3339/ISO, Apache/CLF and leading epochs; lines without a
/// timestamp inherit the previous line's). Several source files (a
/// rotated set, in any order) are stitched chronologically by their
/// first timestamps. Re-importing a grown single source appends only
/// the growth, after verifying the already-imported data.
Import {
/// Source log file(s): plain logs (stitched chronologically by
/// their first timestamps when several), timberfs logs, or
/// .timber bundles
#[arg(required = true, num_args = 1..)]
sources: Vec<PathBuf>,
/// Destination backing file: logical name, .trunk or .rings path
/// (a named flag on purpose — a glob can never eat it)
#[arg(long = "into", value_name = "DEST")]
dest: 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,
/// Custom timestamp extraction: regex with one capture group
#[arg(long, requires = "timestamp_format")]
timestamp_regex: Option<String>,
/// chrono format string for the captured timestamp (e.g.
/// '%Y-%m-%d %H:%M:%S%.f' or with %z for zoned)
#[arg(long, requires = "timestamp_regex")]
timestamp_format: Option<String>,
/// Treat zoneless timestamps as UTC instead of local time
#[arg(long)]
utc: bool,
/// On re-import, verify only the first/middle/last already-imported
/// chunks against the source instead of all of them
#[arg(long)]
quick: bool,
/// Declare and build the .grain token index for this log
/// (persisted in the .bark manifest — needed once; every later
/// import maintains the index automatically)
#[arg(long)]
index: bool,
},
/// Export a time window (or everything) from a timberfs log into a NEW
/// timberfs log, chunks copied verbatim — no recompression. A DEST
/// ending in .timber writes the single-file transfer bundle (plain
/// tar: .rings first, .trunk second), which import accepts directly.
Export {
/// Source backing file: logical name, .trunk or .rings path
source: PathBuf,
/// Destination: new backing file, or a *.timber bundle
dest: PathBuf,
/// Start of the window (same formats as query); default: beginning
#[arg(long, value_parser = query::parse_time)]
from: Option<u64>,
/// End of the window; default: end
#[arg(long, value_parser = query::parse_time)]
to: Option<u64>,
/// Error instead of writing an empty artifact when nothing matches
/// (default: an empty result is a result — present-but-empty tells
/// a consumer "covered, nothing there", unlike a missing file)
#[arg(long)]
fail_on_empty: bool,
},
/// Print the bytes written between --from and --to, reading the backing
/// files directly (works with or without an active mount)
Query {
/// Backing file(s) or .timber bundle(s); several are interleaved
/// by chunk time-windows with grep-style "path:" line prefixes
#[arg(required = true, num_args = 1..)]
files: Vec<PathBuf>,
/// Start of the time window (RFC3339, 'YYYY-MM-DD [HH:MM[:SS]]'
/// — a bare date is midnight, dotted dates work too,
/// 'HH:MM[:SS]' = today, or unix seconds); default: beginning
#[arg(long, value_parser = query::parse_time)]
from: Option<u64>,
/// End of the time window (same formats); default: end
#[arg(long, value_parser = query::parse_time)]
to: Option<u64>,
/// Only chunks that (probably) contain this token, via the .grain
/// Bloom index (build with `timberfs reindex`); repeatable = AND;
/// an argument with separators must match all its tokens
#[arg(long)]
has: Vec<String>,
/// Never prefix output lines with the file name
#[arg(long)]
no_filename: bool,
},
/// Entry-aware grep: matches PATTERN against whole log entries (a
/// timestamped line plus its continuation lines — stack traces stay
/// attached to their entry). Reads raw log from stdin or a plain
/// file, or a timberfs log/bundle where --from/--to/--has pre-select
/// chunks first. Pipe several greps for entry-level AND.
Grep {
/// Text matched at token boundaries — the fast default, index-
/// accelerated on grain-indexed logs (ERROR finds the word ERROR,
/// not ERRORS). -F matches raw substrings, --regex full regexes;
/// both read everything. May be left out when --has/--from/--to
/// select instead: the first argument is then the file
pattern: String,
/// Raw log file(s), timberfs backing file(s), or .timber
/// bundle(s), processed in order with "path:" prefixes when
/// several (default: raw log on stdin)
files: Vec<PathBuf>,
/// Case-insensitive matching
#[arg(short = 'i', long)]
ignore_case: bool,
/// Print entries that do NOT match
#[arg(short = 'v', long)]
invert: bool,
/// PATTERN is a raw substring: matches inside tokens too
/// (partial ids). Reads every chunk
#[arg(short = 'F', long)]
fixed: bool,
/// Print only the number of matching entries
#[arg(short = 'c', long)]
count: bool,
/// Start of the time window (timberfs sources only; same
/// formats as query)
#[arg(long, value_parser = query::parse_time)]
from: Option<u64>,
/// End of the time window (timberfs sources only)
#[arg(long, value_parser = query::parse_time)]
to: Option<u64>,
/// .grain chunk pre-filter (timberfs sources only); repeatable
#[arg(long)]
has: Vec<String>,
/// Never prefix output lines with the file name
#[arg(long)]
no_filename: bool,
/// Custom entry-boundary timestamp: regex with one capture group
#[arg(long, requires = "timestamp_format")]
timestamp_regex: Option<String>,
/// chrono format string for the captured timestamp
#[arg(long, requires = "timestamp_regex")]
timestamp_format: Option<String>,
/// Write matching entries into a NEW timberfs log or .timber
/// bundle instead of printing — the investigation as an artifact:
/// its manifest records the command line, pattern, window and
/// lineage. Takes exactly one timberfs source
#[arg(long = "into", value_name = "DEST", conflicts_with_all = ["count", "no_filename"])]
into: Option<PathBuf>,
/// With --into: error instead of writing an empty artifact when
/// nothing matches
#[arg(long, requires = "into")]
fail_on_empty: bool,
/// Full scan: never pre-filter chunks via the .grain (word-mode
/// patterns otherwise use it automatically when one exists)
#[arg(long)]
scan: bool,
/// PATTERN is a regular expression. Reads every chunk — don't
/// reach for this unless you need it; the word-mode default is
/// index-accelerated
#[arg(long, conflicts_with = "fixed")]
regex: bool,
},
/// Show the write-time chunk index of a backing file
Index {
/// Backing file: logical name, .trunk or .rings path
file: PathBuf,
},
/// Build or rebuild the .grain token index for a log: one Bloom filter
/// per chunk over every token in it (~1% false positives), letting
/// `query --has` skip chunks — e.g. find a request id with no known
/// time range. Derived data: safe to delete, cheap to rebuild; rotation
/// and retention drop it (rebuild afterwards).
Reindex {
/// 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]]' — a bare date is midnight,
/// 'HH:MM[:SS]' = today, unix seconds)
#[arg(long, value_parser = query::parse_time)]
cutoff: u64,
/// 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,
/// Error when nothing rotates (default: rotating nothing into a
/// new DEST still creates it empty — an attested empty result)
#[arg(long)]
fail_on_empty: bool,
},
}
fn main() -> anyhow::Result<()> {
// Die quietly when a pipe closes (query | head), like any Unix tool,
// instead of Rust's default panic-on-EPIPE.
unsafe {
libc::signal(libc::SIGPIPE, libc::SIG_DFL);
}
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::Create { dest, index, sets } => {
bark::cmd_create(&dest, index, &sets)?;
}
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::Import {
sources,
dest,
chunk_size,
level,
timestamp_regex,
timestamp_format,
utc,
quick,
index,
} => {
let cfg = store::Config {
chunk_size: chunk_size.max(1),
level,
flush_age_ms: u64::MAX, // no age flushing during import
};
import::cmd_import(
&sources,
&dest,
cfg,
timestamp_regex.as_deref(),
timestamp_format.as_deref(),
utc,
quick,
index,
)?;
}
Command::Export {
source,
dest,
from,
to,
fail_on_empty,
} => {
export::cmd_export(&source, &dest, from, to, fail_on_empty)?;
}
Command::Query {
files,
from,
to,
has,
no_filename,
} => {
query::cmd_query(&files, from, to, &has, no_filename)?;
}
Command::Grep {
pattern,
files,
ignore_case,
invert,
fixed,
count,
from,
to,
has,
no_filename,
timestamp_regex,
timestamp_format,
into,
fail_on_empty,
scan,
regex,
} => {
grep::cmd_grep(
&pattern,
&files,
from,
to,
&has,
ignore_case,
invert,
fixed,
count,
no_filename,
timestamp_regex.as_deref(),
timestamp_format.as_deref(),
into.as_deref(),
fail_on_empty,
scan,
regex,
)?;
}
Command::Index { file } => {
query::cmd_index(&file)?;
}
Command::Reindex { file } => {
grain::cmd_reindex(&file)?;
}
Command::Rotate {
source,
dest,
cutoff,
delete,
dry_run,
fail_on_empty,
} => {
rotate::cmd_rotate(
&source,
dest.as_deref(),
cutoff,
delete,
dry_run,
fail_on_empty,
)?;
}
}
Ok(())
}