Skip to content

RED-199772: Refine metrics documentation#3554

Open
peperon wants to merge 1 commit into
redis:mainfrom
peperon:story/RED-199772/fix-documentation
Open

RED-199772: Refine metrics documentation#3554
peperon wants to merge 1 commit into
redis:mainfrom
peperon:story/RED-199772/fix-documentation

Conversation

@peperon

@peperon peperon commented Jun 26, 2026

Copy link
Copy Markdown
Member

With this PR, we are refining the Metrics v2 documentation. It includes several improvements:

  • Fixed issues and mismatches in the type column, including ensuring that the type column is also present for shard metrics.
  • Added a new column for metric units, which reflects the exact type of each emitted metric.
  • Corrected several metric names and descriptions, and removed duplicate metrics.
  • Added redis_server_slave_buffer, a new metric that was recently introduced.

Note

Low Risk
Documentation-only changes to an embedded markdown reference; no runtime code, but dashboard owners should verify queries against renamed cluster metrics and updated enum values.

Overview
Updates the shared rs-prometheus-metrics-v2.md embed used across Redis Software Prometheus docs.

All metric sections (database, node, cluster, replication, shard) now use a Unit column (bytes, count, microseconds, etc.) alongside corrected Type values—for example db_config is documented as a gauge (not a counter), latency histograms keep histogram type with explicit microsecond units, and shard rows gain consistent Type/Unit columns where they were missing before.

Cluster entries are aligned with emitted names/labels: label cluster_wdnode, total_node_counttotal_nodes_count, and primary-election counters are consolidated to primary_selections_total (the separate “ended” counter row is removed). Replication docs fix database_syncer_current_status (out of sync 1, not 2) and spell out connectivity gauge meanings.

Shard docs add redis_server_slave_buffer, drop a duplicated block of RediSearch metric rows, and clarify several status gauges (e.g. redis_server_up, redis_server_master_link_status). db_status documents 99 = unknown.

Reviewed by Cursor Bugbot for commit aad016b. Bugbot is set up for automated code reviews on this repo. Configure here.

@jit-ci

jit-ci Bot commented Jun 26, 2026

Copy link
Copy Markdown

Hi, I’m Jit, a friendly security platform designed to help developers build secure applications from day zero with an MVS (Minimal viable security) mindset.

In case there are security findings, they will be communicated to you as a comment inside the PR.

Hope you’ll enjoy using Jit.

Questions? Comments? Want to learn more? Get in touch with us.

@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@mich-elle-luna mich-elle-luna requested a review from rrelledge June 26, 2026 14:43
@rrelledge rrelledge self-assigned this Jun 26, 2026
@rrelledge rrelledge added the rs Redis Software label Jun 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

rs Redis Software

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants