search

darshan-hpc / darshan

Darshan I/O characterization tool
Other
56 stars 27 forks source link

ENH: Add warnings/error box to summary report #653

Open nawtrey opened 2 years ago

nawtrey commented 2 years ago

There has been some discussion about a central location in the report to store errors or warnings associated with the report. It seems the current plan is to have a scrollable "Warnings" box where error messages can be added. This would likely go at the top of the report so users see it first.

Issue #630 is a good use case for this, and working on it I came up with the following:

Screen Shot 2022-02-10 at 3 08 08 PM

I'm not sure if we want to use the warning symbols for each entry or how we want it to look, I just copied the partial data flag and changed the message.

With the exception of support for storing warnings in the ReportData object, the diff that covers adding a basic warning box is shown below.

```diff diff --git a/darshan-util/pydarshan/darshan/cli/base.html b/darshan-util/pydarshan/darshan/cli/base.html index 1d19391..ce51a21 100644 --- a/darshan-util/pydarshan/darshan/cli/base.html +++ b/darshan-util/pydarshan/darshan/cli/base.html @@ -19,6 +19,18 @@

Darshan Summary Report

+ % if report_data.flags: + +
+

Warnings

+
+ % for flag in report_data.flags: + ${flag} + % endfor +
+
+ % endif +

Log Details

diff --git a/darshan-util/pydarshan/darshan/cli/style.css b/darshan-util/pydarshan/darshan/cli/style.css index 45d652a..cd7e73c 100644 --- a/darshan-util/pydarshan/darshan/cli/style.css +++ b/darshan-util/pydarshan/darshan/cli/style.css @@ -35,6 +35,12 @@ table { .fixed-footer{ bottom: 0; } +.warning-box{ + height: 100px; + width: 350px; + border: 1px solid #ddd; + overflow: auto; +} figure { text-align: center; } ```
carns commented 2 years ago

Sounds good. And the warnings box will not be rendered in the report unless there is something in it, right?

I like the symbols.

Not the point of this issue, but the example message here would probably be "The DXT_POSIX heatmap figure may not have sufficient resolution to display I/O activity from all 5000 processes. If you need to see more detail in this figure, please ."

carns commented 2 years ago

github ate the characters I had at the end of that last sentence, but I just meant we should fill in a specific suggestion there once we have one :)

nawtrey commented 2 years ago

And the warnings box will not be rendered in the report unless there is something in it, right?

That is correct.

And yeah the message will have to be updated, but the nice thing is we will have a lot of room if we want to include longer messages.