A good report tells us exactly what happened, in a form we can reproduce. When you hit a problem in Binions, a few minutes spent gathering the right details turns a vague “it didn’t work” into something that can be diagnosed quickly. This page lists what to include, so your report is complete the first time round. For the exact commands that produce each piece, see Collecting logs.
Redact secrets first. Logs and configuration can contain passwords, API tokens, and database connection strings. Remove or mask anything sensitive before you share a report — we never need your real credentials to help you.
Work through this checklist. Each item helps narrow down where a problem lives, so the more you can fill in, the faster the diagnosis:
apt list --installed 'binions-*'. All the packages should report the same version — a mismatch is itself a useful clue.binions-mailbox. If you are not sure, binions-cliconsole status shows every daemon’s readiness at a glance.journalctl or the structured event logs — copied verbatim, not paraphrased. A failed playbook run does not write to a dead-letter file; instead it emits a Fact.Playbook.Failed event, which you will find on the event log.correlation_id that ties the whole sequence of events together. Quoting it lets the entire run be traced end to end.| Detail | Where it comes from |
|---|---|
| Platform version | apt list --installed 'binions-*' |
| Daemon readiness | binions-cliconsole status |
| Recent errors | journalctl and the structured event logs |
| Failed playbook steps | The Fact.Playbook.Failed event, traced by correlation id |
| Correlation id | Any event line for the failing run |
You don’t need to memorise the commands — Collecting logs walks through each one and shows how to capture them into files you can attach.
One clear report beats several vague ones. Keep it factual and reproducible. If you can include the correlation id and the exact error text, you have given us almost everything we need.
If an error message includes a code, you can often resolve the problem yourself before reporting it. The Error codes reference lists the common ones with their likely cause and fix — worth a look while you gather the details above.