docs: add troubleshooting section to CONTRIBUTING

[HrachShah]

Adds FAQ for common issues: large files, format detection, gzip support.

Summary by Sourcery

Documentation:

• Document troubleshooting steps for large file memory issues, log format detection, and gzip-compressed input in CONTRIBUTING.

[coderabbitai]

Warning

Rate limit exceeded

@HrachShah has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 57 minutes and 21 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 57 minutes and 21 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4b1a947c-d77e-4226-a09d-11b36b4f5083

📥 Commits

Reviewing files that changed from the base of the PR and between 45cfce8 and 25b3385.

📒 Files selected for processing (1)

• CONTRIBUTING.md

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/add-troubleshooting

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds a troubleshooting/FAQ section to CONTRIBUTING.md documenting how to handle common issues with large files, log format detection, and gzip-compressed inputs when using the CLI.

Flow diagram for troubleshooting common CLI issues

flowchart TD
  A[Start_troubleshooting] --> B{Issue_type}
  B -->|Large_files_memory_issues| C[Use_stream_flag_for_files_over_100MB]
  B -->|Log_format_not_detected| D[Specify_format_with_flag_json_syslog_apache_generic]
  B -->|Gzip_file_not_reading| E[Ensure_gz_extension_present_for_auto_detection]
  C --> F[Re_run_CLI_and_check_memory_usage]
  D --> G[Re_run_CLI_and_check_format_parsing]
  E --> H[Re_run_CLI_and_check_input_reading]
  F --> I[End_troubleshooting]
  G --> I
  H --> I

Loading

File-Level Changes

Change	Details	Files
Document troubleshooting guidance for common CLI usage issues in CONTRIBUTING.md.	Add a new 'Troubleshooting' section with a 'Common Issues' subsection Describe how to handle memory issues with large files by using streaming mode via the --stream flag for files over 100MB Explain how to manually specify log format using the --format flag when auto-detection fails Clarify that gzip-compressed files require a .gz extension for auto-detection to work	CONTRIBUTING.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[capy-ai]

Added 1 comment

[capy-ai]

[🟡 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.