search

apache / incubator-devlake

Apache DevLake is an open-source dev data platform to ingest, analyze, and visualize the fragmented data from DevOps tools, extracting insights for engineering excellence, developer experience, and community growth.
https://devlake.apache.org/
Apache License 2.0
2.6k stars 527 forks source link

[Feature][config-ui] Improve usability of the "Task failed: ..." popup #5847

Open renflo opened 1 year ago

renflo commented 1 year ago

Search before asking

Use case

  1. I want the "Task failed..." popups to have good readability, even when the information is a verbose system error log.
  2. I want to be able to copy paste the information in the "Task failed..." popups
  3. When the displayed information is a log from a system error I want to know when it happened

Description

The screenshot under documents where the popup panel I mention is: it appears when you hover over "Task failed: hover to view the reason" Screenshot 2023-08-10 at 11 11 32

Today when I hover over and the reason is an error in the execution I am met with this kind of stuff: Screenshot 2023-08-10 at 11 14 27 Screenshot 2023-08-10 at 11 14 36

So back to my 3 use case requests:

  1. Readability when system errors occur is difficult. I think it's satisfying that you reproduce the relevant log statement, as it allows me to dig in the logs server side to find more information. But I suggest that you a) limit the maximum size of the popup and add some kind of +/- button to maximize and minimize it" and more importantly b) format the log so newlines are correctly placed. The second change in particular should be trivial and would really improve readability.
  2. "copy pasting" is impossible today because the popup disappear when you move the mouse. You can ofc use the developer tools to get the message but it unnecessarily complicated. I propose you either a) make the link clikable, and when it's clicked it would stay unhidden, giving the user time to copy/paste or b) add a "copy" icon close to the text which when clicked would copy the text to the clipboard.
  3. finally you must add the time at which the log occured, that's a crucial piece of information.

Consider my proposals as illustrative - there are many ways to solve this but it's usually simpler to be specific and let people adjust than not saying anything.

Related issues

No response

Are you willing to submit a PR?

Code of Conduct

mintsweet commented 1 year ago

Hi @renflo, thank you for your report. This is just a simple error message, if you want to get the complete log information, you can download the error log. And @Startrekzky do you have any advice?

renflo commented 1 year ago

I'm aware it's a simple error message and it's fine. It's just that when the message displayed is huge it's not very usable. A few adjustments like the ones I mention would help a lot. I'm ofc not proposing to replace looking up the logs from the server :)

d4x1 commented 1 year ago

@klesh
Maybe we should limit the length of charaters of API response's err message

mintsweet commented 1 year ago

Hi @renflo You don't need to get logs from the server; you can download logs from the config-ui.

image

renflo commented 1 year ago

Ok, thanks, did not see that option, it's quite "far" away from the link which creates the popup.

Perhaps the button could be added close to the link i mentioned? There is something not ideal about usability here.

github-actions[bot] commented 1 year ago

This issue has been automatically marked as stale because it has been inactive for 60 days. It will be closed in next 7 days if no further activity occurs.

github-actions[bot] commented 11 months ago

This issue has been automatically marked as stale because it has been inactive for 60 days. It will be closed in next 7 days if no further activity occurs.

github-actions[bot] commented 9 months ago

This issue has been automatically marked as stale because it has been inactive for 60 days. It will be closed in next 7 days if no further activity occurs.

github-actions[bot] commented 7 months ago

This issue has been automatically marked as stale because it has been inactive for 60 days. It will be closed in next 7 days if no further activity occurs.

github-actions[bot] commented 5 months ago

This issue has been automatically marked as stale because it has been inactive for 60 days. It will be closed in next 7 days if no further activity occurs.

github-actions[bot] commented 3 months ago

This issue has been automatically marked as stale because it has been inactive for 60 days. It will be closed in next 7 days if no further activity occurs.

github-actions[bot] commented 2 months ago

This issue has been closed because it has been inactive for a long time. You can reopen it if you encounter the similar problem in the future.

github-actions[bot] commented 5 days ago

This issue has been automatically marked as stale because it has been inactive for 60 days. It will be closed in next 7 days if no further activity occurs.