CI / test (macos-latest) (push) Canceled after 0s
CI / test (ubuntu-latest) (push) Canceled after 0s
CI / test (windows-latest) (push) Canceled after 0s
CI / release (macos-latest, aarch64-apple-darwin) (push) Canceled after 0s
CI / release (ubuntu-latest, x86_64-unknown-linux-gnu) (push) Canceled after 0s
CI / release (windows-latest, x86_64-pc-windows-msvc) (push) Canceled after 0s
51 lines
2.1 KiB
Markdown
51 lines
2.1 KiB
Markdown
# logreadlite
|
||
|
||
A fast desktop viewer for large log files, built in Rust with egui/eframe. It
|
||
opens files of hundreds of MB or more right away, groups multi-line records
|
||
(stack traces, JSON dumps) into entries, and indexes, filters and searches in
|
||
the background so the UI never blocks.
|
||
|
||
See `log-reader-implementation-plan.md` for the design.
|
||
|
||
## Run
|
||
|
||
```sh
|
||
cargo run --release -- [FILE|FOLDER]...
|
||
```
|
||
|
||
A file opens in a viewer tab and a folder opens a "Find in files" tab. You can
|
||
also drop files, folders or `.logrules.toml` rule files on the window.
|
||
|
||
## Features
|
||
|
||
- Memory-mapped, read-only access; a parallel background indexer (about 4–5 GB/s from a warm cache).
|
||
- Detects the entry-start pattern automatically, with an editor that shows a live preview.
|
||
The pattern you pick is saved per file or per file-name glob.
|
||
- Multi-line entries are collapsed with a "+N lines" badge. Expand one, or all.
|
||
- Line wrap toggle (Alt+Z), saved per file.
|
||
- Keyword filter chips (Exclude / Only, regex and case toggles), applied to whole entries.
|
||
- Highlight rules (row tint or matched text) with light and dark palettes.
|
||
- Regex search with next/previous and a match count. A match on a continuation line expands its entry.
|
||
- Import and export rule files (`.logrules.toml`), and named rule sets.
|
||
- Folder grep built on ripgrep's `ignore` and `grep-searcher` crates. Open any hit in the viewer.
|
||
|
||
Help → Keyboard shortcuts lists the keys.
|
||
|
||
## Develop
|
||
|
||
```sh
|
||
cargo test # unit tests and format-detection tests
|
||
cargo bench --bench passes # index/filter/search throughput (100 MB fixture)
|
||
cargo run --release --example gen_fixture -- big.log 1024 traces
|
||
cargo run --release --example gen_fixture -- --folder logs/ 1000 2
|
||
```
|
||
|
||
Two environment variables help with UI checks that have no input injection:
|
||
`LOGREADLITE_SCREENSHOT=out.ppm` saves a screenshot after
|
||
`LOGREADLITE_SCREENSHOT_DELAY` seconds and then quits.
|
||
`LOGREADLITE_DEBUG_SCRIPT="search:foo;next;exclude:DEBUG;wrap"` replays
|
||
actions on the active tab (see `src/ui/debug.rs`).
|
||
|
||
Settings and named rule sets are stored in the OS config folder
|
||
(`~/.config/logreadlite` on Linux).
|