[IGNITE-18378] Cluster show command

• Type: Epic
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Labels: cli ignite-3 rest
• Epic Name: Cluster show
• Ignite Flags: Docs Required, Release Notes Required
• Assignee: Unassigned
• Reporter: Aleksandr
• Created: 13/Dec/22 06:30
• Updated: 13/Dec/22 06:48

Description

This epic is a result of IGNITE-17102.

What should be displayed

Cluster-only information

• Cluster name
• Cluster Id
• Cluster status
• Ignite version
• Status of CMG (available/ not available)
• Status of Meta storage (available/ not available)
• Number of total nodes in cluster (online/offline/joinig)
• Number of CMG nodes (online/offline)
• Number of Meta storage nodes (online/offline)

Data-related information

• Used RAM
• Used Disc
• Total RAM
• Total Disc
• Available RAM
• Available Disc
• Number of caches
• Number of partitions
• Number of tables
• Number of databases
• Number of schemas
• Number of distribution zones
• Available storages (page memory, rocks db, ..)
• Sizes info per storage

Clients info

• Number of current clients connections
• List of available connections (rest, jdbc)

How to display

Take a look at the attachment.

The proposed “interface” is shown like a “live dashboard”. It means that the user should not run the cluster show each time to see updates.

If --plain option is provided that the command should display the “snapshot of the live dashboard”.

Notes

Now we do not have API to build such a dashboard. That is why it is an epic, not a task.

As a user that sees the dashboard, I want to be able to dig into some metrics/stats that are displayed after the cluster show execution. For example, I see the “distribution zones” count. And I want to list them, that is a legal wish. So, the command storage distribution zones list might be introduced. The same for available connections, memory stats, databases, etc.

Issue Links

• is caused by: IGNITE-17102 Design cluster show command