Skip to content
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

[ISSUE #12196] FIX prometheus http sd invalid label names #12239

Merged
merged 2 commits into from
Jul 1, 2024

Conversation

taomaree
Copy link
Contributor

Please do not create a Pull Request without creating an issue first.

What is the purpose of the change

fix #12196

Brief changelog

prometheus http sd contains label names with "." and "-", which can not parsed by prometheus, this commit auto connvert invalid words to "_" to make prometheus happy.

label "preserved.register.source":"SPRING_CLOUD" is auto added by nacos sdk,
and another example is label "management.endpoints.web.base-path":"/xxxx" , which auto exported by nacos sdk, label name contains two invalid words . and - .
above 2 label name are not controlled or registered by enduser, and prometheus can't parse these label names, then this scrape job failed, this job results show nothing.

this commit convert label name from . and - words to_ in prometheus/src/main/java/com/alibaba/nacos/prometheus/utils/PrometheusUtils.java only affect prometheus exporter info.

Verifying this change

test pass with latest prometheus.

Follow this checklist to help us incorporate your contribution quickly and easily:

  • Make sure there is a Github issue filed for the change (usually before you start working on it). Trivial changes like typos do not require a Github issue. Your pull request should address just this issue, without pulling in other changes - one PR resolves one issue.
  • Format the pull request title like [ISSUE #123] Fix UnknownException when host config not exist. Each commit in the pull request should have a meaningful subject line and body.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Write necessary unit-test to verify your logic correction, more mock a little better when cross module dependency exist. If the new feature or significant change is committed, please remember to add integration-test in test module.
  • Run mvn -B clean package apache-rat:check findbugs:findbugs -Dmaven.test.skip=true to make sure basic checks pass. Run mvn clean install -DskipITs to make sure unit-test pass. Run mvn clean test-compile failsafe:integration-test to make sure integration-test pass.

@CLAassistant
Copy link

CLAassistant commented Jun 16, 2024

CLA assistant check
All committers have signed the CLA.

@KomachiSion
Copy link
Collaborator

Can you add an switch for adding metadata to labels?

@taomaree
Copy link
Contributor Author

Can you add an switch for adding metadata to labels?

it's a little complicated for me, sorry.

KomachiSion
KomachiSion previously approved these changes Jun 24, 2024
@KomachiSion KomachiSion added plugin kind/bug Category issues or prs related to bug. labels Jun 24, 2024
@KomachiSion KomachiSion added this to the 2.4.0 milestone Jun 24, 2024
@taomaree
Copy link
Contributor Author

taomaree commented Jun 24, 2024

@KomachiSion 麻烦再看看

@KomachiSion KomachiSion merged commit 92a3d17 into alibaba:develop Jul 1, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Category issues or prs related to bug. plugin
Projects
None yet
Development

Successfully merging this pull request may close these issues.

nacos uses 'http_sd_configs' which is not well adapted to prometheus
3 participants