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

metrics: support multi-k8s in grafana dashboards (#4658) #4708

Conversation

ti-chi-bot
Copy link
Member

This is an automated cherry-pick of #4658

Signed-off-by: just1900 legendj228@gmail.com

What problem does this PR solve?

K8s community and organizations are increasingly deploying multiple Kubernetes clusters to improve availability, isolation and scalability. Since TiDB Operator have support deploying tidb across-kubernetes, this PR will address the multi-k8s issue without affecting existing single-cluster use case.

Issue Number: close #4665

What is changed and how it works?

What's Changed:

  • add a k8s_cluster label in all expr
  • add k8s_cluster variable in Grafana templating

How it works:

  • For users with single-k8s, nothing need to be changed, just use it as before.
  • For users with multi-k8s:
    • first add kubernetes label to identify k8s cluster in your prometheus' external_labels.
    • set field "hide" to '0' to show variables in grafana via sed -i s/"hide": 2/"hide": 0/g <path/to/dashboard.json>
    • load it to grafana

Check List

Tests

  • Unit test
  • Integration test
  • Manual test (add detailed scripts or steps below)
  • No code

Code changes

  • Has exported function/method change
  • Has exported variable/fields change
  • Has interface methods change
  • Has persistent data change

Side effects

  • Possible performance regression
  • Increased code complexity
  • Breaking backward compatibility

Related changes

  • Need to cherry-pick to the release branch
  • Need to update the documentation
  • Need to update key monitor metrics in both TiCDC document and official document

Release note

metrics: support multi-k8s in grafana dashboards

Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
@ti-chi-bot
Copy link
Member Author

[REVIEW NOTIFICATION]

This pull request has not been approved.

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

@ti-chi-bot
Copy link
Member Author

@ti-chi-bot: This cherry pick PR is for a release branch and has not yet been approved by release team.
Adding the do-not-merge/cherry-pick-not-approved label.

To merge this cherry pick, it must first be approved by the collaborators.

AFTER it has been approved by collaborators, please ping the release team in a comment to request a cherry pick review.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@ti-chi-bot ti-chi-bot added release-note Denotes a PR that will be considered when it comes time to generate release notes. do-not-merge/cherry-pick-not-approved The current cherry-pick pull request has not been approved and cannot be merged. component/metrics-logging Metrics and logging component. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. require-LGT1 Indicates that the PR requires an LGTM. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. status/LGT1 Indicates that a PR has LGTM 1. type/cherry-pick-for-release-5.3 This PR is cherry-picked to release-5.3 from a source PR. labels Feb 26, 2022
@ti-chi-bot ti-chi-bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Feb 26, 2022
@codecov-commenter
Copy link

Codecov Report

❗ No coverage uploaded for pull request base (release-5.3@9c6e109). Click here to learn what that means.
The diff coverage is n/a.

@@               Coverage Diff                @@
##             release-5.3      #4708   +/-   ##
================================================
  Coverage               ?   55.6050%           
================================================
  Files                  ?        222           
  Lines                  ?      23791           
  Branches               ?          0           
================================================
  Hits                   ?      13229           
  Misses                 ?       9231           
  Partials               ?       1331           

@purelind
Copy link
Collaborator

purelind commented Mar 3, 2022

/run-integration-test

@ti-chi-bot ti-chi-bot bot deleted a comment from ti-chi-bot Jul 6, 2023
@ti-chi-bot
Copy link
Contributor

ti-chi-bot bot commented Jul 6, 2023

@ti-chi-bot: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
jenkins-ticdc/verify db08c03 link true /test verify

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@ti-chi-bot
Copy link
Member Author

@ti-chi-bot: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
jenkins-ticdc/verify db08c03 link true /test verify

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@ti-chi-bot ti-chi-bot closed this Dec 1, 2023
@ti-chi-bot
Copy link
Member Author

This pull request is closed because its related version has closed automatic cherry-picking.
If it's still needed, you can reopen it or just regenerate it using bot,
see:

https://prow.tidb.net/command-help#cherrypick
https://book.prow.tidb.net/#/plugins/cherrypicker

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component/metrics-logging Metrics and logging component. do-not-merge/cherry-pick-not-approved The current cherry-pick pull request has not been approved and cannot be merged. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. release-note Denotes a PR that will be considered when it comes time to generate release notes. require-LGT1 Indicates that the PR requires an LGTM. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. status/LGT1 Indicates that a PR has LGTM 1. type/cherry-pick-for-release-5.3 This PR is cherry-picked to release-5.3 from a source PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants