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.

View a list of clusters

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

adbc config clusters
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

User

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 is the Search cluster…​ filter, which you can use to select specific data (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.

Add automatically

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
    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
    Cluster is available for monitoring

Add manually

NOTE

Adding an ADB cluster to ADB Control does not mean collecting metrics from that cluster. For this, ADB Control agents should be running in the cluster.

You can also add a new cluster connection manually via the ADB Control web interface. To do this, follow the steps:

  1. Perform steps 1-3 that are listed above.

  2. In the web interface of the target ADB Control (which will be used for monitoring), open the Configuration → Clusters tab and click Create connection.

    adbc config clusters3
    Switch to adding a cluster via ADB Control

  3. In the window that opens, fill in the following fields:

    • Cluster name — a name of the cluster to be monitored. Note that you should enter the name assigned to the cluster via ADCM.

    • 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 clusters4
      Enter cluster connection data

  4. Click Save. As a result, a new cluster is displayed on the Configuration → Clusters tab.

    adbc config clusters5
    Cluster is added

Edit a cluster

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
    Switch to editing cluster data

  2. In the window that opens, edit necessary fields. All fields are the same as described above. The Cluster name field value cannot be changed.

    adbc config clusters8
    Edit cluster data

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

    adbc config clusters9
    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 cluster on the Configuration → Clusters tab.

    adbc config clusters10
    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
    Select a default cluster

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

    adbc config clusters12
    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
    Switch to the cluster archiving

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

    adbc config clusters14
    Confirm the operation

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

    adbc config clusters15
    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
    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
    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
    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.
Found a mistake? Seleсt text and press Ctrl+Enter to report it