serving icon indicating copy to clipboard operation
serving copied to clipboard

Add Levenshtein Distance Check for 'prometheus' Typo in Monitoring Config File

Open muhammadravi251001 opened this issue 10 months ago • 1 comments

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.

muhammadravi251001 avatar Apr 30 '25 15:04 muhammadravi251001

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

google-cla[bot] avatar Apr 30 '25 15:04 google-cla[bot]