A diagnostics report helps us find out what went wrong without a long back-and-forth. It summarizes how Aprox is set up on your device, which requests failed, and what happened during this session. Hostnames, usernames and credentials are redacted before the report is created. Aprox never sends a report by itself; it is created and sent only when you choose to.

Where to find it

  • iPhone, iPad and Android: Sidebar › Settings › Diagnostics.
  • Mac: Aprox › Settings… (⌘,) › Diagnostics.

The section describes itself: "A log of this session's activity, useful when reporting a problem. Hostnames, usernames and credentials are redacted. Report an Issue opens the GitHub tracker with the report attached."

Tip

The report covers the current session. Create it right after the problem happened, without quitting Aprox in between.

Create and share a report (iPhone, iPad and Android)

  1. Open Settings › Diagnostics.
  2. Tap Collect Diagnostics. A sheet shows "Collecting diagnostics…" while Aprox reads this session's log. This can take a moment.
  3. Tap Share Diagnostics.
  4. Choose how to send it, for example Mail, and send it to aprox@ksol.it. Describe in a few sentences what you did and what you expected.

Copy a report (Mac)

  1. Open Settings (⌘,) › Diagnostics.
  2. Click Copy Diagnostics. Aprox collects the report and copies it to the clipboard. The footer confirms: "Copied to the clipboard. Report an Issue opens GitHub with the report attached."
  3. Paste it into an e-mail to aprox@ksol.it, or use Report an Issue.

Report an issue on GitHub

Report an Issue creates the report (if you have not already) and opens a new issue on the Aprox issue tracker on GitHub, with the report filled in.

  1. Open Settings › Diagnostics.
  2. Tap or click Report an Issue.
  3. GitHub opens in the browser with a new issue. Sign in to GitHub if asked.
  4. Add a title and describe the problem: what you did, what you expected and what happened instead.
  5. Submit the issue.

On iPhone, iPad and Mac, a very long report may not fit completely into the new issue. Aprox therefore also copies the full report to the clipboard. If the report in the issue looks cut off, replace it by pasting from the clipboard.

Note

Issues on GitHub are public. The report is redacted, but read it once before you submit and remove anything else you do not want to share. If you prefer, send it by e-mail instead.

What is in the report

  • The app version, the platform and the operating system version.
  • How the app is set up: the number of servers, the sign-in methods they use (password or API token), whether you have Aprox Pro, and on Android whether the local network permission is granted.
  • Which requests to your servers failed.
  • This session's log and any crash records.

Hostnames, usernames and credentials are redacted. Passwords and token secrets are never part of the report.

Good to know

  • Creating a report does not send anything. It only leaves your device when you share, copy or submit it.
  • If Collect Diagnostics is grayed out, a report is already being collected. Wait for the sheet to close.