Skip to content

HOP: Setup Guide

HOP is a Docker Compose bundle for Prometheus + Grafana around a running Optimum Gateway. Use it to scrape gateway metrics and view the partner dashboard locally.

Gateway install, API key, config, and CL wiring (Prysm, Lighthouse, Teku, Nimbus, Lodestar): Optimum Gateway documentation (latest).

Prerequisites

  • Docker and Docker Compose
  • curl and jq
  • Optimum Gateway running with telemetry_enable: true
  • Ports 48123, 9090, and 3000 free on the host

Quick start

1. Run the Optimum Gateway

Follow the Gateway quick start (API key, app_conf.yml, Docker run).

2. Start Prometheus + Grafana

bash
cd integration/grafana

Edit prometheus/targets.json so Prometheus can scrape your gateway at :48123 (e.g. host.docker.internal:48123 if the gateway runs outside the compose network).

bash
docker compose -f docker-compose-grafana.yml up -d

URLs and checks

ServiceURL
Grafanahttp://localhost:3000 (default admin / admin)
Prometheushttp://localhost:9090
Gateway API / metricshttp://localhost:48123
bash
curl -s http://localhost:48123/health | jq '{status, checks: .checks.cl_peers}'
curl -s http://localhost:48123/metrics | grep mump2p_gateway

With a CL client connected, checks.cl_peers should be ≥ 1. See Gateway metrics for the full mump2p_gateway_* set.

Import dashboard only

Copy integration/grafana/grafana-dashboards/partner-dashboard.json into your Grafana instance (Dashboards → Import), or see the Gateway telemetry guide.

Troubleshooting

Further reading