surface warnings in the report dashboard - #127
Open
Nina-mvH wants to merge 4 commits into
Open
Conversation
Preliminary attempt at adding a warnigns section to the report dashboard. If any of the successful files contained warnings, this section will print (per task, the total num warnings, min, max, and average). Changes include: * FileMetics updated to have default values (revisit) * _parse_all_metrics updated to search for warnings (edge cases) * _compute_warning_summary added Things that need to be cleaned up: * Clarify if warnings should be counted if file failed * Add path to log file * Clean up printing (ie. formatting and decimal points) * Address edge cases in models.py code
Now, the warnigng information is stored in the format:
{"task_name":{"num_files_processed":0, "num_warnings":0}.
Instead of the warnings being associated with specific files,
they are simply summed at the task level. This means
concurrently running files will not cause issues and is overall
less brittle than the previous approach.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Surfaces warnings found in the log files in the report dashboard:
To do this, the log(s) are parsed, similarly to the
metricsparsing, and each timeWARNINGis encountered, the count increases by one (unless the warning is about shutting down). In the same dictionary, a count is kept of the total number of files processed (using number ofMETRICSlines) to print the "across N file(s)" information.@yoonspark I plan to add some unit tests to this PR, but I just wanted to get your feedback on the design/approach before implementing those.
Closes #97