2. Home
  4. Docs
  6. ClusterControl
  8. User Guide (GUI)
  10. TimeScaleDB
  12. Dashboards

Dashboards

Note

This feature is introduced in version 1.7.0.

This feature is only applicable for agent-based monitoring using Prometheus. You will be presented with a notification panel to enable agent-based monitoring if it has not been activated.

See also

To understand how ClusterControl performs monitoring jobs, see Monitoring Operations.

Attention

Starting from ClusterControl 1.9.7 (September 2023), ClusterControl GUI v2 is the default frontend graphical user interface (GUI) for ClusterControl. Note that the GUI v1 is considered a feature-freeze product with no future development. All new developments will be happening on ClusterControl GUI v2. See User Guide (GUI v2).

Enable Agent-Based Monitoring

Opens a side-menu pop-up to configure a Prometheus server. You can re-use an existing Prometheus server for multiple clusters within one ClusterControl instance. For a new Prometheus deployment, ClusterControl will install the Prometheus server on the target host and configure exporters on all monitored hosts according to their role for that particular cluster. If you choose an existing Prometheus server, ClusterControl will connect to the data source and also configure the Prometheus exporters accordingly.

Field Description
Select Host
  • Pick a host to be configured as the Prometheus server. If you already have a running Prometheus server, the dropdown will list out the existing instance and you can pick it up from the list. Ensure ClusterControl can perform passwordless SSH to the target node.
Scrape Interval
  • How frequently to scrape targets by default. This is a Prometheus global configuration. See Global Configuration.
Data Retention(days)
Configure Exporters
  • Manually configure individual exporters scrape interval and command-line arguments to be passed.

Monitoring Dashboards

Dashboards are composed of individual monitoring panels arranged on a grid. For TimeScaleDB, ClusterControl pre-configures a number of dashboards as shown in the following table:

Dashboard Cluster Type Description
System Overview All Clusters Provides panels of host metrics and usage for an individual host.
Cross-Server Graphs All Clusters Provides selected host metrics for all hosts for comparison.
TimeScaleDB Overview TimeScaleDB Provides panels of general database metrics and usage for the individual database host.
HAProxy Overview Clusters with HAProxy Provides important HAProxy metrics for an individual hosts.
Field Description
Dashboard
  • A dropdown list of pre-configured dashboards.
Node
  • List of database nodes hostname (or IP address) and its role for the particular cluster. Only for non-global dashboards.
Range Selection
  • Opens a pop-up to configure time range for all panels. It provides common quick ranges, refresh rate,s and also a date-time picker at the bottom of the window.
Zoom Out
  • Decreases the magnification of the graphs.
Refresh Rate
  • Opens a pop-up to configure time range for all panels. It provides common quick ranges, refresh rate,s and also a date-time picker at the bottom of the window.
Configuration
  • Opens a pop-up to show exporters grouped by the host and Prometheus global configuration settings.
Re-enable Agent-Based Monitoring
  • Reconfigures agent-based monitoring approach. You can use this function to configure this cluster to use a different Prometheus server.
Disable Agent-Based Monitoring
  • Disable this monitoring operation mode and back to the agentless approach. You have the option of whether to keep the Prometheus running and continue to pull stats or stop the exporters and Prometheus altogether. Regardless of the chosen option, the Dashboards will also be disabled once the job completes.

For more info on how ClusterControl performs monitoring jobs, see Monitoring Operations. To learn more about Prometheus monitoring system and exporters, please refer to Prometheus Documentation.

Was this article helpful to you? Yes No