Skip to content

docs: add troubleshooting section to CONTRIBUTING #2

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

Merged
HrachShah merged 1 commit into from
Apr 20, 2026
Merged

docs: add troubleshooting section to CONTRIBUTING #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,3 +150,16 @@ By contributing to Log Analyzer CLI, you agree that your contributions will be l
- **Discussions**: For questions and general discussion

We appreciate all contributions, from bug reports to new features!

## Troubleshooting

### Common Issues

**Q: Large files cause memory issues?**
A: Use streaming mode with `--stream` flag for files over 100MB.

@capy-ai capy-ai Bot Apr 20, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

[🟡 Medium] [🔵 Bug]

The troubleshooting answer recommends --stream flag for large files, but this flag does not exist in the CLI. The cli.py analyze command defines --format, --output, --verbose, --no-group, --levels, --pattern, --start-time, and --end-time — no --stream. The tool already uses a streaming generator internally via read_log_file, so there is no user-facing flag to enable it. Users following this advice will get an unrecognized option error.

# CONTRIBUTING.md
A: Use streaming mode with `--stream` flag for files over 100MB.

Update the answer to reflect the actual behavior — e.g., explain that large file streaming is handled automatically by the tool, or remove the reference to a flag.


**Q: Log format not detected?**
A: Manually specify format with `--format json|syslog|apache|generic`.

**Q: Gzip compressed files not reading?**
A: Ensure `.gz` extension is present; auto-detection handles gzip.
Loading