Log Viewer v1

[Shrinks99]

Figma File | Interactive Mockup

Requirements

• Colour coded errors, warnings, and status messages
• Log search / filtering
  • Lets users filter by any property of the structured log
  • Also searchable by log messages
• Logs can be streamed as the crawl is running
  • When the user scrolls away from the bottom (live) part of the log the live scroll stops while they browse past messages

Todo

• [x] Mockups
• [x] #669
• [ ] #670

Future? 👀

Bringing this here from the previous issue to keep track of eventual plans but don't want to make seperate ones until this issue is closed.

Log viewer V2

• Detailed help messages / information to link to for errors
  • One of the things that sucks about debugging stuff with logs is that users often have to Google the issue and then go elsewhere to actually find the answer about what to do because of a logged error. Being able to link to relevant docs pages within the log viewer seems like a helpful and achievable thing to shoot for.
• When scrolling upwards and reading the log the feed pauses and won't move again until the user scrolls down to the bottom of the feed or presses the "now" button
• Bookmarked lines?
  • Would be neat to let users save a specific log entry, hopefully useful for flagging lines and issues to other team members
  • Bookmarked lines for a given job are visible to all users
• Linkable log items eliminating the need to send line numbers or PM links to people?

Out of scope

• ❓Job log visualizer / minimap
  • Coloured scroll bar that shows what colour log statuses are over time, blocks of red & yellow (warnings and errors) can be jumped to and examined closer, probably shown on the right side as a replacement for the scroll bar?
• ❓ Integration with replayweb.page?
  • The biggest end user use case for logs we were given is that they're helpful to look at when QCing a finished job to inspect what went wrong while crawling. In order to make this process easier it may be helpful to have a link to the relevant log entries available within replayweb.page? This seems like it should be out of scope of this issue.

[Shrinks99]

Logging request from browsertrix crawler with some criteria https://github.com/webrecorder/browsertrix-crawler/issues/261