Skip to content

docs: update monitoring documentation with accurate details#601

Open
krishnaGajabi wants to merge 1 commit into
openebs:mainfrom
krishnaGajabi:mayastormonitoringreference
Open

docs: update monitoring documentation with accurate details#601
krishnaGajabi wants to merge 1 commit into
openebs:mainfrom
krishnaGajabi:mayastormonitoringreference

Conversation

@krishnaGajabi

Copy link
Copy Markdown
Contributor

Updates the monitoring docs for mayastor

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR refreshes the Replicated PV Mayastor monitoring documentation by turning it into a consolidated “metrics reference” that covers both the I/O-engine Prometheus metrics exporter and the call-home stats exporter.

Changes:

  • Replaces the previous exporter-focused guide with a structured metrics reference (disk pool, node, replica, volume).
  • Adds guidance for deriving IOPS/latency/throughput from cumulative metrics, including reset handling.
  • Documents call-home /stats lifecycle event counters and links to a preconfigured monitoring stack.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@krishnaGajabi krishnaGajabi force-pushed the mayastormonitoringreference branch from 618f5ec to b48e905 Compare June 30, 2026 10:41
@krishnaGajabi

Copy link
Copy Markdown
Contributor Author

@tiagolobocastro should we change node_id label to nodein code just to be consistent with other metrics in the following newly added metrics

Metric Type Labels Description
mayastor_node_cordoned gauge node_id Indicates if the Mayastor node is cordoned
mayastor_node_draining gauge node_id Indicates if the Mayastor node is draining
mayastor_node_online gauge node_id Indicates if the Mayastor node is online

@tiagolobocastro

Copy link
Copy Markdown
Member

@tiagolobocastro should we change node_id label to nodein code just to be consistent with other metrics in the following newly added metrics
Metric Type Labels Description
mayastor_node_cordoned gauge node_id Indicates if the Mayastor node is cordoned
mayastor_node_draining gauge node_id Indicates if the Mayastor node is draining
mayastor_node_online gauge node_id Indicates if the Mayastor node is online

hmm but changing the name may break existing user?

@krishnaGajabi

krishnaGajabi commented Jun 30, 2026

Copy link
Copy Markdown
Contributor Author

@tiagolobocastro should we change node_id label to nodein code just to be consistent with other metrics in the following newly added metrics
Metric Type Labels Description
mayastor_node_cordoned gauge node_id Indicates if the Mayastor node is cordoned
mayastor_node_draining gauge node_id Indicates if the Mayastor node is draining
mayastor_node_online gauge node_id Indicates if the Mayastor node is online

hmm but changing the name may break existing user?

Yes (anyway users can for now can rename the label name with promql)

@krishnaGajabi krishnaGajabi force-pushed the mayastormonitoringreference branch from b48e905 to b6197a5 Compare July 2, 2026 05:54
Signed-off-by: krishnaGajabi <gajbikrishna23@gmail.com>
@krishnaGajabi krishnaGajabi force-pushed the mayastormonitoringreference branch from b6197a5 to 7165942 Compare July 2, 2026 06:10
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.

4 participants