> For the complete documentation index, see [llms.txt](https://mariadb.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mariadb.com/docs/gridgain/gridgain-9/gridgain9-get-started/how-to-guides/prometheus-grafana-step-by-step.md).

# How to Monitor GridGain 9 With Prometheus and Grafana

Export GridGain 9 metrics over OTLP to Prometheus, then connect Grafana to visualize cluster performance with a prebuilt dashboard.

## Prerequisites

* **GridGain 9.1.28** or later
* [**Grafana OSS**](https://grafana.com/docs/grafana/latest/setup-grafana/) 12.4.0
* [**Prometheus**](https://prometheus.io/download/) server 3.1.0

## Overview

GridGain offers built-in support for monitoring its performance using tools like Prometheus and Grafana. This guide walks you through setting up GridGain to send metrics to Prometheus via the OpenTelemetry (OTLP) protocol, and configuring Grafana to visualize these metrics.

The integration process has three steps:

1. [Configure GridGain](#configure-gridgain)
2. [Configure the Prometheus server](#configure-the-prometheus-server)
3. [Configure Grafana](#configure-grafana)

## Configure GridGain

To export metrics from your GridGain cluster, you need to modify the cluster configuration via the [CLI tool](/docs/gridgain/gridgain-9/gridgain9-management/using-the-cli-tool.md).

1. Open the CLI and connect to any node in the cluster.
2. Specify the `exporterName` as the name for your OTLP endpoint and the `endpoint` as the address of your Prometheus server.
3. Run the `cluster config update` command with the modified configuration as an argument. The updated configuration is automatically applied across the cluster.

   ```bash
   cluster config update ignite.metrics.exporters.test: {exporterName:otlp, endpoint:"http://localhost:9090/api/v1/otlp/v1/metrics", protocol:"http/protobuf"}
   ```
4. After successfully running the command, you see a `Cluster configuration was updated successfully` message, and GridGain automatically starts sending metrics to the specified endpoint.

If it is your first time setting up a GridGain cluster, check the corresponding [documentation section](/docs/gridgain/gridgain-9/gridgain9-management/cluster-configuration.md) for more details.

## Configure the Prometheus Server

GridGain 9 comes with a built-in OTLP provider that lets you export the cluster's metrics. These metrics can then be collected and processed by [Prometheus](https://prometheus.io/download/) without any extra configuration steps.

All you need to do is start your Prometheus server with the `--web.enable-otlp-receiver` option to receive metrics:

{% tabs %}
{% tab title="Unix" %}

```bash
./prometheus --config.file=./prometheus.yml --web.enable-otlp-receiver
```

{% endtab %}

{% tab title="Windows" %}

```bash
prometheus.exe --config.file=./prometheus.yml --web.enable-otlp-receiver
```

{% endtab %}
{% endtabs %}

By default, Prometheus starts on port `9090`. Check <http://localhost:9090> to verify it is up and running.

For further instructions and how-to guidance, see the [Prometheus documentation](https://prometheus.io/docs/prometheus/latest/getting_started/).

## Configure Grafana

Finally, you set up [Grafana](https://grafana.com/docs/grafana/latest/setup-grafana/) to monitor and display your metrics.

1. Download and install Grafana.
2. Once installed, start Grafana:

{% tabs %}
{% tab title="Unix" %}

```bash
./bin/grafana server
```

{% endtab %}

{% tab title="Windows" %}

```bash
bin\grafana.exe server
```

{% endtab %}
{% endtabs %}

By default, Grafana is available at <http://localhost:3000/login>.

3. Log in with the default credentials: `admin` / `admin`. You must change them after your first login for security reasons.
4. Open **Connections** > **Data sources** and click **Add data source**.
5. Select **Prometheus**, enter your Prometheus server URL (for example, `http://localhost:9090`) under **Connection**, and click **Save & test**. Grafana confirms with `Successfully queried the Prometheus API`.

   ![Add data source in Grafana](https://709350093-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoHbGEk22iR73P3x6DryR%2Fuploads%2Fgit-blob-6247aec5c186055ab816ef8acdf5914c3b338a40%2Fadd_datasource.png?alt=media)

Once configured, Grafana starts receiving GridGain metrics from Prometheus. For a more detailed installation guide and how-to guidance, refer to the [official documentation](https://grafana.com/docs/grafana/latest/setup-grafana/).

### Importing a Sample Dashboard

To help you quickly start collecting and visualizing GridGain metrics, we have prepared a pre-configured sample dashboard that you can import into Grafana. This dashboard provides a structured view of key cluster metrics, making it easier to monitor performance in real time.

1. Download the [sample dashboard JSON file](https://github.com/mariadb-corporation/mariadb-docs/tree/main/gridgain-9/.gitbook/assets/gg9_dashboard_9.1.28.json).
2. Go to **Dashboards** → **Create Dashboard**, click **Import Dashboard**, and upload the file. When Grafana asks for the Prometheus data source, select the one you added earlier.

   ![Import dashboard in Grafana](https://709350093-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoHbGEk22iR73P3x6DryR%2Fuploads%2Fgit-blob-67d46fb355b08cc05eb517e86ec7de70b1831b44%2Fimport_dashboard.png?alt=media)
3. After a successful import, Grafana displays your cluster metrics.

   ![GridGain cluster metrics in Grafana](https://709350093-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FoHbGEk22iR73P3x6DryR%2Fuploads%2Fgit-blob-d0e81dc47f8c424a2e72e10ce92087cd64159c94%2Fmetrics.png?alt=media)

Now that your dashboard is set up, you have a comprehensive view of your GridGain metrics, enabling efficient monitoring, analysis, and performance tuning. To dive deeper into metrics and monitoring in GridGain, visit the corresponding [documentation section](/docs/gridgain/gridgain-9/gridgain9-management/monitoring/configuring-metrics.md).

## Related

* [Configuring Metrics](/docs/gridgain/gridgain-9/gridgain9-management/monitoring/configuring-metrics.md) - Reference for the metrics subsystem and available exporters.
* [Prometheus getting started](https://prometheus.io/docs/prometheus/latest/getting_started/) - Set up and configure the Prometheus server.