Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Improve the logs and error reporting functionality #979

Copy link
Copy link
Open
0 / 10 of 1 issue completed
Open
Copy link
@Xayton

Description

@Xayton
Issue body actions

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:

Sub-issues

Metadata

Metadata

Assignees

No one assigned

    Labels

    topic: codeRelated to content of the project itselfRelated to content of the project itselftype: enhancementProposed improvementProposed improvement

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      Morty Proxy This is a proxified and sanitized view of the page, visit original site.