RED-199772: Refine metrics documentation#3554
Open
peperon wants to merge 1 commit into
Open
Conversation
|
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. |
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
With this PR, we are refining the Metrics v2 documentation. It includes several improvements:
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.mdembed 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_configis 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_wd→node,total_node_count→total_nodes_count, and primary-election counters are consolidated toprimary_selections_total(the separate “ended” counter row is removed). Replication docs fixdatabase_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_statusdocuments 99 = unknown.Reviewed by Cursor Bugbot for commit aad016b. Bugbot is set up for automated code reviews on this repo. Configure here.