Monitoring cluster based on VictoriaMetrics

Anton Vasilev

Overview

Monitoring based on VictoriaMetrics is available in the Enterprise Edition of ADB starting with version 6.32.0.

To configure monitoring, use:

  • ADM cluster version 5.0.0 and above. An external VictoriaMetrics server can be used.

  • The VMAgent component of the Monitoring service of the ADB cluster — available in ADB starting with 6.32.0.

VMAgent collects metrics from the ADB cluster and sends them to the ADM cluster. If the Grafana service is used in ADM, dashboards with service and ADB host metrics are available in the Grafana web interface.

The steps for installing the VMAgent component and setting up monitoring are described below.

Step 1. Install ADM

Install the ADM cluster (see the Installation guide), whose server configuration you will later import into ADB.

The ADM cluster can be installed before or after the ADB cluster, but should be installed before installing the VMAgent component of the Monitoring service.

Step 2. Add the Monitoring service

  1. In the ADCM interface, open the Clusters page and click your ADB cluster name. On the cluster page that opens, switch to the Services tab and click Add services.

    Switch to adding services
    Switch to adding services

  2. In the window that opens, select the Monitoring service and click Add.

    Select the service
    Select the service

    As a result, the added service is displayed on the Services tab.

    Result of successfully adding the service to the cluster
    Result of successfully adding the service to the cluster

Step 3. Add components

  1. On the cluster page, open the Mapping tab to proceed to mapping service components to cluster hosts. Scroll down to the Monitoring section.

    Switch to mapping service components
    Switch to mapping service components

  2. Assign hosts to components of the Monitoring service — click Add hosts and select the hosts:

    • The VMAgent component is recommended to be installed on a host separate from ADB. This setup ensures independent monitoring access if an ADB host is unavailable.

    • For the Node Exporter component, select hosts from which you want to collect hardware and operating system metrics. In practice, this means installing it on every host in the cluster.

    • For the Greengage Exporter component, select the master host to collect cluster- and database-related metrics from it. If your cluster has a standby master, you must also select its host for the Greengage Exporter component. Metrics from the standby master host will be collected only when it becomes the active master.

    • For the Process Exporter component, select hosts where ADBM agents and ADB Control agents are installed — that is, select all ADB hosts.

    • The Prometheus Server and Grafana components are not required: they are used by the Prometheus-based monitoring only. ADM provides its own Grafana service.

      Select hosts for components
      Select hosts for components

  3. After the distribution of components is completed, click Save.

IMPORTANT

When using VMAgent, if you add or remove an exporter after the Monitoring service is installed, run the Reconfigure and restart action of the Monitoring service to reconfigure VMAgent and update the Grafana dashboards in ADM with new metrics.

Step 4. Configure VMAgent

  1. Open the Services tab on the cluster page and click the Monitoring service name in the Name column.

  2. On the page that opens, fill in the configuration parameters in the VMAgent section — see the Monitoring section in the Configuration parameters article for parameter descriptions.

    Configure the Monitoring service
    Configure the Monitoring service

  3. After specifying all necessary parameters, click Save.

Step 5. Import

Import ADM configuration

  1. Open the Import tab on the ADB cluster page.

  2. Check the Cluster configuration box in the row with the ADM cluster.

  3. Click Import.

Integration with an ADM cluster
Integration with an ADM cluster

Import external VictoriaMetrics server configuration

When using an external VictoriaMetrics server, the destination server must be specified in ADB.

  1. Open the Monitoring service configuration parameters.

  2. Expand the VMAgent section and click Add property in the Custom remote_write section.

  3. Enter a remote write endpoint URL of an external VictoriaMetrics server as the Custom remote_write value, for example http://192.0.2.10:8480/insert/0/prometheus/api/v1/write. The port and endpoint depend on whether you use a single-node or cluster version of VictoriaMetrics.

Integration with a VictoriaMetrics server
Integration with a VictoriaMetrics server

Step 6. Install the Monitoring service

  1. On the Services tab, click the Actions icon Actions icon icon for the Monitoring service in the Actions column and run the Install action.

    Switch to the service installation
    Switch to the service installation

  2. Wait until the installation is completed. Then check that the service state has changed from created to installed.

    To view the service installation progress and analyze errors if they occur, select Jobs in the left navigation menu and click the Install job name in the Jobs list.

    Install service job page
    Install service job page

    Refer to ADCM documentation for a description of the Jobs tab.

Step 7. Check the results

To check that ADB integration with VictoriaMetrics is correctly configured, open the Grafana web interface as described in Open Grafana.

Found a mistake? Seleсt text and press Ctrl+Enter to report it