Skip to content

check: add --format flag, json reporter #663

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

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from
+256 −57
Draft

check: add --format flag, json reporter #663

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
cea78b3
check: add `--report` flag for writing ndjson output
adrienthebo Oct 20, 2025
add40da
check: format
adrienthebo Oct 27, 2025
1328f45
check: clean up summarization
adrienthebo Oct 27, 2025
999826f
check: use consistent naming
adrienthebo Oct 27, 2025
73c552e
check: relocate report construction
adrienthebo Oct 27, 2025
b881cc5
check: move logging to stderr
adrienthebo Oct 27, 2025
b3a2aa7
check: fix lints
adrienthebo Oct 27, 2025
ea6e73e
lib: extract DetectionRow out of check
adrienthebo Oct 29, 2025
14d7bee
analyzer: simplify AnalysisRow destructuring
adrienthebo Oct 29, 2025
cdd6d9e
check: drop unused imports
adrienthebo Oct 29, 2025
b877ce4
check: document log destination reasoning
adrienthebo Nov 6, 2025
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
51 changes: 32 additions & 19 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.

9 changes: 8 additions & 1 deletion check/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,12 @@ log = "0.4.20"
tokio = { version = "1.44.2", default-features = false, features = ["fs", "signal", "process", "rt-multi-thread"] }
pcap-file-tokio = "0.1.0"
clap = { version = "4.5.2", features = ["derive"] }
simple_logger = "5.0.0"
walkdir = "2.5.0"
serde_json = "1.0.145"
serde = "1.0.228"
chrono = "0.4.42"

[dependencies.simple_logger]
version = "5.0.0"
# Log to stderr so that report output doesn't potentially collide with system logs
features = ["stderr"]
Copy link
Collaborator

@untitaker untitaker Oct 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you document here why it has to be stderr?

Copy link
Contributor Author

@adrienthebo adrienthebo Oct 29, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's no longer strictly necessary to log to stderr; my original implementation printed json to stdout for simplicity but since --path supports both files and directories we have to write .ndjson files in order to have a coherent output that matches the daemon ndjson output.

My instinct is to revert this change and continue logging to stdout so that check ... | less will work as expected, but I don't have strong feelings either way. I'll document why we made this change if you want to continue with the switch to stderr.

Copy link
Collaborator

@untitaker untitaker Oct 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think logging to stderr is still the right thing to do, just asking about documentation

Copy link
Contributor Author

@adrienthebo adrienthebo Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amended in b877ce4.

Loading