Streaming

rpk generate grafana-dashboard

Generate Grafana dashboards for Redpanda metrics. Use this command to generate sample Grafana dashboards that can be imported into a Grafana or Grafana Cloud instance.

Available dashboards

You can select one of the following dashboard types:

Name Description

consumer-metrics

Monitoring of Java Kafka consumers, using the Prometheus JMX Exporter and the Kafka Sample Configuration.

consumer-offsets

Metrics and KPIs that provide details of topic consumers and how far they are lagging behind the end of the log.

operations

Provides an overview of KPIs for a Redpanda cluster with health indicators. This is suitable for ops or SRE to monitor on a daily or continuous basis. This is the default dashboard.

topic-metrics

Provides throughput, read/write rates, and on-disk sizes of each/all topics.

legacy

Generates dashboard based on selected metrics endpoint (--metrics-endpoint). Modify prometheus datasource and job-name with --datasource and --job-name flags.

Usage

rpk generate grafana-dashboard [flags]

Flags

Value Type Description

--dashboard

string

The name of the dashboard to download. Use --dashboard=help to list available dashboards.

Global flags

Value Type Description

--config

string

Redpanda or rpk config file; default search paths are ~/.config/rpk/rpk.yaml, $PWD/redpanda.yaml, and /etc/redpanda/redpanda.yaml.

-X, --config-opt

stringArray

Override rpk configuration settings; -X help for detail or -X list for terser detail.

--ignore-profile

bool

Ignore rpk.yaml and redpanda.yaml; use default settings.

--profile

string

rpk profile to use.

-v, --verbose

bool

Enable verbose logging.

The selected dashboard is downloaded from Redpanda Data’s observability GitHub repository.

The legacy dashboard is still available as an option (legacy), but it isn’t downloaded from GitHub. Instead, the generated dashboard is based on which metrics endpoint is used (--metrics-endpoint).