View Cluster Details

How to view details of a running cluster and its nodes.

8 May 2023 · Read time 3 min

Cluster Dashboard

The left-hand option labeled Clusters, is what you select to view your clusters. Selecting a cluster displays its Dashboard.

  • The left side includes the Endpoint with a Connection Details link, Layouts that summarize the nodes, shards and replication, the Replication count, the Version of ClickHouse installed, the Latest Backup date, the Last Query date, the Last Insert date,

  • The right side includes Monitoring with a link to View in Grafana, the number of Nodes, the type of Load Balancer, the Node Type, the Node Storage capacity in GB and type, the Node Memory in GB, and the Node CPU count.

  • The bottom shows pie charts for Volume (disk space used for each replica) and Memory used by each replica.

More Information

The following screen shot is what you see when you select Clusters from the left-hand navigation panel.

Cluster Details Page
Figure 1 - Cluster Dashboard

The sections in Figure 1 are detailed as follows:

(A) Cluster Management

The top menu bar provides cluster management functions.

  • Actions menu - Includes options to Upgrade, Rescale, Resume, Restart, Export Configuration, Publish ConfigurationPublish Configuration, Launch a Replica Cluster, and Destroy a cluster Addition functions for authorized users will show Restore a Backup and Create Backup. Contact Altinity for more information.
  • Configure menu - includes Settings, Profiles, Users, Connections, and Uptime Schedule.
  • Explore button - contains work areas for Query, Schema , Workload, and DBA Tools.
  • Alerts
  • Logs

(B) Health

(C) Access Point

(D) Monitoring, Queries

  • Monitor the Cluster and its Queries.

(E) Summary Information

  • View summary details for the Cluster or Node.
  • Select Nodes to view details on the cluster’s Nodes.

Nodes Summary

The Nodes tab displays detailed information for each of your nodes in the cluster.

Details for each node include:

  • Endpoint with a link to a node’s Connection Details
  • Version of ClickHouse installed
  • Type CPU Processor used
  • Node Storage size in GB
  • Memory allocated RAM for the node
  • Availability Zone that is set in your AWS or GKE cloud provider

Select Node View or View for the specific node to access:

Node Summary Page
Figure 2 - The Nodes tab from the Clusters page.

Node Connection

For the selected Node, Connection Details lists connection strings for use by various clients, including the clickhouse-client, JDBC drivers, HTTPS, and Python.

Similar to the Cluster Access Point, this page provides connection information to a specific node.

Node Connection
Figure 3 - Display of client Connection Details for a specific Node.

Node Dashboard

From the Node Dashboard Page users can:

Node Dashboard
Figure 4 - Node Dashboard.

(A) Manage Nodes

  • Actions menu
  • Tables and structure with Explore
  • Logs

(B) Node Heath

  • Online/Offline status
  • health checks passed status

(C) Metrics

  • View a node’s metrics, summary details, and its Schema.

Node Metrics

Node Metrics provides a breakdown of the node’s performance, such as CPU data, active threads, etc.

Node Schema

The Node Schema provides a view of the databases’ schema and tables.

More Information For more information on how to interact with a Node by submitting queries, viewing the schema of its databases and tables, and viewing process, see the Cluster Explore Guide.

Last modified 2023.05.18: Move Cluster from Admin to General section to match Beta site changes