Skip to content

IGNITE-28671 Describe healthy cluster behavior in general tips guide#13130

Open
w3ll1ngt wants to merge 10 commits into
apache:masterfrom
w3ll1ngt:ignite-28671
Open

IGNITE-28671 Describe healthy cluster behavior in general tips guide#13130
w3ll1ngt wants to merge 10 commits into
apache:masterfrom
w3ll1ngt:ignite-28671

Conversation

@w3ll1ngt

@w3ll1ngt w3ll1ngt commented May 13, 2026

Copy link
Copy Markdown
Contributor

Thank you for submitting the pull request to the Apache Ignite.

In order to streamline the review of the contribution
we ask you to ensure the following steps have been taken:

The Contribution Checklist

  • There is a single JIRA ticket related to the pull request.
  • The web-link to the pull request is attached to the JIRA ticket.
  • The JIRA ticket has the Patch Available state.
  • The pull request body describes changes that have been made.
    The description explains WHAT and WHY was made instead of HOW.
  • The pull request title is treated as the final commit message.
    The following pattern must be used: IGNITE-XXXX Change summary where XXXX - number of JIRA issue.
  • A reviewer has been mentioned through the JIRA comments
    (see the Maintainers list)
  • The pull request has been checked by the Teamcity Bot and
    the green visa attached to the JIRA ticket (see tab PR Check at TC.Bot - Instance 1 or TC.Bot - Instance 2)

Notes

If you need any help, please email dev@ignite.apache.org or ask anу advice on http://asf.slack.com #ignite channel.

Comment thread docs/_docs/perf-and-troubleshooting/general-perf-tips.adoc Outdated
Comment thread docs/_docs/perf-and-troubleshooting/general-perf-tips.adoc Outdated
Comment thread docs/_docs/perf-and-troubleshooting/general-perf-tips.adoc Outdated
@sonarqubecloud

Copy link
Copy Markdown


* Adjust link:data-rebalancing[data rebalancing settings] to ensure that rebalancing completes faster when your cluster topology changes.

== What healthy cluster behavior looks like

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Let's add examples for control.sh commands and JMX beans screenshot that demonstrates your article.

Like the following:

$ ./control.sh --cluster state
... example output for ACTIVE cluster state here ...

$ ./control.sh --baseline
... example output for healthy baseline when all nodes are active here ...
... and so on ...

For those checks that must be in graph form let's provide simplest jconsole examples.

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 updates the general performance tips documentation to include guidance on assessing Apache Ignite cluster health, and adjusts the page title wording to “General Performance Tips”.

Changes:

  • Rename the document title from “Generic Performance Tips” to “General Performance Tips”.
  • Add a new “How to assess cluster health” section describing practical signals and checks (cluster state/baseline, idle_verify, rebalance convergence, queues, transactions/queries, persistence checkpoint pressure, and logs).

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

Comment thread docs/_docs/perf-and-troubleshooting/general-perf-tips.adoc Outdated
Comment thread docs/_docs/perf-and-troubleshooting/general-perf-tips.adoc Outdated
Comment thread docs/_docs/perf-and-troubleshooting/general-perf-tips.adoc Outdated
Comment thread docs/_docs/perf-and-troubleshooting/general-perf-tips.adoc Outdated
Comment thread docs/_docs/perf-and-troubleshooting/general-perf-tips.adoc Outdated
Comment thread docs/_docs/perf-and-troubleshooting/general-perf-tips.adoc Outdated
Comment thread docs/_docs/perf-and-troubleshooting/general-perf-tips.adoc Outdated
Comment thread docs/_docs/perf-and-troubleshooting/general-perf-tips.adoc Outdated
Comment thread docs/_docs/perf-and-troubleshooting/general-perf-tips.adoc Outdated
Comment thread docs/_docs/perf-and-troubleshooting/general-perf-tips.adoc Outdated
Comment thread docs/_docs/perf-and-troubleshooting/general-perf-tips.adoc Outdated
Comment thread docs/_docs/perf-and-troubleshooting/general-perf-tips.adoc Outdated
Comment thread docs/_docs/perf-and-troubleshooting/general-perf-tips.adoc Outdated
Comment thread docs/_docs/perf-and-troubleshooting/general-perf-tips.adoc Outdated
Comment thread docs/_docs/perf-and-troubleshooting/general-perf-tips.adoc Outdated
w3ll1ngt and others added 2 commits July 17, 2026 15:25
copilot' grammar changes

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@w3ll1ngt
w3ll1ngt requested a review from zstan July 17, 2026 13:07
* The cluster is in the intended link:monitoring-metrics/cluster-states[state] and serves only the operations allowed by that state.
* Baseline topology, when it is used or managed manually, matches the expected data-bearing server nodes.
* Data remains consistent: link:tools/control-script#verifying-partition-checksums[`idle_verify`] reports no partition conflicts when the cluster is idle.
* Expected nodes are present, and no node segmentation or repeated membership churn is reported.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"repeated membership churn" - i don`t listen this term before, what does it mean ?

* Data remains consistent: link:tools/control-script#verifying-partition-checksums[`idle_verify`] reports no partition conflicts when the cluster is idle.
* Expected nodes are present, and no node segmentation or repeated membership churn is reported.
* link:configuring-caches/partition-loss-policy[Lost partitions] are absent.
* Long-running transactions, Partition Map Exchange (PME), rebalancing, checkpointing, and executor queues converge instead of accumulating.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

All this terms need to be covered\documentally extended somehow ? PME - what does it mean ? Long-running transactions - how it can be detected ? and so on ...

Comment on lines +67 to +69
Use several signals together.
A simple client connection or SQL liveness check can prove only that a particular client or query path is reachable; it does not check user partitions, backup consistency, baseline membership, or all server nodes.
Similarly, `control.(sh|bat) --cache idle_verify` is an important consistency check, but it is still not a complete health check.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I misunderstand this section at all ( It gives nothing only confusing a reader, need to be refactored or removed.

Comment thread docs/_docs/perf-and-troubleshooting/general-perf-tips.adoc Outdated
Comment thread docs/_docs/perf-and-troubleshooting/general-perf-tips.adoc Outdated

For JMX object names and SQL metric access, see link:monitoring-metrics/new-metrics-system#jmx[JMX] and link:monitoring-metrics/new-metrics-system#sql-view[SQL View].

.JConsole view of node-local striped executor queue metrics

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
.JConsole view of node-local striped executor queue metrics
JConsole view of node-local striped executor queue metrics

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

wont fix, ascii formatting issue


[source,text]
----
LastCheckpointTotalPagesNumber

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

plz also show "ignite.log" output for checkpoint operations, how it looks

JMX checkpoint and data-region metrics are node-local.
Open the same charts or attributes on each server node that owns persistent data.

.JConsole view of node-local persistence checkpoint metrics

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
.JConsole view of node-local persistence checkpoint metrics
JConsole view of node-local persistence checkpoint metrics

is dot expected here ? i miss smth ?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

dot is expected due eto ascii doc formatting (.Title for nearest image::)

* repeated striped-pool starvation warnings;
* unexpected node restarts.

Ignite reports critical failures to the configured failure handler; depending on the handler, the result can be node invalidation, failover handling, node stop, or JVM termination.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Oh ! seems we need to mention failure handler and it`s configurations policies here ? wdyt ?

Monitor membership from all expected monitoring points, and use logs and failure handling to detect segmentation and discovery failures.

CDC is a feature-specific check, not part of a universal cluster health definition.
If CDC is enabled, monitor `ignite-cdc.log`, WAL gaps, and consumption lag.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

theme is not covered at all )) may be it`s ok for this doc but if you have more info - plz append it

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

Copilot reviewed 1 out of 3 changed files in this pull request and generated no new comments.

Co-authored-by: Evgeniy Stanilovskiy <stanilovsky@gmail.com>
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