Introduction
For developers working with Fedora package builds, failed builds can be frustrating, especially when the logs are long and cryptic. Log Detective, now integrated with Packit, automatically analyzes failed scratch Koji builds and provides clear explanations. This guide walks you through how this integration works and how to leverage it without any extra configuration.
What You Need
- A Packit service set up for your dist-git repository (no additional setup required for Log Detective).
- A pull request on dist-git that triggers a Packit scratch Koji build.
- Access to the Packit dashboard to view analysis results.
Step-by-Step Guide
Step 1: Trigger a Packit Build
Open a pull request on your dist-git repository. Packit automatically triggers a scratch Koji build as part of its integration workflow. This build is the starting point for Log Detective analysis.
Step 2: Build Failure Initiates Analysis
If the Koji build fails, Packit sends a request to Log Detective automatically. You do not need to click any button or submit logs manually. The system handles everything behind the scenes.
Step 3: Log Detective Processes Logs
Log Detective receives all build logs and artifacts. Using its agent (built on the BeeAI Framework), it applies the Drain template mining algorithm to extract small, relevant snippets. This reduces token usage and speeds up analysis, allowing even small models to produce good results.
Step 4: View Results on the Packit Dashboard
Once Log Detective completes the analysis, results are posted to the Fedora Messaging bus. Packit collects them and links the analysis to your pull request in the Packit dashboard. Check the dashboard for a summary of what went wrong and, where possible, a suggested solution.
Step 5: Interpret the Analysis
The analysis includes a statement identifying the failure cause and, optionally, a fix suggestion. Note that Log Detective only uses build logs—it does not access other sources. Therefore, it is best suited for newcomers or common issues. Experienced maintainers may find the advice less useful, but it can still save time on routine failures.
Tips and Considerations
- No setup needed: Log Detective works out of the box with your existing Packit configuration.
- Automatic only: Currently, analysis triggers automatically on failure; you cannot manually request it.
- Limitations: The tool relies on a general-purpose model and only sees build logs. Do not treat it as a substitute for deep packaging experience—use it as a starting point.
- Future improvements: The Log Detective team plans to add context from other sources and refine the analysis over time.
- Community feedback: Your usage helps improve the tool. Report issues or suggestions to the Fedora community.