GridGain Developers Hub

Connecting an Apache Ignite Cluster

This page explains how to connect an Apache Ignite cluster to GridGain Control Center. You can connect as many clusters as you want. Control Center allows you to switch between the clusters at will.

A standard procedure for connecting an Ignite cluster to Control Center involves the following steps:

  1. Configure your cluster

    1. Download the Control Center Agent module

    2. Enable metrics

  2. Register the cluster in Control Center

The following diagram illustrates how Control Center interacts with the cluster and web browser.

Connect Apache Ignite Cluster to Control Center

Configuring Your Cluster

Enabling the Control Center Module

The connection between the cluster and Control Center is initiated from the cluster side. For this to happen, you need to enable the control-center-agent module in the cluster. The module must be enabled on all server nodes. If you plan to connect client nodes to your cluster, enable the module on the client nodes as well. Otherwise, you will get the following exception on the client node:

java.lang.ClassNotFoundException: org.gridgain.control.agent.configuration.ControlCenterAgentConfiguration

Binary Package

  1. Download the control-center-agent-2.8.1.2.zip archive from https://gridgain.com/download#controlcenter:

    Download Gridgain Control Center module

  2. Unpack the archive into the folder with the Apache Ignite installation. The archive contains the following folders:

    bin/
    libs/
        control-center-agent/

    Copy the content of the bin folder to {IGNITE_HOME}/bin/, and the control-center-agent folder to {IGNITE_HOME}/libs.

    If you start Ignite nodes from a java application, manually copy the libraries from gridgain-control-center-agent-{version}/libs/control-center-agent to your classpath.

  3. Start your cluster. You should see the following message in the console output of the coordinator node:

    node output

    You can copy the link and open it in your browser, or copy the ID and add the cluster in Control Center.

Maven Artifact

If you use Maven to start your nodes, add the following dependency to your pom.xml:

<repositories>
    <repository>
        <id>GridGain External Repository</id>
        <url>http://www.gridgainsystems.com/nexus/content/repositories/external</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>org.gridgain</groupId>
        <artifactId>control-center-agent</artifactId>
        <version>2.8.1.2</version>
    </dependency>
</dependencies>

Enabling Metrics

Control Center collects metrics from the GridGain/Ignite cluster that are running. Most metrics are available by default, but some metrics must be enabled in the cluster before you can view them in Control Center.

You can enable metrics in two ways:

  • In the cluster configuration, or

  • Via JMX Beans at runtime

Refer to this page for details.

Control Center URI

The Control Center URI is the URI where the GridGain Control Center is running. Your cluster must know that URI to be able to establish connection with Control Center.

When started with "control-center-agent" enabled, the cluster tries to connect to the following URLs:

  1. http://localhost:3000.

  2. https://control.gridgain.com

If connection to one of the addresses is established, you should see the following messages in the output of the coordinator node:

node console output

If your Control Center instance is running on a different machine or on different port, you can set the Control Center URI at runtime using the management script:

{GRIDGAIN_HOME}/bin/management.sh --uri https://control_center_uri:8008

Note the ID of the cluster in the node output. You will need it to add the cluster in the Control Center UI. See Connecting a Cluster.