Feature Request: Sort results of GetTablets so that ListShardTablets is more easily readable/parseable by humans

[lmorduch]

Feature Description

What is the change?

I'm fairly dependent on the ListShardTablets command in my daily workflow. Currently, the order in which the results are listed is non-deterministic, which makes it difficult to scan the results quickly and consistently. It would be nice to be able to deterministically guarantee order by sorting before returning.

Where would it go?

I'm thinking about adding the change within this function:

vitess/go/vt/vtctl/grpcvtctldserver/server.go

Line 2418 in 4f2cd18

return &vtctldatapb.GetTabletsResponse{

Potential Options

To start, I'll probably just submit a default ordering that will order alphabetically by alias. However, if desired we could make this optional behavior and potentially allow for some control over how sorting happens.

Use Case(s)

When calling ListShardTablet, especially multiple times in quick succession, I will be able to scan and grok the results much more easily since they will be returned in an expected and consistent order.

[mattlord]

Hi @lmorduch !

To start, I'll probably just submit a default ordering that will order alphabetically by alias

That sounds good. I thought that we already did that, but perhaps not.

Just FYI, the legacy vtctlclient binary was deprecated in v18 and will be removed in v23. vtctldclient GetTablets is the new equivalent command: https://vitess.io/docs/reference/vtctldclient-transition/

That command does use the noted VtctldServer RPC: https://github.com/vitessio/vitess/blob/main/go/cmd/vtctldclient/command/tablets.go

I assigned this to you for now as you seemed to be interested in opening a PR. Please let me know if I'm mistaken on that point and I'll remove you as the assignee. Please let me know if you need any help.

Thanks again!

[lmorduch]

Hi @lmorduch !

To start, I'll probably just submit a default ordering that will order alphabetically by alias

That sounds good. I thought that we already did that, but perhaps not.

Just FYI, the legacy vtctlclient binary was deprecated in v18 and will be removed in v23. vtctldclient GetTablets is the new equivalent command: https://vitess.io/docs/reference/vtctldclient-transition/

That command does use the noted VtctldServer RPC: https://github.com/vitessio/vitess/blob/main/go/cmd/vtctldclient/command/tablets.go

I assigned this to you for now as you seemed to be interested in opening a PR. Please let me know if I'm mistaken on that point and I'll remove you as the assignee. Please let me know if you need any help.

Thanks again!

Awesome, thank you for taking a look and the pointers/context! I'll make sure to update the commands I'm using as I upgrade to vtctldclient.

I'm definitely down to implement, should have a PR soon!

[dbussink]

Implemented in #17771.