Skip to content

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

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

muhammadravi251001
Copy link

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.

Copy link

google-cla bot commented Apr 30, 2025

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant