Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the logs and error reporting functionality #979

Open
Xayton opened this issue Jul 29, 2024 · 0 comments
Open

Improve the logs and error reporting functionality #979

Xayton opened this issue Jul 29, 2024 · 0 comments
Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement
Milestone

Comments

@Xayton
Copy link
Contributor

Xayton commented Jul 29, 2024

In order to help users having problems with the Arduino Agent, it's important to collect good error reports and make it easy for users to report them to the developers. This is a list of improvements linked to this goal:

  • Crash report functionality should be enabled by default and log all the messages of the application
  • Add a way to automatically delete logs when they get older than X days or use more space than a given limit
  • Review the application logs
    • Check that the correct log level and messages are used throughout the application
    • Disable the GIN logging at startup
  • When the port binding fails because it's already in use, improve the log and check if there is already a version of the agent running, so that the log can say that (the check can be done by calling a known Agent endpoint, or add a new "version" endpoint for this specific reason). This can also be used to implement a way to detect existing Agent instances and avoid multiple running agents.
  • Improve the discoverability of the error reporting functionalities, by updating the menus:
    • create a new menu item "Error reporting" or "Debugging"
    • Move the "Open Debug Console" inside it
    • Move the "Remove crash reports" inside of it and rename it "Clear application logs"
    • Add a new item "Get application logs Zip" to compress the logs into a zip file that will be saved in the user's home and opened in the default OS file viewer (like it's done with the configuration file)
    • Add a "Restart agent" item, to make it easy to restart the agent.
  • Document the application folders:
    • the application folder, where the executable is stored
    • the configuration folder
    • the .arduino-create folder, where downloadable data and logs are stored

While working on these improvements, also check these existing tasks:

@per1234 per1234 added type: enhancement Proposed improvement topic: code Related to content of the project itself labels Aug 3, 2024
@Xayton Xayton added this to the next milestone Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement
Projects
None yet
Development

No branches or pull requests

2 participants