GridGain Developers Hub

Connecting an Apache Ignite Cluster

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

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

  1. Configure your cluster

    1. Download the Control Center Agent module

    2. Enable metrics

  2. Register the cluster in Nebula

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

Connect Apache Ignite Cluster to Nebula

Configuring Your Cluster

Enabling the Control Center Module

The connection between the cluster and Nebula 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-[agent-version].zip archive from

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


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

Maven Artifact

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

        <id>GridGain External Repository</id>


Enabling Metrics

Nebula collects metrics from the clusters that are running. Most metrics are available by default, but some metrics must be enabled in the cluster before you can view them in Nebula.

You can enable metrics in two ways:

  • In the cluster configuration, or

  • Via JMX Beans at runtime

Refer to this page for details.

Enabling Tracing

You can enable tracing capabilities and view traces in Nebula in two ways:

  1. The best way to configure tracing is to use the Tracing screen.

  2. To configure tracing programmatically, see the Tracing page for more detail.

Embedded Mode

When launching Ignite in embedded mode, please include the following JVM arguments: