Node Monitoring Setup

This guide describes how to configure monitoring for your Pharos node using Prometheus Pushgateway.

Overview

Pharos nodes can push metrics to a Prometheus Pushgateway, which allows you to monitor node performance, block production, and other key metrics.

Configuration

To enable monitoring, add the monitor_config section to your pharos.conf file.

Example Configuration

Note: These configuration keys require v0.16.0 or later. In earlier versions they were named enable_pamir_cetina and pamir_cetina_*. Using the wrong key names for your node version will silently disable metrics pushing without any error, so make sure the names match your node version.

{
  "chain": {
    "monitor_config": {
      "storage_enable_cetina": true,
      "storage_cetina_job_name": "your_job_name",
      "storage_cetina_push_address": "your_pushgateway_address",
      "storage_cetina_push_interval": 5,
      "storage_cetina_push_port": 9091
    },
    "secret_config": {
      "domain_key_path": "../keys/domain.key",
      "stabilizing_key_path": "../keys/stabilizing.key"
    },
    "startup_config": {
      "init_config": {
        "meta_path": "../data",
        "host_ip": "127.0.0.1",
        "http_port": "18100",
        "rpc_port": "20000",
        "tcp_port": "19000",
        "ws_port": "18200"
      }
    }
  },
  "storage": {
    "mygrid_conf": {},
    "mygrid_env": {
      "storage_data_path": "../data"
    }
  }
}

Configuration Parameters

Parameter	Description	Example
storage_enable_cetina	Enable/disable metrics pushing	true
storage_cetina_job_name	Job name for Prometheus metrics	"atlantic_testnet"
storage_cetina_push_address	Pushgateway address (without protocol)	"your_pushgateway_address"
storage_cetina_push_interval	Push interval in seconds	5
storage_cetina_push_port	Pushgateway port	9091

Version note: In v0.15.0 and earlier, these keys were named enable_pamir_cetina, pamir_cetina_job_name, pamir_cetina_push_address, pamir_cetina_push_interval, and pamir_cetina_push_port respectively.

Setup Steps

1. Ensure you have a Prometheus Pushgateway running and accessible from your node

2. Edit your pharos.conf file and add the monitor_config section under chain:

vim pharos.conf

1. Replace the placeholder values:

   • your_job_name: A unique identifier for your node (e.g., my_validator_node)

   • your_pushgateway_address: Your Pushgateway hostname or IP

2. Restart your node to apply the changes:

For Docker:

docker compose restart

For Binary:

./ops stop --force
./ops start --config ./pharos.conf