Collect log information in `hdf5`
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 287
- Forks
- 109
- Avg merge
- 4d 41m
- Merged PRs (30d)
- 5
Description
@jeannepellerin reported that users wanted logs that were closer to what they're used to.
There was a proposition (@rrsettgast @castelletto1) to store all the log information into an hdf5 file.
Therefore, no information is lost and any program is able to extract the information and transform it into the desired format as a post-processing step.
As such, only a minimal amount of log is required on screen. Hopefully, everyone can benefit from it.
If we still want live logs, if we use the TimeHistory feature to gather the information, we can maybe implement a derived class that could dump some information on screen, while still saving the data in hdf5. That way, we could have more loquacious logs if needed.
We could have different flavours of those derived classes, depending on what the user wants (engineer, HPC scientist...).
Since all the data are stored, no need to parse the logs.
Note also that we may have issues with some logs systems of some of our TPLs which we do not all control.
Blocked by https://github.com/GEOSX/GEOSX/issues/2289 since we cannot store all kinds of data yet.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files or tests are named. Start by reviewing the TimeHistory feature and the storage limitation tracked in issue 2289; determine how log information can be retained in an hdf5 file and whether derived classes can provide optional live output. Done means the logging data is preserved for post-processing while supporting the requested minimal or more verbose displays.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- observability
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100