VReplication: Add support for verbosity level in Workflow Show commands

[mattlord]

Description

The VReplication workflow show related commands have become MUCH more verbose than they were before v18.0 and the switch from vtctlclient to vtctldclient. This information can certainly be useful/helpful, but in most cases it's unneeded and makes it much harder to find what info you do actually want. This PR adds a --verbosity-level flag to the related commands so that you can limit how much information is returned and displayed.

Note

I plan to create a follow-up PR to this one which also changes the default for the --include-logs flag to false. Much more often than not, this adds a LOT of noise to the output and makes it harder to find what you're looking for.

Manual test and example output

cd examples/local
./101_initial_cluster.sh && mysql -e 'insert into customer values (3, "mlord3@planetscale.com"), (13, "mlord13@planetscale.com"), (6, "mlord6@planetscale.com"), (8, "mlord8@planetscale.com")' && ./201_customer_tablets.sh && ./202_move_tables.sh

# Including this command here just to remind people that it exists. It is very compact and
# human oriented and may be the best option in some cases.
❯ vtctldclient MoveTables --workflow commerce2customer --target-keyspace customer status
The following vreplication streams exist for workflow customer.commerce2customer:

id=1 on customer/zone1-200: Status: Running. VStream Lag: 0s.

Traffic State: Reads Not Switched. Writes Not Switched

❯ vtctldclient MoveTables --workflow commerce2customer --target-keyspace customer show --include-logs=false --verbosity-level MINIMAL
{
  "workflows": [
    {
      "name": "commerce2customer",
      "source": {
        "keyspace": "commerce"
      },
      "target": {
        "keyspace": "customer"
      },
      "shard_streams": {
        "0/zone1-0000000200": {
          "streams": [
            {
              "id": "1",
              "shard": "0",
              "tablet": {
                "cell": "zone1",
                "uid": 200
              },
              "state": "Running"
            }
          ]
        }
      },
      "workflow_type": "MoveTables"
    }
  ]
}

❯ vtctldclient MoveTables --workflow commerce2customer --target-keyspace customer show --include-logs=false --verbosity-level LOW
{
  "workflows": [
    {
      "name": "commerce2customer",
      "source": {
        "keyspace": "commerce"
      },
      "target": {
        "keyspace": "customer"
      },
      "shard_streams": {
        "0/zone1-0000000200": {
          "streams": [
            {
              "id": "1",
              "shard": "0",
              "tablet": {
                "cell": "zone1",
                "uid": 200
              },
              "position": "f795352a-ee01-11ef-bb94-144e4a8bdaa3:1-34",
              "state": "Running",
              "transaction_timestamp": {},
              "time_updated": {
                "seconds": "1739887902"
              }
            }
          ]
        }
      },
      "workflow_type": "MoveTables"
    }
  ]
}

❯ vtctldclient MoveTables --workflow commerce2customer --target-keyspace customer show --include-logs=false --verbosity-level MEDIUM
{
  "workflows": [
    {
      "name": "commerce2customer",
      "source": {
        "keyspace": "commerce",
        "shards": [
          "0"
        ]
      },
      "target": {
        "keyspace": "customer",
        "shards": [
          "0"
        ]
      },
      "max_v_replication_lag": "1",
      "shard_streams": {
        "0/zone1-0000000200": {
          "streams": [
            {
              "id": "1",
              "shard": "0",
              "tablet": {
                "cell": "zone1",
                "uid": 200
              },
              "binlog_source": {
                "keyspace": "commerce",
                "shard": "0",
                "filter": {
                  "rules": [
                    {
                      "match": "corder",
                      "filter": "select * from corder"
                    },
                    {
                      "match": "customer",
                      "filter": "select * from customer"
                    }
                  ]
                }
              },
              "position": "f795352a-ee01-11ef-bb94-144e4a8bdaa3:1-34",
              "state": "Running",
              "transaction_timestamp": {},
              "time_updated": {
                "seconds": "1739887905"
              }
            }
          ]
        }
      },
      "workflow_type": "MoveTables",
      "max_v_replication_transaction_lag": "1"
    }
  ]
}

