openbmc / webui-vue

Web-based user interface built on Vue.js for managing OpenBMC systems
https://openbmc.github.io/webui-vue/
Apache License 2.0
56 stars 55 forks source link

Event logs, Hidden logs #58

Open ParishrutB opened 3 years ago

ParishrutB commented 3 years ago

Use Case

Error log use cases:

  1. As a Jr Sys Admin, I need to identify critical errors that require immediate attention, and go through their detailed description, so that I can understand how to resolve them.
  2. As a Jr Sys Admin, I need to check that no new errors were reported after an important service operation, so that I can confirm that the service was successful. 
  3. As a PE, I need to login as a CE and have the customer export/copy detailed error description about few or all errors and send it to me.

Hidden logs use cases:

  1. As a PE, I need to see the non-serviceable events (Hidden and Informational logs) along with the serviceable ones to understand the surrounding details, as frequently a serviceable event has some precursor or run-up events to it.
  2. As a PE, I need the customer to export all the details for all the event logs. They are usually not read from the GUI itself. It is preferred to merge them with the other event logs so as to see them in the same chronological order.

Invision Prototype Guidance

The Invision prototypes have hot spots allowing the reviewer to step through the workflow. To navigate a prototype, you can:

  1. Click on the page and the hotspots will be revealed in blue
  2. Use the arrow-right and arrow-left keys on your keyboard

Design Review Workflow

  1. Each design iteration will have a comment section
  2. The section will include:
    • A title with the iteration number
    • Any description or specific feedback the designer is requesting
    • Screenshots of the workflow
  3. Based on community and user feedback, we create a comment for the new iteration and repeat these steps
ParishrutB commented 3 years ago

Event/error logs & Hidden logs - Iteration 1

Hello everyone, this is the current iteration for event logs and hidden logs. The same table shows both hidden logs and event logs when a CE/Service login credential has been used to log in to this GUI.

Event logs - Main page "Export all log details" and "Delete all logs" are provided at the top of the page as they are one of the key use cases.

image

Event logs - Expansion row

image

Event logs - filters

image

Event logs - batch actions Logs can be marked as resolved or unresolved using the toggle button or in a group using the batch actions.

image

Hidden logs When a user logs in with service credentials, they can see the hidden logs in the same table, in a chronological order along with the other event logs.

image