"Back" button and/or query history for korrel8r panel.

openshift / troubleshooting-panel-console-plugin

Console Plugin to add a troubleshooting side panel to display Korrel8r data

Apache License 2.0

0 stars 7 forks source link

"Back" button and/or query history for korrel8r panel. #28

Closed alanconway closed 3 weeks ago

alanconway commented 5 months ago

If someone mistypes a query or gets to an uninteresting correlation graph, they will want a way to return return to previous interesting queries. A drop down history of queries could be useful for advanced users, but many users will be unaware of the query syntax so for them a "back" button might be better.

PeterYurkovich commented 5 months ago

Some things to consider for a history:

How long does the history stay around for? Just the time the panel is open or do we want to persist them in browser storage?
What happens if someone presses back one too many times? Do we need a forward button as well? Or does that complicate the UI too much?
Maybe a korrel8r query dropdown wouldn't work well, but what if we could find a way to humanize the queries so that people could understand them, pulling out key information like the namespace and name? Or is that impossible since the queries can be close to limitless in their specificity and varies across the domains

alanconway commented 4 months ago

Queries are in the language of their domain (LogQL, PromQL, k8s REST etc.) There is no "universal" korre8lr query language, the philosophy is to tackle the reality of diverse systems and query languages, rather than waiting for an ideal uniform world (that's a job for projects like OTEL, GraphQL and the like) Details of query probably only useful to an advanced user, a basic user will be using queries generated automatically by the console, and may never even look at the query (e.g. see console logging page which hides the LogQL query unless requested) Basic user just wants to "get back to where I was before". There may be something we can do to humanize the queries, by relating them to console resources using icons or summarizing them somehow - I haven't thought it through.

alanconway commented 4 months ago

Possible resolution - some of the query and search widgets automatically maintain a history of past values, that might be all we need.

openshift-bot commented 1 month ago

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close. Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

alanconway commented 3 weeks ago

The panel restores its previous state as of https://github.com/openshift/troubleshooting-panel-console-plugin/pull/80 This allows the user to "contine where I left off", which may be sufficient. if not we can open a new issue.