issue: 4176956: move the text handling to the analyzers classes #284
Conversation
This file contains 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
boazhaim
reviewed
Dec 1, 2024
plugins/ufm_log_analyzer_plugin/src/loganalyze/log_analyzers/base_analyzer.py
Outdated
Show resolved
Hide resolved
plugins/ufm_log_analyzer_plugin/src/loganalyze/log_analyzers/events_log_analyzer.py
Outdated
Show resolved
Hide resolved
plugins/ufm_log_analyzer_plugin/src/loganalyze/log_analyzers/base_analyzer.py
Outdated
Show resolved
Hide resolved
plugins/ufm_log_analyzer_plugin/src/loganalyze/log_analyzers/link_flapping_analyzer.py
Outdated
Show resolved
Hide resolved
plugins/ufm_log_analyzer_plugin/src/loganalyze/log_analyzers/ufm_top_analyzer.py
Outdated
Show resolved
Hide resolved
boazhaim
reviewed
Dec 1, 2024
drorlevy
approved these changes
Dec 1, 2024
TalLerner
reviewed
Dec 1, 2024
plugins/ufm_log_analyzer_plugin/src/loganalyze/log_analyzers/console_log_analyzer.py
Show resolved
Hide resolved
...ns/ufm_log_analyzer_plugin/src/loganalyze/log_analyzers/ibdiagnet2_port_counters_analyzer.py
Outdated
Show resolved
Hide resolved
...ns/ufm_log_analyzer_plugin/src/loganalyze/log_analyzers/ibdiagnet2_port_counters_analyzer.py
Outdated
Show resolved
Hide resolved
...ns/ufm_log_analyzer_plugin/src/loganalyze/log_analyzers/ibdiagnet2_port_counters_analyzer.py
Outdated
Show resolved
Hide resolved
...ns/ufm_log_analyzer_plugin/src/loganalyze/log_analyzers/ibdiagnet2_port_counters_analyzer.py
Outdated
Show resolved
Hide resolved
| @@ -85,7 +86,7 @@ def add_list_of_dicts_as_text(self, data_list, title=None, headers=None): | |||
|
|
|||
| def add_dataframe_as_text(self, data_frame, title=None): | |||
| """Adds a DataFrame to the PDF as aligned text without row numbers.""" | |||
| if data_frame is None or data_frame.empty: | |||
| if not isinstance(data_frame, pd.DataFrame) or data_frame.empty: | |||
There was a problem hiding this comment.
if data_frame is None, 'isinstance(data_frame, pd.DataFrame)' will return False
boazhaim
reviewed
Dec 2, 2024
plugins/ufm_log_analyzer_plugin/src/loganalyze/log_analyzers/base_analyzer.py
Show resolved
Hide resolved
plugins/ufm_log_analyzer_plugin/src/loganalyze/log_analyzers/events_log_analyzer.py
Outdated
Show resolved
Hide resolved
TalLerner
requested changes
Dec 2, 2024
| @@ -193,3 +193,34 @@ def get_number_of_core_dumps(self): | |||
| self._log_data_sorted["type"] == "timeout_dump_core" | |||
| ] | |||
| return {"Amount": len(core_dumps)} | |||
|
|
|||
| def full_analysis(self): | |||
There was a problem hiding this comment.
Miryam,
You misunderstood the purpose of the assignment. The base class already created an infrastructure to run the analysis. You should add methods to run as part of the base class full_analysis and NOT implement your own full_analysis method.
If it not clear let talk.
There was a problem hiding this comment.
OK. I changed it
| @@ -33,4 +33,5 @@ def full_analysis(self): | |||
| Returns a list of all the graphs created and their title | |||
| """ | |||
| self.print_fabric_size() | |||
| return [] | |||
| fabric_info = self.get_fabric_size() | |||
There was a problem hiding this comment.
Same thing. Use the infrastructure in the base class to run this.
| @@ -142,5 +142,7 @@ def plot_link_flapping_last_week(self): | |||
| ) | |||
|
|
|||
| def full_analysis(self): | |||
| self.get_link_flapping_last_week() | |||
| return super().full_analysis() | |||
| super().full_analysis() | |||
There was a problem hiding this comment.
Same thing. Use the infrastructure in the base class to run this.
TalLerner
requested changes
Dec 3, 2024
| ) as infile, open( | ||
| temp_file, "w", newline="", encoding=DataConstants.UTF8ENCODING | ||
| ) as outfile: | ||
| with ( |
There was a problem hiding this comment.
Please revert this display
There was a problem hiding this comment.
ruff requires this display
boazhaim
approved these changes
Dec 3, 2024
plugins/ufm_log_analyzer_plugin/src/loganalyze/log_analyzers/base_analyzer.py
Show resolved
Hide resolved
Miryam-Schwartz
force-pushed
the
encapsulation
branch
from
c669d09 to
ba0a836
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What
Move text and dataframes handling from main to the analyzers classes.
Why ?
https://redmine.mellanox.com/issues/4176956
For the sake of code aesthetics, readability, and encapsulation.
How ?
Some sub-classes of BaseAnalyzer class, override the implementation of analysis method, to add their own logic (handle text and dataframes).
Testing ?
Tested manually with various inputs to ensure the output file remains consistent.
Special triggers
Use the following phrases as comments to trigger different runs
bot:retestrerun Jenkins CI (to rerun GitHub CI, use "Checks" tab on PR page and rerun all jobs)bot:upgraderun additional update tests