The Report a Bug panel sends a problem you ran into in the app straight to NeoSQL. You can send it without signing in. The app version, OS, the screen you were on and the recent error log are already filled in, so you only need to describe what you were doing and what happened. Before sending, you can see everything that goes with the report and edit or remove it.
Where you can use itWebDesktopWithout signing inSigned inLocal projectsAccount projects
What's on the screen
| No. | Name | Description |
|---|---|---|
| 1 | Title field | Already holds the name of the screen you were on when you opened the panel (in a project, the kind and name of the tab). You can rewrite it. |
| 2 | What happened field | Describe what you were doing and what happened. If you know how to make it happen again, include the steps. |
| 3 | Screenshots area | Choose images with the Attach image button or drag them onto the panel. Attach up to three PNG, JPEG, GIF or WebP images, up to 5 MB each. |
| 4 | Error log | Recent errors the app collected. The number of errors is shown next to it. It has Refresh, Clear and Hide buttons, and you can edit the text directly. |
| 5 | Environment | Click to expand. It has the App version, Client, OS, Current tab / page, DBMS and Language fields, all editable. |
| 6 | Send button | Sends the report. |
- The DBMS field is the DBMS and version of the connection used by the tab you were on. If you opened the panel outside a project or from a tab without a connection, it shows Not applicable.
- The panel floats on the right without covering the screen. Keep it open while you use the app to reproduce the problem, and pull in the errors from that time into the error log with the Refresh button.
Sending a report
- Click the Report a bug button at the right of the header. If you click it on the screen where the problem happened, that screen goes into the title and the environment.
- Check the Title field (1) and fill in the What happened field (2). Neither can be left empty.
- Attach images in the Screenshots area (3) if needed.
- Expand and read the Error log area (4) and the Environment area (5), and remove or edit anything you do not want to send.
- Click the Send button (6). The Your report was received. Thank you. message appears and the panel closes.
What is sent with the report
| Content | Where it comes from | Before sending |
|---|---|---|
| Title, What happened, Screenshots | What you wrote and attached | You can edit them |
| Error log | The most recent errors since the app started (up to 30). Values that are clearly secret, such as passwords, tokens, API keys and private keys, are replaced with *** when collected. | You can edit or clear it |
| Environment | App version, web or desktop, OS, the screen you were on, DBMS, display language | You can edit it |
| Information attached to requests | The app version, web or desktop, and an identifier of this device go with every request. The server records the IP address and app information (User-Agent), and, if you are signed in, your account. | You cannot edit it |
- Your project designs, SQL documents, connection settings and query results are not sent separately. However, the error log can keep SQL statements, table names and email addresses that were part of an error message. They are left unmasked on purpose because they help find the problem, so read the log before sending and remove them if needed.
- Attached screenshots are not made public and are used only to look into the problem. If a screenshot shows customer data, hide it before attaching.
- Once the report is received, the errors you sent are removed from the app's error log so they are not included in the next report.
When the report cannot be sent
If sending fails, the panel stays open and shows the reason at the bottom. What you wrote is kept, so click the Send button again.
| Message | What to do |
|---|---|
| Cannot reach the server. Check your network and try again. | Check your internet connection and send again. |
| Please try again later — too many reports were sent in a short time. | Wait a moment and send again. |
| Could not send the report. Please try again in a moment. | Send again a little later. If it keeps failing, tell us through one of the ways in Contact us. |
Sending again from the same panel counts as the same report, so even if the earlier attempt actually got through, it is not received twice.
Things to keep in mind
- Clicking outside the panel does not close it. To close it, click the
×button or the Cancel button, or click the panel and pressEsc. Closing it discards what you wrote. - The error log is collected only while the app is running. Errors from before you restarted the app are not included, so report the problem in the same run in which it happened.
- The Error log area shows what existed when you opened the panel. Errors that happen after that are added only when you click the Refresh button.
- In the web app, the OS field holds what the browser reports (User-Agent). The desktop app reads the OS version and chip type directly from the operating system.
Related screens
- App menu, top bar and status bar: the header with the bug report button.
- Security and where your data goes: what is exchanged with the NeoSQL server even without signing in.
- Troubleshooting: common problems to check before reporting.
- Contact us: other ways to reach NeoSQL besides bug reports.