tiup cluster display

If you want to check the running status of each component in the cluster, it is obviously inefficient to log in to each machine one by one.Therefore, tiup-cluster provides the tiup cluster display command to do this efficiently.

Syntax

tiup cluster display [flags]

is the name of the cluster to be operated. If you forget the cluster name, you can pass Cluster ListView.

options

--dashboard

• By default, all node information of the entire cluster will be displayed. After adding this option, only the information of the dashboard will be displayed.
• Data type: BOOLEAN
• This option is disabled by default, and the default value is false.Add this option to the command and pass in the true value or no value to enable this function.

-N, --node (strings, defaults to [], means all nodes)

Specify the node to be queried, if not specified, it means all nodes.The value of this option is a comma-separated list of node IDs. If you are not sure about the ID of the node to be queried, if you do not specify this option, the output will display the ID and status information of all nodes.

Note

If both -R, --role are specified, then the service status in their intersection will be queried.

-R, --role (strings, defaults to [], indicates all roles)

Specify the role to be queried, if not specified, it means all roles.The value of this option is a comma-separated list of node roles. If you are not sure about the role of the node to be queried, if you do not specify this option, the output will display the role and status information of all nodes.

Note

If both -N, --node are specified, then the service status in their intersection will be queried.

-h, --help

• Output help information.
• Data type: BOOLEAN
• This option is disabled by default, and the default value is false.Add this option to the command and pass in the true value or no value to enable this function.

output

• Cluster name
• Cluster version
• SSH Client Type
• Dashboard address
• A table with the following fields:
  • ID: Node ID, consisting of IP:PORT
  • Role: The service role deployed on this node (such as TiDB, TiKV, etc.)
  • Host: The machine IP corresponding to this node
  • Ports: The port number occupied by the service
  • OS/Arch: The operating system and machine architecture of the node
  • Status: The current status of the node service
  • Data Dir: The data directory of the service, - means there is no data directory
  • Deploy Dir: The deployment directory of the service