Cluster management

Daria Barysheva

ADB Control allows you to monitor multiple ADB clusters simultaneously. In this case, the target cluster (within which the ADB Control web interface will be used) and other clusters (which will send metrics to the first cluster) do not have to use the same ADCM.

To manage clusters, you can use the Clusters tab on the Configuration page in the ADB Control web interface.

IMPORTANT

In ADB Control 4.6.4, the ADB external cluster registration API has been changed. If you use ADB Control 4.6.4 (or higher) and monitor some external ADB clusters with version lower than 6.26.0.53, you should upgrade all registered ADB clusters to 6.26.0.53 (or higher) before any configuration changes.

View a list of clusters

The Configuration → Clusters tab displays the following information on clusters.

adbc config clusters dark
The Configuration → Clusters tab
adbc config clusters light
The Configuration → Clusters tab
The "Configuration → Clusters" tab fields
Field Description

Monitoring

A switcher that can be used to archive a cluster

Cluster name

A cluster name. For a default cluster, the default cluster label is shown additionally

JDBC URL

A URL of the JDBC connection

Username

A user name that is used to connect to a cluster

Database

A list of cluster databases to be monitored. The databases that are selected for offloading metrics to the external database are marked with the upload dark upload light icon

Above the table with a list of clusters, there are filters, which you can use to select specific data:

  • Monitoring type — filter by the current monitoring status:

    • Activate — active clusters that are currently monitored.

    • Archived — archived clusters, the monitoring of which is suspended.

    • All — all clusters.

  • Cluster name — filter by the cluster name (see Cluster name above). You can search by the first characters entered.

Add a cluster

IMPORTANT

  • A cluster name should be unique within ADB Control. You cannot add several clusters with the same name (for example, created via different ADCM instances).

  • If the ADB connection URL changes after switchover in the ADB cluster, you need to change the URL in ADB Control settings as well.

  • When upgrading clusters via ADCM, first, update the ADB cluster where the main ADB Control service is installed (not external).

To add a new ADB cluster to be monitored in ADB Control, follow the steps:

  1. Using ADCM, add the ADB Control service to the cluster that should be added to the existing monitoring system.

  2. When configuring the service, do the following:

    • Activate the External ADB Control server parameters switcher.

    • In the ADB Control address field, enter the IP address of the host where the target ADB Control service is deployed. Its web interface is planned to be used for monitoring the new cluster.

    • Click Save.

      adbc config clusters2
      Enter the external ADB Control service data

  3. Install the service. Note that you should not distribute service components between cluster hosts since the external ADB Control is to be used.

  4. In the web interface of the target ADB Control (which will be used for monitoring), open the Configuration → Clusters tab. The new cluster should be added automatically.

    adbc config clusters5 dark
    Cluster is added
    adbc config clusters5 light
    Cluster is added

  5. To ensure that the cluster connection is successful, you can run an SQL query in one of the cluster databases that were previously selected for monitoring, and verify that the query information appears on the Monitoring page. Note that the added cluster must be pre-selected in the filters on the page (if the cluster is not marked as default). You can use a test query as follows:

    SELECT pg_sleep(60);
    adbc config clusters6 dark
    Cluster is available for monitoring
    adbc config clusters6 light
    Cluster is available for monitoring

Edit a cluster connection

To edit cluster data, follow the steps:

  1. Click the edit dark edit light icon in the Actions column on the Configuration → Clusters tab.

    adbc config clusters7 dark
    Switch to editing cluster data
    adbc config clusters7 light
    Switch to editing cluster data

  2. In the window that opens, edit necessary fields (the Cluster name field value cannot be changed):

    • JDBC URL — a URL of the JDBC connection to the Master host of the ADB cluster. Use the following format:

      jdbc:postgresql://<ADB Master host IP address>:5432/postgres

    • User — a user name. Use adcc by default.

    • Password — a user password. The default user adcc does not require a password.

    • Databases — a list of cluster databases to be monitored. This list becomes available after you click Fetch full list. Select one database at least.

      adbc config clusters8 dark
      Edit cluster data
      adbc config clusters8 light
      Edit cluster data

  3. Click Save. As a result, cluster data is updated on the Configuration → Clusters tab.

    adbc config clusters9 dark
    Cluster data is updated
    adbc config clusters9 light
    Cluster data is updated

