Display link to logs when task errors out #153
Labels
area:frontend
Related to Nebula's Frontend Electron app
area:task-runner
Related to Nebula's Task Runner package
priority:low
Issues that are low priority don't need to be solved right away
type:Future Feature
Something to be done in the future
Is your feature request related to a problem? Please describe.
Currently we save logs to the user documents folder, but other than asking the devs or reading the docs, some users might not be aware of this location. It would be nice to display a link to the log location when a task errors out. The final message for the error state could include a link to open the folder, or even the specific task-runner log in the OS's file explorer.
This would also help connect between the task runner id (used in the log file) and the task id (shown to the user).
Describe the solution you'd like
Phase 1:
Modify the frontend to allow displaying links to local files. The local file urls should be checked, and clicking the hyper link should open the file location in the OS's file explorer.
Phase 2:
Update the task runner to pass the log file location when the task errors out. This will be a separate part of the status update payload, passed in addition to the status update message.
Describe alternatives you've considered
Another option would be to always have a link to logs location in the frontend, maybe under settings.
This would be a button that opens the logs location for the user. Phase 1 will still have to be implemented to some degree.
Additional context
I'm thinking this would be a good feature for the beta, but it might be a good thing to have for the stable release as well. Either way we can implement this to be enabled by a flag from the environment. That would allow us to easily turn it on/off when we need it.
The text was updated successfully, but these errors were encountered: