Project: Netdata (Observability and Analysis / Observability)
File: go-ethereum.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/geth/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/geth/metadata.yaml" sidebar_label: "Go-ethereum" learn_status: "Published" learnrelpath: "Collecting Metrics/Blockchain Servers" most_popular: True message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/geth.png" width="150"/> Plugin: go.d.plugin Module: geth <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> 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. By default, it detects Go-ethereum instances running on localhost. The default configuration for this integration does not impose any limits on data collection. The default configuration for this integration is not expected to impose a significant performance impact on the system. Metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. These metrics refer to the entire monitored application. This scope has no labels. Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | geth.ethdbchaindataancientio_rate | reads, writes | bytes/s | | geth.ethdbchaindataancientio | reads, writes | bytes | | geth.ethdbchaindatadiskio | reads, writes | bytes | | geth.goroutines | goroutines | goroutines | | geth.ethdbchaindatadiskio_rate | reads, writes | bytes/s | | geth.chaindatadbsize | leveldb, ancientdb | bytes | | geth.chainhead | block, receipt, header | block | | geth.txpoolpending | invalid, pending, local, discard, no_funds, ratelimit, replace | transactions | | geth.txpoolcurrent | invalid, pending, local, pool | transactions | | geth.txpoolqueued | discard, eviction, no_funds, ratelimit | transactions | | geth.p2p_bandwidth | ingress, egress | bytes/s | | geth.reorgs | executed | reorgs | | geth.reorgs_blocks | added, dropped | blocks | | geth.p2p_peers | peers | peers | | geth.p2ppeerscalls | dials, serves | calls/s | | geth.rpc_calls | failed, successful | calls/s | There are no alerts configured by default for this integration. No action required. The configuration file name for this integration is `go.d/geth.conf`. You can edit the configuration file using the `edit-config` script from the Netdata . ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata sudo ./edit-config go.d/geth.conf ``` The following options can be defined globally: updateevery,

<details><summary>Config options</summary> | Name | 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 | | notfollowredirects | Redirect handling policy. Controls whether the client follows redirects. | no | no | | tlsskipverify | 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 | </details> A basic example configuration. ```yaml jobs: name: local url: http://127.0.0.1:6060/debug/metrics/prometheus ``` Basic HTTP authentication. <details><summary>Config</summary> ```yaml jobs: name: local url: http://127.0.0.1:6060/debug/metrics/prometheus username: username password: password ``` </details> Note: When you define multiple jobs, their names must be unique. Collecting metrics from local and remote instances. <details><summary>Config</summary> ```yaml 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 ``` </details> 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]`. ```bash cd /usr/libexec/netdata/plugins.d/ ``` Switch to the `netdata` user. ```bash sudo -u netdata -s ``` Run the `go.d.plugin` to debug the collector: ```bash ./go.d.plugin -d -m geth ```