rpk: add 'rpk sql debug bundle' for Oxla diagnostics#31078
Open
Bixkog wants to merge 1 commit into
Open
Conversation
|
|
New standalone command that collects a read-only debug bundle from an Oxla (SQL) cluster over the oxla.admin.v1.DebugService admin API. It seeds from --admin-hosts (default localhost:9090), discovers the cluster via GetClusterNodes, and fans out per-node collection (config, logs, host probes, resource usage, a Prometheus /metrics time series) plus cluster-wide artifacts (topology, catalog head), writing a ZIP under an sql/ subtree with a manifest.json and a per-RPC errors.txt roll-up; one failing RPC or unreachable node does not fail the bundle. Reuses rpk's debugbundle.SanitizeName and debugbundle.UploadBundle (--upload-url). The admin client is a stdlib-only Connect-unary JSON client, so it adds no dependencies and is cross-platform. Part of OXLA-9616 (Oxla debug-bundle epic OXLA-9528).
Collaborator
CI test resultstest results on build#87061
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a new standalone
rpk sql debug bundlecommand that collects a read-onlydiagnostic bundle from an Oxla (SQL) cluster over its admin API
(
oxla.admin.v1.DebugService).The command seeds from
--admin-hosts(defaultlocalhost:9090), discovers thecluster via
GetClusterNodes, and fans out per-node collection — config, logs,startup logs, crash reports, host probes (unpacked Redpanda-style into
proc/*/linux-utils/*), resource usage, and a Prometheus/metricstimeseries (scraped twice ~1s apart) — plus cluster-wide artifacts (topology, catalog
head). Results are written as a ZIP under an
sql/subtree with amanifest.jsonand a per-RPC
errors.txtroll-up; one failing RPC or unreachable node does notfail the bundle.
--upload-urlPUTs the finished bundle in addition to the localcopy.
It reuses the existing
debugbundle.SanitizeNameanddebugbundle.UploadBundlehelpers. The admin client is a small stdlib-only Connect-unary JSON client, so the
command adds no new dependencies and is cross-platform, and it constructs no Kafka
client. It is intentionally a separate command from
rpk debug bundle.Backports Required
Release Notes
Features
rpk sql debug bundlecollects a diagnostic bundle from an Oxla (SQL) cluster.