Set a default cluster

Many pages of the ADB Control web interface have cluster name filters. To assign the cluster to be selected in these filters by default, follow the steps:

  1. Click Set default on the Configuration → Clusters tab.

    adbc config clusters10 dark
    Switch to setting a default cluster
    adbc config clusters10 light
    Switch to setting a default cluster

  2. In the window that opens, select a default cluster from the Cluster name drop-down list.

    adbc config clusters11 dark
    Select a default cluster
    adbc config clusters11 light
    Select a default cluster

  3. Click Save. As a result, the default cluster label is displayed under the new default cluster.

    adbc config clusters12 dark
    Default cluster is changed
    adbc config clusters12 light
    Default cluster is changed

Archive a cluster

In some cases, it is necessary to suspend the processing of monitoring metrics in ADB Control for a specific cluster. For this purpose, you can archive a cluster, which means:

  • ADB Control does not collect audit events for the cluster.

  • The export job skips the data related to the archived cluster.

  • Resource group statistics is not collected for the cluster.

  • On the Information page, there are no cluster details.

To archive a cluster, follow the steps:

  1. Open the Configuration → Clusters tab and deactivate the switcher in the Monitoring column for a target cluster.

    adbc config clusters13 dark
    Switch to the cluster archiving
    adbc config clusters13 light
    Switch to the cluster archiving

  2. In the window that opens, confirm the operation by clicking Stop.

    adbc config clusters14 dark
    Confirm the operation
    adbc config clusters14 light
    Confirm the operation

    As a result, the cluster us marked as unavailable for monitoring on the Configuration → Clusters tab.

    adbc config clusters15 dark
    Cluster monitoring is stopped
    adbc config clusters15 light
    Cluster monitoring is stopped
NOTE

If you later need to resume the cluster monitoring, activate the switcher in the Monitoring column again.

Configure a cluster to offload metrics

If you need to offload cluster metrics to the external analytical database (according to the schedule that is configured on the Configuration → Job policy → Metrics offload page), follow the steps:

  1. Click the upload dark upload light icon in the Actions column on the Configuration → Clusters tab.

    adbc offload dark
    Switch to configuring
    adbc offload light
    Switch to configuring

  2. In the window that opens, select the cluster databases from which you want to upload the metrics to the external storage.

    adbc offload2 dark
    Select databases
    adbc offload2 light
    Select databases

  3. Click Offload. As a result, the upload dark upload light icon is added to the selected database name in the Database column.

    adbc offload3 dark
    The selected database is marked
    adbc offload3 light
    The selected database is marked
NOTE

If you later need to change databases or stop the offloading process for the cluster completely, click the upload dark upload light icon in the Actions column for the specified cluster and make the necessary changes.

Configure GUC

Starting with ADB Control 4.7.5, you can configure values of the GUCs that control ADB Control behavior. To view or edit current GUC values, click the setup dark setup light icon opposite the desired cluster on the Configuration → Clusters page.

Go to configuring GUCs
Go to configuring GUCs
Go to configuring GUCs
Go to configuring GUCs

In the window that opens, change the current GUC values if necessary, and click Save.

GUCs for the selected cluster
GUCs for the selected cluster
GUCs for the selected cluster
GUCs for the selected cluster

Available GUCs are shown in the table below.

GUCs that manage ADB Control behavior
GUC name UI description

adcc.monitor_inner_queries

Send inner queries metrics to ADCC

adcc.monitor_utility_inner_queries

Send utility inner queries metrics to ADCC

adcc.explain_log_buffers

Log buffers usage for EXPLAIN ANALYZE plan

adcc.explain_log_timing

Collect timing data, not just row counts for EXPLAIN ANALYZE plan

adcc.explain_log_analyze

Send EXPLAIN ANALYZE at the end of the query

adcc.explain_log_verbose

Use VERBOSE for EXPLAIN ANALYZE plan

adcc.explain_log_min_duration

Sets the minimum execution time above which EXPLAIN ANALYZE plans will be sent (in milliseconds)
Found a mistake? Seleсt text and press Ctrl+Enter to report it