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

Display link to logs when task errors out #153

Open
pr1sm opened this issue Nov 22, 2018 · 4 comments
Open

Display link to logs when task errors out #153

pr1sm opened this issue Nov 22, 2018 · 4 comments
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

Comments

@pr1sm
Copy link
Collaborator

pr1sm commented Nov 22, 2018

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.

@pr1sm pr1sm added area:frontend Related to Nebula's Frontend Electron app type:Feature Request Something that might be done in the future area:task-runner Related to Nebula's Task Runner package labels Nov 22, 2018
@walmat
Copy link
Owner

walmat commented Nov 26, 2018

I think this should be pushed up to the beta as well! I think we could keep the displayed error message, but maybe have an icon appear to the right that links to the log file maybe? Let me know what you think. Either way, we should definitely push this up to the beta!

@pr1sm
Copy link
Collaborator Author

pr1sm commented Nov 26, 2018

agreed, I think it can be a small icon in the task log, we can add a column on the right that has an icon for each log file. Do you think this needs to go on before the initial release? or should we wait and add this after the first release?

@pr1sm pr1sm added type:Future Feature Something to be done in the future and removed type:Feature Request Something that might be done in the future labels Nov 26, 2018
@walmat
Copy link
Owner

walmat commented Nov 26, 2018

sometime after is fine.

@walmat walmat self-assigned this Dec 10, 2018
@walmat walmat added this to the Beta 2 Release milestone Dec 29, 2018
@pr1sm pr1sm removed this from the Beta 3 Release milestone Jan 17, 2019
@pr1sm pr1sm added the priority:high Issues that are high priority, but don't need to be solved ASAP label Feb 11, 2019
@pr1sm pr1sm unassigned walmat Apr 8, 2019
@walmat
Copy link
Owner

walmat commented Aug 15, 2019

With the logs disabled, I'm moving this to low priority.

@walmat walmat added priority:low Issues that are low priority don't need to be solved right away and removed priority:high Issues that are high priority, but don't need to be solved ASAP labels Aug 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

2 participants