Skip to content

[UX-508] added json/yaml formatting to rpk group describe command#27647

Merged
r-vasquez merged 1 commit intoredpanda-data:devfrom
alextreichler:feat/add-group-describe-formatter
Oct 9, 2025
Merged

[UX-508] added json/yaml formatting to rpk group describe command#27647
r-vasquez merged 1 commit intoredpanda-data:devfrom
alextreichler:feat/add-group-describe-formatter

Conversation

@alextreichler
Copy link
Copy Markdown
Contributor

@alextreichler alextreichler commented Sep 20, 2025

Some customers may find it useful to be able to see the output of certain rpk commands in either json or yaml, as it is easier to parse using other tools. This feature adds the ability to output rpk group describe ... as json or yaml output using our global --formatter flag.

Fixes UX-508

Example json formatting:


rpk group describe abc --format help
{
  group_name: string
  coordinator_partition: string
  state: string
  balancer: string
  members: int
  coordinator_node: int
  total_lag: int
  partitions: []{
    partition: int
    current_offset: int
    log_start_offset: int
    log_end_offset: int
    lag: int
    topic: string
    member_id: string
    client_id: string
    host: string
  }
  members_details: []{
    member_id: string
    client_id: string
    host: string
    topic_partitions: []{
      topic: string
      partition: int
    }
  }
}

Backports Required

  • none - not a bug fix
  • none - this is a backport
  • none - issue does not exist in previous branches
  • none - papercut/not impactful enough to backport
  • v25.2.x
  • v25.1.x
  • v24.3.x

Release Notes

  • Added the ability to output rpk group describe ... --formatted json as json or yaml using the --formatted flag.

Bug Fixes

Features

  • Added the ability to output rpk group describe ... --formatted json as json or yaml using the --formatted flag.

Improvements

@vbotbuildovich
Copy link
Copy Markdown
Collaborator

Retry command for Build#72625

please wait until all jobs are finished before running the slash command

/ci-repeat 1
tests/rptest/tests/cluster_quota_test.py::ClusterRateQuotaTest.test_client_response_throttle_mechanism_applies_to_next_request

@vbotbuildovich
Copy link
Copy Markdown
Collaborator

vbotbuildovich commented Sep 20, 2025

CI test results

