Monitoring cluster based on VictoriaMetrics

Overview

Monitoring based on VictoriaMetrics is available in ADS only for the Enterprise version starting from 4.0.0.b1.

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 ADS cluster — available starting with 4.0.0.b1.

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

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

NOTE

The installation description provided in the article is relevant for clusters where the Monitoring service has not been previously installed. If the Monitoring service is already installed — follow these steps:

  1. Import configuration of the ADM cluster or external VictoriaMetrics.

  2. Install the VMAgent component for the Monitoring service using the Add/Remove components service action after upgrading the cluster to 4.0.0.b1. Components that have already been installed in the Monitoring service (Grafana, Node Exporter, Prometheus Server) do not need to be removed.

  3. Configure the VMAgent component if necessary. After making changes to the configuration, restart the Monitoring service.

  4. Check the results of the VMAgent component installation.

Step 1. Install ADM

Install the ADM cluster (see the Installation guide), which is used as the base for import of the VictoriaMetrics server configuration.

The ADM cluster can be installed before or after the ADS 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 ADS 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 opened window, 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 successful adding the service to the cluster
    Result of successfully adding the service to the cluster

Step 3. Add the VMAgent component

  1. On the cluster page, open the Mapping tab to proceed to mapping instances of the VMAgent component to cluster hosts.

    Switch to mapping service components
    Switch to mapping service components
  2. Assign a host to the VMAgent component of the Monitoring service — click Add hosts and select the desired host in the pop-up window.

    Select a host for a component
    Select a host for a component
  3. After the distribution of components is completed, click Save.

Step 4. Configure VMAgent

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

    Switch to the service configuration
    Switch to the service configuration
  2. On the page that opens, fill in or change the parameter values in the VMAgent group of the service configuration parameters as needed — descriptions of the parameters are provided in the Monitoring configuration parameters article. Also, fill in the fields highlighted in red, as they are mandatory, even if the components associated with these parameters are not added to the service (Prometheus Server, Grafana).

    Configure the Monitoring service
    Configure the Monitoring service

    After specifying all necessary parameters, click Save.

Step 5. Import

Import ADM configuration

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

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

  3. Click Import.

Integration with ADM Cluster
Integration with ADM Cluster

Import external VictoriaMetrics server configuration

When using an external VictoriaMetrics server, the server configuration must be imported into ADS. To do this, go to the Monitoring service settings, as shown above, and in the VMAgent group for the Custom remote_write parameter, use the Add property field to set the value url: "http://<vm-central>:8428/api/v1/write", where <vm-central> is the IP address of the external VictoriaMetrics server.

Step 6. Install the Monitoring service

  1. On the Services tab, click actions default dark actions default light for the Monitoring service in the Actions column and run the Install action.

    Switch to the service installation
    Switch to the service installation
  2. Confirm the action in the opened window.

  3. Wait for the installation to complete and make sure the service status changes from created to installed.

    Installation is complete
    Installation is complete

    To view the service installation process 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

Step 7. Check the results

After configuring cluster ADS metric monitoring, they are displayed in the VictoriaMetrics web interfaces.

The optimal way to manage VictoriaMetrics metrics of the ADS cluster is through the Grafana web interface.

ADS dashboards in the Grafana web interface
ADS dashboards in the Grafana web interface
Found a mistake? Seleсt text and press Ctrl+Enter to report it