Add Levenshtein Distance Check for 'prometheus' Typo in Monitoring Config File #4102
+33
−2
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.
PR Description:
This PR introduces a check to detect potential typos in the monitoring config file name by calculating the Levenshtein distance between the provided file name and the string
"prometheus". If the distance is 2 or less, a warning will be logged to indicate the possibility of a typo, along with a suggestion to correct the spelling.Background:
I encountered a frustrating bug where a typo in the monitoring config file name led to significant delays in debugging. It took quite a bit of time to realize that the issue stemmed from a simple typographical error when typing
"prometheus".This change is aimed at preventing similar issues in the future by early detection of typos, helping to save time and reduce confusion during troubleshooting.