test results on build#72625
test_class test_method test_arguments test_kind job_url test_status passed reason test_history
EndToEndCloudTopicsTxTest test_write null integration https://buildkite.com/redpanda/redpanda/builds/72625#01996495-8e16-4865-a1ae-6021fc0ea0a8 FLAKY 17/21 upstream reliability is '93.69369369369369'. current run reliability is '80.95238095238095'. drift is 12.74131 and the allowed drift is set to 50. The test should PASS https://redpanda.metabaseapp.com/dashboard/87-tests?tab=142-dt-individual-test-history&test_class=EndToEndCloudTopicsTxTest&test_method=test_write
ClusterRateQuotaTest test_client_group_consume_rate_throttle_mechanism null integration https://buildkite.com/redpanda/redpanda/builds/72625#01996495-8e16-4865-a1ae-6021fc0ea0a8 FLAKY 17/21 upstream reliability is '98.42931937172776'. current run reliability is '80.95238095238095'. drift is 17.47694 and the allowed drift is set to 50. The test should PASS https://redpanda.metabaseapp.com/dashboard/87-tests?tab=142-dt-individual-test-history&test_class=ClusterRateQuotaTest&test_method=test_client_group_consume_rate_throttle_mechanism
ClusterRateQuotaTest test_client_response_throttle_mechanism_applies_to_next_request null integration https://buildkite.com/redpanda/redpanda/builds/72625#01996495-8e10-49a9-9660-ac5fef426497 FLAKY 13/21 upstream reliability is '100.0'. current run reliability is '61.904761904761905'. drift is 38.09524 and the allowed drift is set to 50. The test should PASS https://redpanda.metabaseapp.com/dashboard/87-tests?tab=142-dt-individual-test-history&test_class=ClusterRateQuotaTest&test_method=test_client_response_throttle_mechanism_applies_to_next_request
ClusterRateQuotaTest test_client_response_throttle_mechanism_applies_to_next_request null integration https://buildkite.com/redpanda/redpanda/builds/72625#0199649b-e6ef-4f39-90c7-769609fbd9d7 FLAKY 9/21 upstream reliability is '100.0'. current run reliability is '42.857142857142854'. drift is 57.14286 and the allowed drift is set to 50. The test should FAIL https://redpanda.metabaseapp.com/dashboard/87-tests?tab=142-dt-individual-test-history&test_class=ClusterRateQuotaTest&test_method=test_client_response_throttle_mechanism_applies_to_next_request
RecoveryModeTest test_rolling_restart null integration https://buildkite.com/redpanda/redpanda/builds/72625#01996495-8e10-49a9-9660-ac5fef426497 FLAKY 17/21 upstream reliability is '100.0'. current run reliability is '80.95238095238095'. drift is 19.04762 and the allowed drift is set to 50. The test should PASS https://redpanda.metabaseapp.com/dashboard/87-tests?tab=142-dt-individual-test-history&test_class=RecoveryModeTest&test_method=test_rolling_restart
WriteCachingFailureInjectionTest test_unavoidable_data_loss null integration https://buildkite.com/redpanda/redpanda/builds/72625#01996495-8e0f-487a-bf90-13e5f8cfdbb8 FLAKY 19/21 upstream reliability is '97.41935483870968'. current run reliability is '90.47619047619048'. drift is 6.94316 and the allowed drift is set to 50. The test should PASS https://redpanda.metabaseapp.com/dashboard/87-tests?tab=142-dt-individual-test-history&test_class=WriteCachingFailureInjectionTest&test_method=test_unavoidable_data_loss
test results on build#72636
test_class test_method test_arguments test_kind job_url test_status passed reason test_history
EndToEndCloudTopicsTest test_write null integration https://buildkite.com/redpanda/redpanda/builds/72636#01996891-ea0f-4a72-8ad3-9ff597297789 FLAKY 12/21 upstream reliability is '94.58823529411765'. current run reliability is '57.14285714285714'. drift is 37.44538 and the allowed drift is set to 50. The test should PASS https://redpanda.metabaseapp.com/dashboard/87-tests?tab=142-dt-individual-test-history&test_class=EndToEndCloudTopicsTest&test_method=test_write
ShadowLinkConsumeGroupsMirroringTest test_continuous_group_sync {"source_cluster_spec": {"cluster_type": "redpanda"}, "with_failures": true} integration https://buildkite.com/redpanda/redpanda/builds/72636#01996898-cb3c-4688-b270-f05d60eaf234 FLAKY 15/21 upstream reliability is '91.44981412639405'. current run reliability is '71.42857142857143'. drift is 20.02124 and the allowed drift is set to 50. The test should PASS https://redpanda.metabaseapp.com/dashboard/87-tests?tab=142-dt-individual-test-history&test_class=ShadowLinkConsumeGroupsMirroringTest&test_method=test_continuous_group_sync
ClusterRateQuotaTest test_client_group_produce_rate_throttle_mechanism null integration https://buildkite.com/redpanda/redpanda/builds/72636#01996891-ea04-4855-b971-cf0ad24dcc83 FLAKY 16/21 upstream reliability is '97.75'. current run reliability is '76.19047619047619'. drift is 21.55952 and the allowed drift is set to 50. The test should PASS https://redpanda.metabaseapp.com/dashboard/87-tests?tab=142-dt-individual-test-history&test_class=ClusterRateQuotaTest&test_method=test_client_group_produce_rate_throttle_mechanism
ClusterRateQuotaTest test_client_group_produce_rate_throttle_mechanism null integration https://buildkite.com/redpanda/redpanda/builds/72636#01996898-cb36-4a2f-9992-f70e4d905efe FLAKY 14/21 upstream reliability is '97.75'. current run reliability is '66.66666666666666'. drift is 31.08333 and the allowed drift is set to 50. The test should PASS https://redpanda.metabaseapp.com/dashboard/87-tests?tab=142-dt-individual-test-history&test_class=ClusterRateQuotaTest&test_method=test_client_group_produce_rate_throttle_mechanism
ClusterRateQuotaTest test_client_response_throttle_mechanism_applies_to_next_request null integration https://buildkite.com/redpanda/redpanda/builds/72636#01996898-cb3a-466f-8379-e713c53f49ec FLAKY 18/21 upstream reliability is '98.44155844155844'. current run reliability is '85.71428571428571'. drift is 12.72727 and the allowed drift is set to 50. The test should PASS https://redpanda.metabaseapp.com/dashboard/87-tests?tab=142-dt-individual-test-history&test_class=ClusterRateQuotaTest&test_method=test_client_response_throttle_mechanism_applies_to_next_request
NodeWiseRecoveryTest test_recovery_local_data_missing {"wait_for_final_manifest_uploads": true} integration https://buildkite.com/redpanda/redpanda/builds/72636#01996891-ea05-43c0-a7e7-64cee4489f31 FLAKY 8/21 upstream reliability is '95.77464788732394'. current run reliability is '38.095238095238095'. drift is 57.67941 and the allowed drift is set to 50. The test should FAIL https://redpanda.metabaseapp.com/dashboard/87-tests?tab=142-dt-individual-test-history&test_class=NodeWiseRecoveryTest&test_method=test_recovery_local_data_missing
NodeWiseRecoveryTest test_recovery_local_data_missing {"wait_for_final_manifest_uploads": true} integration https://buildkite.com/redpanda/redpanda/builds/72636#01996898-cb37-4838-be63-1196f35a2fbb FLAKY 18/21 upstream reliability is '95.77464788732394'. current run reliability is '85.71428571428571'. drift is 10.06036 and the allowed drift is set to 50. The test should PASS https://redpanda.metabaseapp.com/dashboard/87-tests?tab=142-dt-individual-test-history&test_class=NodeWiseRecoveryTest&test_method=test_recovery_local_data_missing
DisablingPartitionsTest test_disable null integration https://buildkite.com/redpanda/redpanda/builds/72636#01996891-ea0e-4fc5-b1aa-4a674956cfe7 FLAKY 13/21 upstream reliability is '97.07207207207207'. current run reliability is '61.904761904761905'. drift is 35.16731 and the allowed drift is set to 50. The test should PASS https://redpanda.metabaseapp.com/dashboard/87-tests?tab=142-dt-individual-test-history&test_class=DisablingPartitionsTest&test_method=test_disable

@alextreichler alextreichler force-pushed the feat/add-group-describe-formatter branch from 3f2ab7a to 6ecb1e9 Compare September 20, 2025 18:58
@alextreichler alextreichler changed the title added json/yaml formatting to rpk group describe command [UX-508] added json/yaml formatting to rpk group describe command Sep 20, 2025
@vbotbuildovich
Copy link
Copy Markdown
Collaborator

Retry command for Build#72636

please wait until all jobs are finished before running the slash command

/ci-repeat 1
tests/rptest/tests/partition_force_reconfiguration_test.py::NodeWiseRecoveryTest.test_recovery_local_data_missing@{"wait_for_final_manifest_uploads":true}

@alextreichler alextreichler force-pushed the feat/add-group-describe-formatter branch from 6ecb1e9 to e7f2166 Compare September 30, 2025 23:48
@alextreichler alextreichler force-pushed the feat/add-group-describe-formatter branch from e7f2166 to c0846b8 Compare September 30, 2025 23:54
@r-vasquez r-vasquez merged commit 0e2b837 into redpanda-data:dev Oct 9, 2025
23 checks passed
@vbotbuildovich
Copy link
Copy Markdown
Collaborator

/backport v25.2.x

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants