Cluster Status

If you came here through a direct link, you may want to check the main https://jaus.atlassian.net/wiki/spaces/JAUS page first!

JAUS Cluster Status is a Userscript that collects status and index summary info from all nodes in the cluster (for Jira DC) and shows the JSON-formatted output in the screen when triggered.

How Cluster Status looks when installed in Violentmonkey.
How Cluster Status looks when installed in Violentmonkey.

Download/installarion URL:

https://bitbucket.org/jira-admin-userscripts/jaus/raw/master/src/jaus-cluster-status.user.js

Use cases

As an Admin of Jira Datacenter, you may to check the /rest/api/2/index/summary endpoint when you suspect nodes are falling off index replication.

This Userscript provides the output of /cluster/nodes for each node and each /index/summary.

Atlassian Support regularly asks for /index/summary as part of https://confluence.atlassian.com/jirakb/index-replication-jira-data-center-troubleshooting-966676040.html and you may provide this Userscript’s output — though Atlassian Support is unaware of this Userscript and does not support it as it’s user customization.

Scope

The Userscript is available at the “clustering” admin page in Jira.

Example output:

JAUS Cluster Info example output.
JAUS Cluster Info example output.

 

Mechanics

The Userscript, when triggered, makes a request to <JIRA-BASE-URL>/rest/api/2/cluster/nodes. This brings a JSON list with each node and some info as elements.

For each element (node) in the JSON list, it fetches the <JIRA-BASE-URL>/rest/api/2/index/summary and adds to each node element. This Userscript works the same regardless of which node you’re browsing from — and one advantage of it is that the index/summary requests are performed practically at the same time.

The entire text output is formatted in JSON and printed in an injected textarea for easy copying.

Repository

JAUS Cluster Status’s source code is hosted in BitBucket:

https://bitbucket.org/jira-admin-userscripts/jaus/src/master/src/jaus-cluster-status.user.js

Notice that to download/install we advise the /raw/ URL.

Authorship

JAUS Admin Check All was designed and implemented by Rodrigo Martinez (Linkedin profile).

It's licensed under Creative Commons Attribution-ShareAlike 4.0 International License.

Support

If you have questions, any problem or need instructions on this Userscript’s usage, please open a request in the JAUS Help Portal.

Please select the Component jaus-cluster-status.

Roadmap

Maybe add more node info and make a copy to clipboard link somewhere.

Known issues

 

Feature requests

Please vote, watch and comment on the feature request!