Debug Bundles Overview
A debug bundle is a collection of diagnostic data from your Redpanda cluster. It includes logs, metrics, and other critical information that helps diagnose and troubleshoot cluster issues.
Debug bundles are designed to:
-
Provide a consolidated view of cluster health and activity.
-
Help identify and resolve issues such as crashes, resource bottlenecks, or misconfigurations.
-
Facilitate communication with Redpanda support by enabling you to share detailed diagnostic data.
Tools for managing debug bundles
You can create and manage debug bundles using the following tools:
-
Redpanda Console: A user-friendly web UI for generating and downloading debug bundles without needing direct broker access.
-
rpk
: A command-line tool that provides options for generating bundles either locally or remotely.
Contents of the debug bundle
The files and directories in the debug bundle differ depending on the environment in which Redpanda is running.
-
Linux
-
Kubernetes
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 |
|
Kafka metadata, such as broker configuration, topic configuration, offsets, groups, and group commits. |
|
Redpanda logs for the broker. |
|
Prometheus metrics from both the |
|
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. |
|
Data from the node on which the broker is running. This directory includes:
|
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 |
|
Kafka metadata, such as broker configuration, topic configuration, offsets, groups, and group commits. |
|
Redpanda logs for the broker. |
|
Prometheus metrics from both the |
|
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. |
|
Data from the node on which the broker is running. This directory includes:
|
In addition to the preceding files and directories, the debug bundle also includes up to 50 of the most recent stack traces from the root cause of a crash loop. Logs include:
-
Cluster UUID
-
Node ID
-
Timestamp
-
Stack trace logs