❯ vtctldclient MoveTables --workflow commerce2customer --target-keyspace customer show --include-logs=false --verbosity-level HIGH
{
  "workflows": [
    {
      "name": "commerce2customer",
      "source": {
        "keyspace": "commerce",
        "shards": [
          "0"
        ]
      },
      "target": {
        "keyspace": "customer",
        "shards": [
          "0"
        ]
      },
      "max_v_replication_lag": "1",
      "shard_streams": {
        "0/zone1-0000000200": {
          "streams": [
            {
              "id": "1",
              "shard": "0",
              "tablet": {
                "cell": "zone1",
                "uid": 200
              },
              "binlog_source": {
                "keyspace": "commerce",
                "shard": "0",
                "filter": {
                  "rules": [
                    {
                      "match": "corder",
                      "filter": "select * from corder"
                    },
                    {
                      "match": "customer",
                      "filter": "select * from customer"
                    }
                  ]
                }
              },
              "position": "f795352a-ee01-11ef-bb94-144e4a8bdaa3:1-34",
              "state": "Running",
              "db_name": "vt_customer",
              "transaction_timestamp": {},
              "time_updated": {
                "seconds": "1739887908"
              },
              "tags": [
                ""
              ],
              "tablet_types": [
                "REPLICA",
                "PRIMARY"
              ],
              "cells": [
                "zone1"
              ]
            }
          ],
          "tablet_controls": [
            {
              "tablet_type": "PRIMARY",
              "denied_tables": [
                "corder",
                "customer"
              ]
            }
          ],
          "is_primary_serving": true
        }
      },
      "workflow_type": "MoveTables",
      "workflow_sub_type": "None",
      "max_v_replication_transaction_lag": "1",
      "options": {
        "sharded_auto_increment_handling": "REMOVE"
      }
    }
  ]
}

Related Issue(s)

• Fixes: VReplication Workflow Show: allow getting a subset of information #17737

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

[vitess-bot]

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.

[codecov]

Codecov Report

Attention: Patch coverage is 73.39450% with 29 lines in your changes missing coverage. Please review.

Project coverage is 67.44%. Comparing base (70114ad) to head (6ebd054).
Report is 194 commits behind head on main.

Files with missing lines	Patch %	Lines
go/cmd/vtctldclient/cli/pflag.go	45.45%	12 Missing ⚠️
go/vt/vtctl/workflow/workflows.go	84.05%	11 Missing ⚠️
...d/vtctldclient/command/vreplication/common/show.go	50.00%	2 Missing ⚠️
go/vt/vtadmin/cluster/cluster.go	50.00%	2 Missing ⚠️
.../vtctldclient/command/vreplication/workflow/get.go	0.00%	1 Missing ⚠️
...vtctldclient/command/vreplication/workflow/show.go	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #17799      +/-   ##
==========================================
- Coverage   67.94%   67.44%   -0.51%     
==========================================
  Files        1586     1592       +6     
  Lines      255224   258110    +2886     
==========================================
+ Hits       173420   174079     +659     
- Misses      81804    84031    +2227     

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[notfelineit]

For existing systems that rely on Workflow Show, to maintain old behavior, should we pass verbosity level HIGH?

[mattlord]

For existing systems that rely on Workflow Show, to maintain old behavior, should we pass verbosity level HIGH?

Yep! I updated VTAdmin accordingly in this PR.

[github-actions]

This PR is being marked as stale because it has been open for 30 days with no activity. To rectify, you may do any of the following:

• Push additional commits to the associated branch.
• Remove the stale label.
• Add a comment indicating why it is not stale.

If no action is taken within 7 days, this PR will be closed.

[github-actions]

This PR is being marked as stale because it has been open for 30 days with no activity. To rectify, you may do any of the following:

• Push additional commits to the associated branch.
• Remove the stale label.
• Add a comment indicating why it is not stale.

If no action is taken within 7 days, this PR will be closed.

[github-actions]

This PR is being marked as stale because it has been open for 30 days with no activity. To rectify, you may do any of the following:

• Push additional commits to the associated branch.
• Remove the stale label.
• Add a comment indicating why it is not stale.

If no action is taken within 7 days, this PR will be closed.

[github-actions]

This PR was closed because it has been stale for 7 days with no activity.