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 a 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

Cluster name

A cluster name

Status

A cluster status:

  • Active — the cluster is currently monitored.

  • Archived — the cluster monitoring is suspended.

Default cluster

For a default cluster, the Default label is shown. Otherwise, No

JDBC URL

A URL of the JDBC connection

Username

A user name that is used to connect to a cluster

In the column headers of the table with a list of clusters, there are filters that you can use to select specific data. To open a filter, click the openside dark openside light icon. For those columns where the set of possible values is limited (e.g. Status), you can select a value from the drop-down list. For some columns (e.g. Cluster name), the search value should be entered.

The filtered dark filtered light icon means that a filter is defined for the column. To reset all filters, click Reset.

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).

  • 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 IP-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.

    • In the External ADB Control port field, enter the number of the port where the target ADB Control service is deployed. The default value is 81.

    • 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.

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

  3. Click Save to apply changes.

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 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 column in the table of clusters displays Default for a new default cluster and No — for a previous 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. Click the icon archive dark icon archive light icon in the Actions column on the Configuration → Clusters tab.

    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 Apply.

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

    As a result, the cluster status is changed to Archived 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, click the icon dearchive dark icon dearchive light icon in the Actions column for that cluster on the Configuration → Clusters tab and confirm the action in the window that opens.

Configure monitoring of the selected cluster

To navigate to the cluster monitoring configuration, click a cluster name on the Configuration → Clusters tab.

adbc config select dark
Go to the cluster configuration
adbc config select light
Go to the cluster configuration

The top of the opened page displays a cluster name, the default label (if a cluster is selected by default), and a number of control elements for a quick transition to the actions described above:

adbc config select dark2
Available cluster actions
adbc config select light2
Available cluster actions

The main part of the opened page contains several sections that are described below. To apply any changes to the parameters in these sections, click Apply in the appropriate section, to undo the changes that have not been yet saved — click Revert.

Databases monitoring

In the Databases monitoring section on the cluster page, you can select databases that should be monitored in ADB Control. By default, all databases are selected.

adbc config select dark3
Select databases for monitoring
adbc config select light3
Select databases for monitoring

GUC management

In the GUC management section on the cluster page, you can configure values of the GUCs that control ADB Control behavior.

adbc config select dark4
Configure GUCs
adbc config select light4
Configure GUCs

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)

Metric offload

The Metric offload section of the cluster page allows you to select databases, which metrics will be offloaded to the external analytical database (according to the schedule that is configured on the Configuration → Job policy → Metrics offload page). By default, no database is selected.

adbc config select dark5
Select databases to offload metrics
adbc config select light5
Select databases to offload metrics
Found a mistake? Seleсt text and press Ctrl+Enter to report it