Go-ethereum

Plugin: go.d.plugin Module: geth

Overview

This collector monitors Go-ethereum instances.

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Go-ethereum can be monitored further using the following other integrations:

• Applications

Default Behavior

Auto-Detection

By default, it detects Go-ethereum instances running on localhost.

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Setup

You can configure the geth collector in two ways:

Method	Best for	How to
UI	Fast setup without editing files	Go to Nodes → Configure this node → Collectors → Jobs, search for geth, then click + to add a job.
File	If you prefer configuring via file, or need to automate deployments (e.g., with Ansible)	Edit go.d/geth.conf and add a job.

important

UI configuration requires paid Netdata Cloud plan.

Prerequisites

No action required.

Configuration

Options

The following options can be defined globally: update_every, autodetection_retry.

Config options

Option	Description	Default	Required
update_every	Data collection frequency.	1	no
autodetection_retry	Recheck interval in seconds. Zero means no recheck will be scheduled.	0	no
url	Server URL.	http://127.0.0.1:6060/debug/metrics/prometheus	yes
timeout	HTTP request timeout.	1	no
username	Username for basic HTTP authentication.		no
password	Password for basic HTTP authentication.		no
proxy_url	Proxy URL.		no
proxy_username	Username for proxy basic HTTP authentication.		no
proxy_password	Password for proxy basic HTTP authentication.		no
method	HTTP request method.	GET	no
body	HTTP request body.		no
headers	HTTP request headers.		no
not_follow_redirects	Redirect handling policy. Controls whether the client follows redirects.	no	no
tls_skip_verify	Server certificate chain and hostname validation policy. Controls whether the client performs this check.	no	no
tls_ca	Certification authority that the client uses when verifying the server's certificates.		no
tls_cert	Client TLS certificate.		no
tls_key	Client TLS key.		no

via UI

Configure the geth collector from the Netdata web interface:

1. Go to Nodes.
2. Select the node where you want the geth data-collection job to run and click the ⚙ (Configure this node). That node will run the data collection.
3. The Collectors → Jobs view opens by default.
4. In the Search box, type geth (or scroll the list) to locate the geth collector.
5. Click the + next to the geth collector to add a new job.
6. Fill in the job fields, then click Test to verify the configuration and Submit to save.
   • Test runs the job with the provided settings and shows whether data can be collected.
   • If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.

via File

The configuration file name for this integration is go.d/geth.conf.

The file format is YAML. Generally, the structure is:

update_every: 1
autodetection_retry: 0
jobs:
  - name: some_name1
  - name: some_name2

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/geth.conf

Examples

Basic

A basic example configuration.

jobs:
  - name: local
    url: http://127.0.0.1:6060/debug/metrics/prometheus

HTTP authentication

Basic HTTP authentication.

Config

jobs:
  - name: local
    url: http://127.0.0.1:6060/debug/metrics/prometheus
    username: username
    password: password

Multi-instance

Note: When you define multiple jobs, their names must be unique.

Collecting metrics from local and remote instances.

Config

jobs:
  - name: local
    url: http://127.0.0.1:6060/debug/metrics/prometheus

  - name: remote
    url: http://192.0.2.1:6060/debug/metrics/prometheus

Alerts

There are no alerts configured by default for this integration.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per Go-ethereum instance

These metrics refer to the entire monitored application.

This scope has no labels.

Metrics:

Metric	Description	Dimensions	Unit
geth.eth_db_chaindata_ancient_io_rate	Ancient Chaindata rate	reads, writes	bytes/s
geth.eth_db_chaindata_ancient_io	Session ancient Chaindata	reads, writes	bytes
geth.eth_db_chaindata_disk_io	Session chaindata on disk	reads, writes	bytes
geth.goroutines	Number of goroutines	goroutines	goroutines
geth.eth_db_chaindata_disk_io_rate	On disk Chaindata rate	reads, writes	bytes/s
geth.chaindata_db_size	Chaindata Size	level_db, ancient_db	bytes
geth.chainhead	Chainhead	block, receipt, header	block
geth.tx_pool_pending	Pending Transaction Pool	invalid, pending, local, discard, no_funds, ratelimit, replace	transactions
geth.tx_pool_current	Transaction Pool	invalid, pending, local, pool	transactions
geth.tx_pool_queued	Queued Transaction Pool	discard, eviction, no_funds, ratelimit	transactions
geth.p2p_bandwidth	P2P bandwidth	ingress, egress	bytes/s
geth.reorgs	Executed Reorgs	executed	reorgs
geth.reorgs_blocks	Blocks Added/Removed from Reorg	added, dropped	blocks
geth.p2p_peers	Number of Peers	peers	peers
geth.p2p_peers_calls	P2P Serves and Dials	dials, serves	calls/s
geth.rpc_calls	rpc calls	failed, successful	calls/s

Troubleshooting

Diagnostics

Debug Mode

Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.

To troubleshoot issues with the geth collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

• Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

  cd /usr/libexec/netdata/plugins.d/

• Switch to the netdata user.

  sudo -u netdata -s

• Run the go.d.plugin to debug the collector:

  ./go.d.plugin -d -m geth

  To debug a specific job:

  ./go.d.plugin -d -m geth -j jobName

Getting Logs

If you're encountering problems with the geth collector, follow these steps to retrieve logs and identify potential issues:

• Run the command specific to your system (systemd, non-systemd, or Docker container).
• Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.

System with systemd

Use the following command to view logs generated since the last Netdata service restart:

journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep geth

System without systemd

Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector's name:

grep geth /var/log/netdata/collector.log

Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.

Docker Container

If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:

docker logs netdata 2>&1 | grep geth