-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Vtadmin monitoring integration #19000
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
c-r-dev
wants to merge
3
commits into
vitessio:main
Choose a base branch
from
c-r-dev:vtadmin-monitoring-integration
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: crangavajha1 <[email protected]>
Signed-off-by: crangavajha1 <[email protected]>
Contributor
Review ChecklistHello reviewers! 👋 Please follow this checklist when reviewing this Pull Request. General
Tests
Documentation
New flags
If a workflow is added or modified:
Backward compatibility
|
Contributor
|
📝 Documentation updates detected! New suggestion: Add changelog entry for VTAdmin monitoring integration |
Contributor
|
📝 Documentation updates detected! New suggestion: Document VTAdmin monitoring integration |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
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.
Description
This PR implements the frontend support for integrating external monitoring tools (like Grafana and PMM) directly into VTAdmin, addressing some of the goals outlined in RFC: Integrate PMM into vtadmin (#11191).
Added a flexible, configuration-driven mechanism to link VTAdmin entities (Clusters, Tablets, Gates) to external dashboards. This allows VTAdmin to serve as a "single view" for Vitess operations, enabling users to navigate seamlessly from topology views to deep-dive metrics.
Introduced new environment variables to define dashboard URL patterns. These templates support dynamic placeholders that are replaced with context-specific data at runtime.
VITE_VITESS_MONITORING_CLUSTER_TEMPLATE: For cluster-level metrics.VITE_VITESS_MONITORING_VTTABLET_TEMPLATE: For tablet metrics.VITE_VITESS_MONITORING_VTGATE_TEMPLATE: For vtgate metrics.VITE_MYSQL_MONITORING_TEMPLATE: For underlying MySQL instance metrics (e.g., PMM).Supported Placeholders:
{cluster},{keyspace},{shard},{alias},{hostname},{type},{cell},{pool}.UI Integration
vtctld.vtgate.Demo & Verification
To demonstrate this functionality and provide a reference implementation, I have updated the
examples/vtadmindirectory.docker-composesetup with Prometheus, Grafana, and PMM running alongside Vitess.docker-compose.ymlis pre-wired with the newVITE_variables to link VTAdmin to the local monitoring stack.cd examples/vtadmin make upmonitoring_links_demo.mp4
Fixes: #11191