Skip to content

DOC-1381: Add Load Factor dashboard monitoring page (26.2)#1815

Open
Feediver1 wants to merge 9 commits into
betafrom
DOC-1381-load-factor-dashboard
Open

DOC-1381: Add Load Factor dashboard monitoring page (26.2)#1815
Feediver1 wants to merge 9 commits into
betafrom
DOC-1381-load-factor-dashboard

Conversation

@Feediver1

@Feediver1 Feediver1 commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Description

Documents the 26.2 "Redpanda - Load Factor" Grafana dashboard (ENG-540): a new Self-Managed monitoring page covering the load-factor concept (live utilization vs. estimated instance capacity), the metric families behind it, import and panel-reading guidance, and limitations.

Resolves DOC-1381.

Key content decisions (all source-verified; see the delta review on DOC-1381)

  • Leads with the internal-metrics prerequisite: the dashboard queries vectorized_* series exclusively (112 refs, zero redpanda_* in the JSON) — the public-metrics variant was an unshipped stretch goal (Stephan Dollberg, ENG-540 2026-06-29). Customers scraping only /public_metrics can't use it without adding internal-endpoint scraping.
  • enable_host_metrics facts (default true, restart required, tunable) verified at the v26.2.1-rc3 tag; instance_metrics.cc confirmed present in the release.
  • No hand-edits to generated reference partials: instance_*/host_metrics_info/io_queue_config_* reference entries arrive via the 26.2 metrics regen (avoiding the regen-clobber problem).
  • No single load_factor metric exists — stated explicitly with a NOTE, since the feature title suggests otherwise.

⚠️ Verify before merge (DRAFT-VERIFY comments in source)

  • Dashboard distribution — the import procedure assumes users take single-load-factor.json from the redpanda repo. @travis-downs pinged on DOC-1381 (2026-07-21); adjust if it ships via a published bundle or Console instead.
  • Load-factor computation semantics — the concept description is derived from the dashboard structure and ENG-540; the panels are SDK-generated composites, so the exact formula needs SME confirmation.

Cloud

Self-Managed only by verified scope (ENG-908 Cloud UI indicator unbuilt; cloudv2 has zero load-factor surface). The Cloud twin is DOC-2315. This page is not single-sourced, so no env gating is needed.

Preview pages

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

🤖 Generated with Claude Code

New how-to for the 26.2 "Redpanda - Load Factor" Grafana dashboard
(ENG-540): what load factor is (live utilization vs estimated instance
capacity), the internal-metrics-endpoint prerequisite (the dashboard
queries vectorized_* series only; the public-metrics variant was an
unshipped stretch goal), the instance-capacity and host-OS metric
families behind it, import + panel-reading guidance, and limitations
(nominal vendor capacity figures; unrecognized instance types emit no
capacity gauges).

Facts verified against v26.2.1-rc3 (enable_host_metrics default/restart/
visibility, instance_metrics.cc presence) and the dashboard JSON on dev
(112 vectorized_ refs, 0 redpanda_; panel inventory). DRAFT-VERIFY
markers cover the two facts pending engineering: dashboard distribution
(Travis Downs pinged on DOC-1381) and the exact load-factor computation
semantics.

Metrics reference entries for instance_*/host_metrics_info/
io_queue_config_* arrive via the 26.2 metrics regen, not hand-edits.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@Feediver1
Feediver1 requested a review from a team as a code owner July 21, 2026 14:40
@netlify

netlify Bot commented Jul 21, 2026

Copy link
Copy Markdown

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 157db9f
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a63cf9c00d32100086a53ea
😎 Deploy Preview https://deploy-preview-1815--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 136d3078-6beb-4dce-a591-04f2761af2e6

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch DOC-1381-load-factor-dashboard

Comment @coderabbitai help to get the list of available commands.

@Feediver1
Feediver1 requested a review from travisdowns July 21, 2026 14:51
…rted guide

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Comment thread modules/manage/pages/monitor-load-factor.adoc Outdated

@travisdowns travisdowns left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few source-verification fixes from cross-checking against the dashboard spec and the shipped single-load-factor.json. Three inline suggestions below: two scoping the instance-type-capacity claim (it only applies to disk and network), and one correcting the network metric attribution.

Comment thread modules/manage/pages/monitor-load-factor.adoc Outdated
Comment thread modules/manage/pages/monitor-load-factor.adoc Outdated
Comment thread modules/manage/pages/monitor-load-factor.adoc Outdated

@travisdowns travisdowns left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One more: the I/O scheduler subfactor is a per-resource panel section but isn't called out anywhere on the page. Adding it to this enumeration closes the gap (connections is already here).

Comment thread modules/manage/pages/monitor-load-factor.adoc Outdated
Comment thread modules/manage/pages/monitor-load-factor.adoc
Co-authored-by: Travis Downs <travis.downs@gmail.com>
Comment thread modules/manage/pages/monitor-load-factor.adoc Outdated
Comment thread modules/manage/pages/monitor-load-factor.adoc Outdated
Comment thread modules/manage/pages/monitor-load-factor.adoc Outdated
@Feediver1

Copy link
Copy Markdown
Contributor Author

// DRAFT-VERIFY (DOC-1381): Dashboard distribution is unconfirmed with engineering
// (Travis Downs pinged 2026-07-21): repo import vs published bundle vs Console.
// The import procedure below assumes users take the JSON from the redpanda repo.
// Also confirm the exact load-factor computation semantics before publishing;
// the description below is concept-level, derived from the dashboard structure
// and ENG-540.

^^ Will go in post-GA when available.

Comment thread modules/manage/pages/monitor-load-factor.adoc Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants