Log overview and background work #176
Closed
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
|
Thank you for this draft. I reviewed the code and have some suggestions:
|
vogti
reviewed
Jul 17, 2024
libraries/logalyzer.php
Outdated
| $this->job = $job; | ||
| $this->system = new System($this->job->getSystemId()); | ||
| $path = UPLOADED_DATA_PATH . '/log/' . $job->getId() . '.log'; | ||
| $log = Util::readFileContents($path); |
There was a problem hiding this comment.
This looks wrong. Do not read the whole file in the constructor, move to readEntireLog.
vogti
reviewed
Jul 17, 2024
controllers/evaluation.php
Outdated
Comment on lines
162
to
163
| $logUtil = new Logalyzer_Library($subJob); | ||
| $logUtil->examineLogAndSetAlert(); |
There was a problem hiding this comment.
This is an artifact, do not analyze all jobs again every time.
vogti
reviewed
Jul 17, 2024
libraries/logalyzer.php
Outdated
| // Grab keyword arrays at creation of this object. Changes during a job run make the result outdated, but consistent | ||
| $this->warningKeys = json_decode($this->system->getLogalyzerWarningKeywords()); | ||
| $this->errorKeys = json_decode($this->system->getLogalyzerErrorKeywords()); | ||
| $this->calculateAndSetHash(); |
There was a problem hiding this comment.
Do not update the Hash every time you initialize the Logalyzer Lib. Set hash when creating job (or even better when writing the first log line, thus when creating the log file) and after checking the entire file.
vogti
reviewed
Jul 17, 2024
libraries/logalyzer.php
Outdated
| } | ||
| public function examineEntireLog() { | ||
| // Check if there have been changes to the log | ||
| if ($this->checkHashDifference()) { |
vogti
reviewed
Jul 17, 2024
libraries/logalyzer.php
Outdated
| $warningCount = 0; | ||
| $errorCount = 0; | ||
| foreach ($this->warningKeys as $key) { | ||
| if(str_starts_with($key, "/") || str_starts_with($key, "#") || str_starts_with($key, "~")) { |
There was a problem hiding this comment.
Store info whether it is a regex in the json.
vogti
reviewed
Jul 17, 2024
libraries/logalyzer.php
Outdated
| // Log is reexamined using up-to-date keys, save new hash. | ||
| $this->job->setLogalyzerCountWarnings($warningCount); | ||
| $this->job->setLogalyzerCountErrors($errorCount); | ||
| $this->calculateAndSetHash(); |
vogti
reviewed
Jul 17, 2024
libraries/logalyzer.php
Outdated
| public function examineLogLine($logLine) { | ||
| if($this->job->getLogalyzerCountWarnings <= 10) { | ||
| foreach ($this->warningKeys as $key) { | ||
| if (str_starts_with($key, "/") || str_starts_with($key, "#") || str_starts_with($key, "~")) { |
vogti
reviewed
Jul 17, 2024
libraries/logalyzer.php
Outdated
| } | ||
| } | ||
| public function examineLogLine($logLine) { | ||
| if($this->job->getLogalyzerCountWarnings <= 10) { |
There was a problem hiding this comment.
Magic number, take from settings / config.
vogti
reviewed
Jul 17, 2024
libraries/logalyzer.php
Outdated
| * @param string $key name of new keyword | ||
| * @return void | ||
| */ | ||
| public function addKey(string $identifier, string $key) { |
vogti
reviewed
Jul 17, 2024
libraries/logalyzer.php
Outdated
| } | ||
|
|
||
| /** | ||
| * @param string $identifier add $key as warning or error? |
vogti
reviewed
Jul 17, 2024
libraries/logalyzer.php
Outdated
| * @param string $key name of keyword to be deleted | ||
| * @return void | ||
| */ | ||
| public function removeKey(string $identifier, string $key) { |
Add Column to Job: `logalyzerResults` json Remove Column of Job: 'logalyzerCountError' 'logalyzerCountWarning' 'logalyzerContainsMandatory'
Add Column to Job: `logalyzerResults` json Remove Column of Job: 'logalyzerCountError' 'logalyzerCountWarning' 'logalyzerContainsMandatory'
Job log overview fix
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.
Not intended to be merged. It is in a working, but not very useful state.
Many of the fixed values such as 'thresholdError' will be modifiable for each system in the future.
Added functionality to search a log for keywords, count occurances. These features will be expanded upon
Feedback is welcome