action #162218
closedcoordination #154768: [saga][epic][ux] State-of-art user experience for openQA
coordination #162215: [epic] Interactive log viewer
interactive log viewer: Generic filtering size:M
0%
Description
Motivation¶
openQA test reviewers work with logs like https://openqa.opensuse.org/tests/4270404/logfile?filename=autoinst-log.txt often. The log viewer should provide features to ease common reviewing tasks. We already provide separate downloads of the raw file so now we can enhance the in-place log viewer. We should start with generic filtering to only show lines matching a search expression similar to how we filter table rows in pages like /admin/products based on expressions in the search field. Based on a discussion of okurz with asmorodskyi.
Acceptance criteria¶
- AC1: Users can filter matching lines of autoinst-log.txt text interactively on /tests/$id/logfile?filename=autoinst-log.txt
- AC2: By default no filter is applied and all text is shown
- AC3: The URL can be shared applying the same filter
Suggestions¶
- Consider discussing the use case and possibilities and alternatives with asmorodskyi who came up with this approach
- Maybe ace-editor can be used for that as we already use it for the code display?
- Take look how we filter in data tables on other pages, e.g. /admin/products or /tests, and apply an equivalent approach on the logfile page
- Provide a text field in the row next to "< Back to job …" and "Raw" with explanation text in the box when no text is there yet
- Update the URL dynamically with the applied filter
Updated by livdywan 5 months ago
We should start with generic filtering to only show lines matching a search expression similar to how we filter table rows in pages like /admin/products based on expressions in the search field
Looking at ACE there is Multiple cursors and selections, and you can see it on https://ace.c9.io/ - is this what the idea is about? Or is this really about hiding parts of the editor like we hide rows in the data table-based UI on /admin/products?
Updated by okurz 5 months ago
livdywan wrote in #note-6:
[…] is this what the idea is about? Or is this really about hiding parts of the editor like we hide rows in the data table-based UI on /admin/products?
Let me quote the first suggestion: "Consider discussing the use case and possibilities and alternatives with asmorodskyi who came up with this approach"
Updated by tinita 5 months ago
https://github.com/os-autoinst/openQA/pull/5836 Proof of Concept
Updated by openqa_review 5 months ago
- Due date set to 2024-08-22
Setting due date based on mean cycle time of SUSE QE Tools
Updated by tinita 4 months ago
Updated the PR with some changes. It now adds the search to the URL fragment, e.g. #string. Maybe it should be #search=string as we might want to add other links later, like a link to a line number
Also some tests still failing, probably because those javascript functions are called on several other pages as well.
Updated by tinita 4 months ago
https://github.com/os-autoinst/openQA/pull/5836 Add interactive log viewer
Updated by tinita 4 months ago
- Status changed from Feedback to Resolved
merged and deployed o3.
Example: https://openqa.opensuse.org/tests/4405346/logfile?filename=autoinst-log.txt#filter=retry
Updated by tinita 4 months ago · Edited
Gathering feedback:
- Highlight matches
- Raw download should only download filtered lines
- Link to certain line and show line numbers
- Convert source references to links, e.g. tests/rspec_webui_tests.pm:11
- Some synchronized view of video + log files. There are already timestamps in the video, if it could show the video at the point of an autoinst.log entry (and vice versa)
Updated by tinita 4 months ago
- Status changed from Resolved to Feedback
A minor improvement:
https://github.com/os-autoinst/openQA/pull/5860 Immediately search when clearing search field
Updated by tinita 4 months ago
https://github.com/os-autoinst/openQA/pull/5860 merged and deployed
Updated by tinita 4 months ago
- Copied to action #165360: Improve interactive log viewer: Various suggestions added