Skip to main content
Version: 22.2

rpk debug bundle

rpk debug bundle

rpk debug bundle collects environment data that can help debug and diagnose issues with a Redpanda cluster, a broker, or the machine it`s running on. It then bundles the collected data into a zip file.

The following are the data sources that are bundled in the compressed file:

Data SourceDescription
Kafka metadataBroker configs, topic configs, start/committed/end offsets, groups, group commits.
Data directory structureA file describing the data directory`s contents.
Redpanda configurationThe Redpanda configuration file `redpanda.yaml`. SASL credentials are stripped.
/proc/cpuinfoCPU information like make, core count, cache, frequency.
/proc/interruptsIRQ distribution across CPU cores.
Resource usage dataCPU usage percentage, free memory available for the Redpanda process.
Clock driftThe ntp clock delta (usingntppool as a reference) & round trip time.
Kernel logsThe kernel logs ring buffer (syslog).
Broker metricsThe local broker`s Prometheus metrics, fetched through its admin API.
DNSThe DNS info as reported by dig, using the hosts in/etc/resolv.conf.
Disk UsageThe disk usage for the data directory, as output by du.
Redpanda logsThe Redpanda logs written to journald. If --logs-since or--logs-until are passed, then only the logs within the resulting time frame will be included.
Socket infoThe active sockets data output by ss.
Running process infoAs reported by top.
Virtual memory statsAs reported by vmstat.
Network configAs reported by ip addr.
lspciList the PCI buses and the devices connected to them.
dmidecodeThe DMI table contents. Only included if this command is run as root.

Usage

rpk debug bundle [flags]

Flags

Value Type Description
--admin-api-tls-certstringThe certificate to be used for TLS authentication with the Admin API.
--admin-api-tls-enabled-Enable TLS for the Admin API (not necessary if specifying custom certs).
--admin-api-tls-keystringThe certificate key to be used for TLS authentication with the Admin API.
--admin-api-tls-truststorestringThe truststore to be used for TLS communication with the Admin API.
--admin-urlstringThe address to the broker`s admin API. Defaults to the one in the config file
--brokersstringsComma-separated list of broker <ip>:<port> pairs (for example,--brokers `192.168.78.34:9092,192.168.78.35:9092,192.179.23.54:9092`). Alternatively, you may set the REDPANDA_BROKERSenvironment variable with the comma-separated list of broker addresses.. Alternatively, you may set the REDPANDA_BROKERS environment variable with the comma-separated list of broker addresses
--configstringRedpanda config file, if not set the file will be searched for in the default locations
-h, --help- Help for bundle
--logs-sincestringInclude log entries on or newer than the specified date. (journalctl date format, for example YYYY-MM-DD)
--logs-untilstringInclude log entries on or older than the specified date. (journalctl date format, for example YYYY-MM-DD)
--passwordstring SASL password to be used for authentication.
--sasl-mechanismstringThe authentication mechanism to use. Supported values: SCRAM-SHA-256, SCRAM-SHA-512.
--timeoutdurationHow long to wait for child commands to execute (for example 30s,1.5m) (default 10s).
--tls-certstringThe certificate to be used for TLS authentication with the broker.
--tls-enabled-Enable TLS for the Kafka API (not necessary if specifying custom certs).
--tls-keystringThe certificate key to be used for TLS authentication with the broker.
--tls-truststorestring The truststore to be used for TLS communication with the broker.
--userstring SASL user to be used for authentication.
-v, --verbose-Enable verbose logging (default false).