CLAUDE.md
This commit is contained in:
69
CLAUDE.md
69
CLAUDE.md
@@ -2,6 +2,27 @@
|
||||
|
||||
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
||||
|
||||
## Project Summary
|
||||
|
||||
Log ingestion tool that parses application log files and loads them into SQLite for analysis. Primary use case is analyzing mobile app telemetry - tracking feature adoption (autofill, touchID, offline login), app versions, device models, etc.
|
||||
|
||||
### What it does
|
||||
- Parses log lines containing `signature:` messages with app/device telemetry
|
||||
- Extracts: sessionId, timestamp, app name, version, OS, model, device, and feature flags
|
||||
- Converts yes/no to booleans, parses numeric usage counters
|
||||
- Loads into SQLite with indexes on session_id and version for efficient queries
|
||||
|
||||
### Log format
|
||||
Logs are stored in `<base_dir>/YYYY/MM/DD/<filename>` structure, either as `.log` (plain) or `.log.gz` (gzip compressed). A single day can exceed 10GB.
|
||||
|
||||
Example signature message:
|
||||
```
|
||||
msg="signature:XAMARIN_APP/5.23.0/ details:offlineLoginUsage:0,isPasswordAutofillEnabled:no,cameraRollUsage:0,OS:26.2.0,appName:App,touchID:yes,isOfflineLoginEnabled:yes,model:iPhone15,3,device:iOS, Apple,passwordAutofillUsage:0 user-agent:..."
|
||||
```
|
||||
|
||||
### Extensibility
|
||||
The parser uses a `MessageParser` trait allowing new message types to be added. Currently only `signature:` messages are parsed; other message types are skipped.
|
||||
|
||||
## Commands
|
||||
|
||||
### Build & Run
|
||||
@@ -12,8 +33,11 @@ cargo build
|
||||
# Release build
|
||||
cargo build --release
|
||||
|
||||
# Run (example)
|
||||
cargo run -- --name "World"
|
||||
# Run with single file
|
||||
cargo run -- --file /path/to/logs.log --output output.db
|
||||
|
||||
# Run with date range
|
||||
cargo run -- --from 2026/01/20 --to 2026/01/21 --base-dir /var/log/app --filename app.log --output output.db
|
||||
```
|
||||
|
||||
### Testing
|
||||
@@ -26,9 +50,6 @@ cargo nextest run
|
||||
|
||||
# Run a single test
|
||||
cargo test test_name
|
||||
|
||||
# Generate coverage (requires cargo-llvm-cov)
|
||||
cargo llvm-cov nextest --lcov --output-path lcov.info
|
||||
```
|
||||
|
||||
### Quality Checks
|
||||
@@ -43,29 +64,25 @@ cargo fmt
|
||||
cargo clippy
|
||||
```
|
||||
|
||||
### Benchmarks
|
||||
```bash
|
||||
# Requires nightly toolchain
|
||||
cargo +nightly bench
|
||||
```
|
||||
|
||||
## Architecture
|
||||
|
||||
### Project Structure
|
||||
- **cargo-generate template**: This repository is a template for generating new Rust CLI projects
|
||||
- **CLI parser**: Uses clap v4 derive macros for command-line argument processing
|
||||
- **Benchmarks**: Located in `benches/` directory, uses nightly compiler's test crate
|
||||
### Source Files
|
||||
- **src/main.rs**: CLI argument parsing (clap), orchestrates file discovery and processing
|
||||
- **src/parser.rs**: Log line parsing, `MessageParser` trait, `SignatureParser` implementation
|
||||
- **src/db.rs**: SQLite schema creation, batched inserts
|
||||
- **src/files.rs**: File discovery by date range, handles .gz and plain files
|
||||
|
||||
### CI/CD Configuration
|
||||
- **ci.yaml**: Main CI workflow
|
||||
- Runs formatting, Clippy, build, and tests
|
||||
- Generates coverage on Linux with octocov reporting
|
||||
- Automatic PR feedback via reviewdog
|
||||
- **benchmark.yaml**: Auto-deploys benchmark results to GitHub Pages
|
||||
### Database Schema
|
||||
Table `signature_entries` with columns: session_id, timestamp, app, version, offline_login_usage, is_password_autofill_enabled, camera_roll_usage, os, app_name, touch_id, is_offline_login_enabled, model, device, password_autofill_usage.
|
||||
|
||||
Indexes on `session_id` and `version`.
|
||||
|
||||
### Key Design Decisions
|
||||
- Batched inserts (default 10k rows per transaction) for performance
|
||||
- Regex-based parsing with lazy static compilation
|
||||
- Extensible via `MessageParser` trait + `ParsedMessage` enum
|
||||
|
||||
## CI/CD Configuration
|
||||
- **ci.yaml**: Formatting, Clippy, build, and tests
|
||||
- **audit.yaml**: Security audit for dependencies
|
||||
- **release.yaml**: Automated release on tag push (cross-platform builds via GoReleaser)
|
||||
|
||||
### Key Settings
|
||||
- **Rust version**: Fixed to 1.87 in `rust-toolchain.toml`
|
||||
- **Edition**: Uses Rust 2024 edition
|
||||
- **Test tools**: cargo-nextest and cargo-llvm-cov recommended
|
||||
Reference in New Issue
Block a user