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

VTAdmin: Distributed transactions list on VTAdmin #16793

Merged
merged 8 commits into from
Sep 20, 2024

Conversation

beingnoble03
Copy link
Member

@beingnoble03 beingnoble03 commented Sep 16, 2024

Description

  • Includes TimeCreated while querying unresolved transactions
  • Adds VTAdmin API endpoint to fetch the transactions by keyspace
  • Initiates the Transactions screen on VTAdmin web.

Sample output from API:

{
    "result": {
        "transactions": [
            {
                "dtid": "1",
                "state": 1,
                "participants": [
                    {
                        "keyspace": "commerce",
                        "shard": "0",
                        "tablet_type": 1
                    }
                ]
            },
            {
                "dtid": "2",
                "state": 1,
                "participants": [
                    {
                        "keyspace": "commerce",
                        "shard": "0",
                        "tablet_type": 1
                    }
                ]
            }
        ]
    },
    "ok": true
}

Related Issue(s)

Screenshots

image Screenshot 2024-09-20 at 2 10 49 AM

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

Deployment Notes

…pace

Signed-off-by: Noble Mittal <noblemittal@outlook.com>
Copy link
Contributor

vitess-bot bot commented Sep 16, 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 Sep 16, 2024
@github-actions github-actions bot added this to the v21.0.0 milestone Sep 16, 2024
@beingnoble03 beingnoble03 added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VTAdmin VTadmin interface and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says 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 Sep 16, 2024
Copy link

codecov bot commented Sep 16, 2024

Codecov Report

Attention: Patch coverage is 20.83333% with 19 lines in your changes missing coverage. Please review.

Project coverage is 69.51%. Comparing base (56c39b2) to head (b1918eb).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtadmin/api.go 7.69% 12 Missing ⚠️
go/vt/vtadmin/http/transactions.go 0.00% 7 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16793      +/-   ##
==========================================
- Coverage   69.53%   69.51%   -0.02%     
==========================================
  Files        1567     1568       +1     
  Lines      202388   202423      +35     
==========================================
- Hits       140723   140708      -15     
- Misses      61665    61715      +50     

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

Signed-off-by: Noble Mittal <noblemittal@outlook.com>
@beingnoble03 beingnoble03 changed the title VTAdmin(API): GetUnresolvedTransactions to fetch transactions by keyspace VTAdmin: Distributed transactions list on VTAdmin Sep 18, 2024
@harshit-gangal
Copy link
Member

We should call it In Flight Distributed Transactions on the Transactions page.
Also, we can ignore the tablet type information of the shard as all will be Primary only.

@harshit-gangal
Copy link
Member

We should also display the age of the transaction to know from how long the transaction is unresolved.

Signed-off-by: Noble Mittal <noblemittal@outlook.com>
…ng UnresolvedTransactions

Signed-off-by: Noble Mittal <noblemittal@outlook.com>
Signed-off-by: Noble Mittal <noblemittal@outlook.com>
Signed-off-by: Noble Mittal <noblemittal@outlook.com>
Signed-off-by: Noble Mittal <noblemittal@outlook.com>
Signed-off-by: Noble Mittal <noblemittal@outlook.com>
Copy link
Member

@harshit-gangal harshit-gangal left a comment

Choose a reason for hiding this comment

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

When we call for getting unresolved transactions for a keyspace.
There is a request parameter called abandonAge.
We should use that and may be provide options to user to tell how old the transaction should be to display on VTAdmin.
5s, 30s, 5min, etc.

@harshit-gangal
Copy link
Member

This can also be done in a follow up PR.

@harshit-gangal harshit-gangal merged commit e68bdd5 into vitessio:main Sep 20, 2024
99 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: VTAdmin VTadmin interface Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants