Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Store monitoring outputs in a standardized format #26

Open
luccalb opened this issue Nov 2, 2024 · 2 comments
Open

Store monitoring outputs in a standardized format #26

luccalb opened this issue Nov 2, 2024 · 2 comments
Labels
enhancement New feature or request

Comments

@luccalb
Copy link

luccalb commented Nov 2, 2024

User Story

  1. As a RTDIP engineer
  2. I want to save statistics about my data (like mean, missing data count, etc.) to a persistant storage
  3. So that I can later generate a report from it, without manipulating the original data

Additional context

  • Actually having a persistant DB is not favoured by Shell, as they want the RTDIP users to decide themselves how to use the data
  • We need do develop a standardized data format (either a dataframe or a log file) that all of our monitoring components can use
  • Two ways this could be implemented
    • either write to a shared dataframe directly from each component
    • or first write to a log file, then have a separate component that reads through the log and creates an output dataframe

Acceptance Criteria

  • Data from monitoring components is written to a separate dataframe
  • The data persists outside of the component runtime, for other components to read from, or to create reports from
  • The format of the monitoring output dataframe is standardized and all monitoring components use it
  • The format is document

Definition of Done

  • Test cases have been created and are running successfully
  • Documentation for the new component was added
  • Github Actions are running without errors
@luccalb luccalb added the enhancement New feature or request label Nov 2, 2024
@luccalb
Copy link
Author

luccalb commented Nov 5, 2024

Feedback by shell: Logging results is enough, visualization or databases is out of scope for now

@mollle
Copy link

mollle commented Nov 5, 2024

Apparently a dataframe with the "logs" instead (or in addition) of just logging. for exmple 2 Columns, with component name and then the log message in the other column. the dataframe would be handed from on step to the next one. after all the quality checks we want to hand over a dataframe so the user can then check the data quality and display the data in their way

@luccalb luccalb changed the title Implement a persistance layer Store monitoring outputs in a standardized format Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Product Backlog
Development

No branches or pull requests

2 participants