rpk debug bundle
The rpk debug bundle
command 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, called a diagnostics bundle.
In Kubernetes, you must execute the rpk debug bundle command inside a container that’s running a Redpanda broker.
|
Flags
Value | Type | Description |
---|---|---|
--admin-api-tls-cert |
string |
The 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-key |
string |
The certificate key to be used for TLS authentication with the Admin API. |
--admin-api-tls-truststore |
string |
The truststore to be used for TLS communication with the Admin API. |
--api-urls |
string |
The address to the broker`s Admin API. Defaults to the one in the config file. |
--brokers |
strings |
Comma-separated list of broker |
--config |
string |
Redpanda configuration file. If not set, rpk searches for the file in the default locations. |
--controller-logs-size-limit |
string |
Sets the limit of the controller log size that can be stored in the bundle. Multipliers are also supported, e.g. 3MB, 1GiB (default "20MB"). |
-h, --help |
- |
Display documentation for |
--logs-since |
string |
Include log entries on or newer than the specified date in journalctl date format, for example YYYY-MM-DD. |
--logs-size-limit |
string |
Read the logs until the given size is reached. Multipliers are also supported, e.g. 3MB, 1GiB (default "100MiB"). |
--logs-until |
string |
Include log entries on or older than the
specified date in journalctl date format, for example YYYY-MM-DD. |
--metrics-interval |
duration |
The amount of time to wait before
capturing the second snapshot of the metrics endpoints, for example
|
--namespace |
string |
The Kubernetes namespace in which the Redpanda
cluster is running. Default: |
--password |
string |
SASL password to be used for authentication. |
--sasl-mechanism |
string |
The authentication mechanism to use.
Supported values: |
--timeout |
duration |
The amount of time to wait for child commands to
execute, for example |
--tls-cert |
string |
The 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-key |
string |
The certificate key to be used for TLS authentication with the broker. |
--tls-truststore |
string |
The truststore to be used for TLS communication with the broker. |
--upload-url |
string |
The URL to which to upload the diagnostics
bundle. This URL is usually given to you by the Redpanda support team to
help you debug your deployment. |
--user |
string |
SASL user to be used for authentication. |
-v, --verbose |
- |
Enable verbose logging. Default: |
Result
The files and directories in the diagnostics bundle differ depending on the environment in which Redpanda is running.
-
Linux
-
Kubernetes
For some data, Redpanda requires the rpk debug bundle command to be run with root privileges.
The names of the files or directories that are generated only with root privileges are labeled Requires root privileges.
|
File or Directory | Description |
---|---|
|
Metadata for the Redpanda data directory of the broker on which the |
|
The DNS information, as output by the |
|
The contents of the DMI table (system management BIOS or SMBIOS). |
|
The disk usage of the data directory of the broker on which the |
|
Network configuration, as output by the |
|
Kafka metadata, such as broker configuration, topic configuration, offsets, groups, and group commits. |
|
PCI buses and the devices connected to them. |
|
The NTP clock delta (using |
|
CPU details of the broker on which the |
|
The Redpanda logs written to journald. If |
|
The local broker’s Prometheus metrics, fetched through its admin API. |
|
The Redpanda configuration file of the broker on which the |
|
Redpanda resource usage data, such as CPU usage and free memory available. |
|
Data about active sockets, as output by the |
|
The kernel logs ring buffer, as output by the |
|
Information about the running processes, as output by the |
Check system processes. |
|
Redpanda collects some data from the Kubernetes API. To communicate with the Kubernetes API, Redpanda requires a ClusterRole attached to the default ServiceAccount for the Pods. The files and directories that are generated only when the ClusterRole exists are labeled Requires ClusterRole. |
File or Directory | Description |
---|---|
|
Cluster and broker configurations, cluster health data, and license key information. |
|
Binary-encoded replicated logs that contain the history of configuration changes as well as internal settings. |
|
Metadata for the Redpanda data directory of the broker on which the |
|
The disk usage of the data directory of the broker on which the |
|
Kubernetes manifests for all resources in the given Kubernetes namespace. |
|
Kafka metadata, such as broker configuration, topic configuration, offsets, groups, and group commits. |
|
Logs of each Pod in the given Kubernetes namespace. |
|
Prometheus metrics from both the |
|
The NTP clock delta (using |
|
CPU details of the broker on which the |
|
The Redpanda configuration file of the broker on which the |
|
Redpanda resource usage data, such as CPU usage and free memory available. |