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

Add api end point to print the current database state in VTOrc #15485

Merged
merged 3 commits into from
Mar 28, 2024

Conversation

GuptaManan100
Copy link
Member

@GuptaManan100 GuptaManan100 commented Mar 14, 2024

Description

This PR adds a new API endpoint for VTOrc, that allows the users to see the current database state of the instance. This is useful for debugging.

The new endpoint is /api/database-state and it looks like -

Screenshot 2024-03-21 at 12 21 44 PM

Screenshot 2024-03-21 at 12 21 51 PM

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required - Add docs for the new /api/database-state api endpoint website#1705

Deployment Notes

@GuptaManan100 GuptaManan100 added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VTorc Vitess Orchestrator integration labels Mar 14, 2024
Copy link
Contributor

vitess-bot bot commented Mar 14, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Mar 14, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone Mar 14, 2024
@GuptaManan100 GuptaManan100 removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Mar 14, 2024
Copy link

codecov bot commented Mar 14, 2024

Codecov Report

Attention: Patch coverage is 64.28571% with 10 lines in your changes are missing coverage. Please review.

Project coverage is 65.73%. Comparing base (d1d1901) to head (1716eec).
Report is 25 commits behind head on main.

Files Patch % Lines
go/vt/vtorc/server/api.go 11.11% 8 Missing ⚠️
go/vt/vtorc/inst/instance_dao.go 89.47% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #15485      +/-   ##
==========================================
+ Coverage   65.65%   65.73%   +0.08%     
==========================================
  Files        1563     1560       -3     
  Lines      194414   194572     +158     
==========================================
+ Hits       127640   127902     +262     
+ Misses      66774    66670     -104     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

go/vt/vtorc/inst/instance_dao.go Outdated Show resolved Hide resolved
go/vt/vtorc/inst/instance_dao.go Outdated Show resolved Hide resolved
Copy link
Member

@deepthi deepthi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Just one question about possibly unused tables.

go/vt/vtorc/db/generate_base.go Show resolved Hide resolved
@GuptaManan100 GuptaManan100 merged commit 2078d62 into vitessio:main Mar 28, 2024
102 checks passed
@GuptaManan100 GuptaManan100 deleted the vtorc-dbinfo branch March 28, 2024 05:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: VTorc Vitess Orchestrator integration Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature Request: VTOrc database state as an API
3 participants