Configure Ethereum Clients

Configuration consensus and execution clients to serve metrics and API data

Each consensus and execution client must have the appropriate metrics services and APIs enabled and accessible to the supporting software. Find your clients below and ensure that the required command-line flags/configuration values are present in your startup scripts, configuration files, or service files.

Refer to the guides you originally used to set up your clients for help determining where the following options should be set.

Consensus Clients

In addition to other command-line flags, the following Lighthouse flags may be required to support the dashboard.

Required

--metrics - Enables the Prometheus metrics service

Optional

--metrics-address 0.0.0.0 - Authorizes Lighthouse to answer metrics requests from other IP addresses. This is only required if you want to run Prometheus on a separate system

The default metrics port for Lighthouse is 5054.

The default REST API port for Lighthouse is 5052.

If you would like other IP addresses to have access to Lighthouse's metrics, do not expose Lighthouse's metrics port to the Internet. Keep the metrics port closed at your router.

In addition to other command-line flags, the following flags are required to support the dashboard.

Required

--metrics true - Enables the Prometheus metrics service
--rest - Enables the HTTP API

Optional

--metrics.address 0.0.0.0 - Authorizes Lodestar to answer metrics requests from other IP addresses. Only required if you want to run Prometheus on a separate system
--rest.address '0.0.0.0' - Authorizes Lodestar to answer HTTP API requests from other IP addresses. Only required if you want to run Prometheus on a separate system

The default metrics port for Lodestar is 8008.

The default REST API port for Lodestar is 9596.

If you would like other IP addresses to have access to Lodestar's metrics, do not expose Lodestar's port to the Internet. Keep the metrics port closed at your router.

In addition to other command-line flags, the following Nimbus flags may be required to support the dashboard.

Required

--metrics - Enables the Prometheus metrics service
--rest - Enables the REST API

Optional

--metrics-address 0.0.0.0 - Authorizes Lighthouse to answer metrics requests from other IP addresses. Only required if you want to run Prometheus on a separate system.
--rest-address 0.0.0.0 - Authorizes Lighthouse to answer API requests from other IP addresses. Only required if you want to run Prometheus on a separate system.

The default metrics port for Nimbus is 8008.

The default REST API port for Nimbus is 5052.

If you would like other IP addresses to have access to Nimbus' metrics, do not expose Nimbus' port to the Internet. Keep the metrics port closed at your router.

In addition to other command-line flags, the following flags are required to support the dashboard.

Required

--monitoring-host 0.0.0.0 - Authorizes Lighthouse to answer metrics requests from other IP addresses. Only required if you want to run Prometheus on a separate system.

Optional

--grpc-gateway-host '0.0.0.0' - Authorizes Prysm to answer API requests from other IP addresses. Only required if you want to run Ethereum Metrics Exporter or json_exporter on systems separate from Prysm.

The default metrics port for the Prysm beacon chain is 8080.

The default metrics port for the Prysm validator is 8081.

The default REST API port for the Prysm beacon chain is 3500.

If you would like other IP addresses to have access to Prysm's metrics, do not expose Prysm's port to the Internet. Keep the metrics port closed at your router

In addition to other command-line flags, the following Teku flags may be required to support the dashboard.

Required

--metrics-enabled - Enables the Prometheus metrics service
--rest-api-enabled - Enables the REST API
--metrics-categories=JVM,PROCESS,BEACON,DISCOVERY,EVENTBUS,EXECUTOR,LIBP2P,NETWORK,STORAGE,STORAGE_HOT_DB,STORAGE_FINALIZED_DB,REMOTE_VALIDATOR,VALIDATOR,VALIDATOR_PERFORMANCE - Turns on all metrics

Optional

--metrics-interface 0.0.0.0 - Authorizes Teku to answer metrics requests from other IP addresses. Only required if you want to run Prometheus on a separate system.
--rest-api-interface 0.0.0.0 - Authorizes Teku to answer API requests from other IP addresses. Only required if you want to run Prometheus on a separate system.
--rest-api-host-allowlist 0.0.0.0 - Authorizes Teku to answer API requests from other IP addresses. Only required if you want to run Prometheus on a separate system.
--metrics-host-allowlist 0.0.0.0 - Authorizes Teku to answer metrics requests from other IP addresses. Only required if you want to run Prometheus on a separate system.

The default metrics port for Teku is 8008.

The default REST API port for Teku is 5051.

If you would like other IP addresses to have access to Teku's metrics, do not expose Teku's port to the Internet. Keep the metrics port closed at your router

Execution Clients

In addition to other command-line flags, the following Besu flags may be required to support the dashboard.

Required

--metrics-enabled - Enables the Prometheus metrics service
--rpc-http-enabled - Enables the HTTP API
--rpc-http-api=ETH,NET,WEB3,TXPOOL - These API namespaces are required, in addition to any others you already use.
--metrics-protocol=PROMETHEUS - Configures Besu to return metrics in Prometheus format
--metrics-category=BLOCKCHAIN,ETHEREUM,EXECUTORS,NETWORK,PEERS,PERMISSIONING,PRUNER,RPC,SYNCHRONIZER,TRANSACTION_POOL,STRATUM,JVM,PROCESS - Turns on all metrics

Optional

--metrics-host=0.0.0.0 - Authorizes Besu to answer metrics requests from other IP addresses. Only required if you want to run Prometheus on a separate system.
--rpc-http-host=0.0.0.0 - Authorizes Besu to answer API requests from other IP addresses. Only required if you want to run Prometheus on a separate system.
--host-allowlist="*" - TBD

The default metrics port for Besu is 9545.

The default RPC port for Besu is 8545.

If you would like other IP addresses to have access to Besu's metrics, do not expose Besu's port to the Internet. Keep the metrics port closed at your router.

In addition to other command-line flags, the following Erigon flags may be required to support the dashboard.

Required

--metrics - Enables the Prometheus metrics service
--http - Enables the HTTP API
--http.api=eth,net,txpool,web3 - These API namespaces are required, in addition to any others you already use.
--private.api.addr=0.0.0.0:9091 - Required to change the private API port to from its default of 9090 to 9091. It conflicts with Prometheus' use of port 9090.

Optional

--metrics.addr 0.0.0.0 - Authorizes Erigon to answer metrics requests from other IP addresses. Only required if you want to run Prometheus on a separate system.
--http.addr 0.0.0.0 - Authorizes Erigon to answer API requests from other IP addresses. Only required if you want to run Prometheus on a separate system.

The default metrics port for Erigon is 6060.

The default RPC port for Erigon is 8545.

If you would like other IP addresses to have access to Erigon's metrics, do not expose Erigon's port to the Internet. Keep the metrics port closed at your router.

In addition to other command-line flags, the following Geth flags may be required to support the dashboard.

Required

--metrics - Enables the Prometheus metrics service
--http - Enables the HTTP API
--http.api net,web3,eth,txpool - These API namespaces are required, in addition to any others you already use.

Optional

--metrics.addr=0.0.0.0 - Authorizes Geth to answer metrics requests from other IP addresses. Only required if you want to run Prometheus on a separate system.
--http.addr=0.0.0.0 - Authorizes Geth to answer API requests from other IP addresses. Only required if you want to run Prometheus on a separate system.

The default metric port for Geth is 6060.

The default RPC port for Geth is 8545.

If you would like other IP addresses to have access to Geth's metrics, do not expose Geth's port to the Internet. Keep the metrics port closed at your router.

In addition to other command-line flags, the following Nethermind flags may be required to support the dashboard.

Required

--Metrics.Enabled true - Enables the Prometheus metrics service
--Metrics.ExposePort 8080 - Required to open the metrics port

Optional

--JsonRpc.Host 0.0.0.0 - Authorizes Nethermind to answer API requests from other IP addresses. Only required if you want to run Prometheus on a separate system.

The default metrics port for Nethermind is 8080.

The default RPC port for Nethermind is 8545.

If you would like other IP addresses to have access to Nethermind's metrics, do not expose Nethermind's port to the Internet. Keep the metrics port closed at your router.

Restart all clients for which the configuration changed. Refer to the guides you originally used to set up your clients for help determining how to restart the clients and whether any configuration changes have taken effect.

PreviousInstall Ethereum Metrics Exporter NextConfigure Supporting Software

Last updated 1 year ago