github.com/netdata/go.d.plugin@v0.58.1/modules/geth/metadata.yaml (about) 1 plugin_name: go.d.plugin 2 modules: 3 - meta: 4 id: collector-go.d.plugin-geth 5 plugin_name: go.d.plugin 6 module_name: geth 7 monitored_instance: 8 name: Go-ethereum 9 link: https://github.com/ethereum/go-ethereum 10 icon_filename: geth.png 11 categories: 12 - data-collection.blockchain-servers 13 keywords: 14 - geth 15 - ethereum 16 - blockchain 17 related_resources: 18 integrations: 19 list: 20 - plugin_name: apps.plugin 21 module_name: apps 22 info_provided_to_referring_integrations: 23 description: "" 24 most_popular: true 25 overview: 26 data_collection: 27 metrics_description: | 28 This collector monitors Go-ethereum instances. 29 method_description: "" 30 supported_platforms: 31 include: [] 32 exclude: [] 33 multi_instance: true 34 additional_permissions: 35 description: "" 36 default_behavior: 37 auto_detection: 38 description: | 39 By default, it detects Go-ethereum instances running on localhost. 40 limits: 41 description: "" 42 performance_impact: 43 description: "" 44 setup: 45 prerequisites: 46 list: [] 47 configuration: 48 file: 49 name: go.d/geth.conf 50 options: 51 description: | 52 The following options can be defined globally: update_every, autodetection_retry. 53 folding: 54 title: Config options 55 enabled: true 56 list: 57 - name: update_every 58 description: Data collection frequency. 59 default_value: 1 60 required: false 61 - name: autodetection_retry 62 description: Recheck interval in seconds. Zero means no recheck will be scheduled. 63 default_value: 0 64 required: false 65 - name: url 66 description: Server URL. 67 default_value: http://127.0.0.1:6060/debug/metrics/prometheus 68 required: true 69 - name: timeout 70 description: HTTP request timeout. 71 default_value: 1 72 required: false 73 - name: username 74 description: Username for basic HTTP authentication. 75 default_value: "" 76 required: false 77 - name: password 78 description: Password for basic HTTP authentication. 79 default_value: "" 80 required: false 81 - name: proxy_url 82 description: Proxy URL. 83 default_value: "" 84 required: false 85 - name: proxy_username 86 description: Username for proxy basic HTTP authentication. 87 default_value: "" 88 required: false 89 - name: proxy_password 90 description: Password for proxy basic HTTP authentication. 91 default_value: "" 92 required: false 93 - name: method 94 description: HTTP request method. 95 default_value: GET 96 required: false 97 - name: body 98 description: HTTP request body. 99 default_value: "" 100 required: false 101 - name: headers 102 description: HTTP request headers. 103 default_value: "" 104 required: false 105 - name: not_follow_redirects 106 description: Redirect handling policy. Controls whether the client follows redirects. 107 default_value: no 108 required: false 109 - name: tls_skip_verify 110 description: Server certificate chain and hostname validation policy. Controls whether the client performs this check. 111 default_value: no 112 required: false 113 - name: tls_ca 114 description: Certification authority that the client uses when verifying the server's certificates. 115 default_value: "" 116 required: false 117 - name: tls_cert 118 description: Client TLS certificate. 119 default_value: "" 120 required: false 121 - name: tls_key 122 description: Client TLS key. 123 default_value: "" 124 required: false 125 examples: 126 folding: 127 title: Config 128 enabled: true 129 list: 130 - name: Basic 131 folding: 132 enabled: false 133 description: A basic example configuration. 134 config: | 135 jobs: 136 - name: local 137 url: http://127.0.0.1:6060/debug/metrics/prometheus 138 - name: HTTP authentication 139 description: Basic HTTP authentication. 140 config: | 141 jobs: 142 - name: local 143 url: http://127.0.0.1:6060/debug/metrics/prometheus 144 username: username 145 password: password 146 - name: Multi-instance 147 description: | 148 > **Note**: When you define multiple jobs, their names must be unique. 149 150 Collecting metrics from local and remote instances. 151 config: | 152 jobs: 153 - name: local 154 url: http://127.0.0.1:6060/debug/metrics/prometheus 155 156 - name: remote 157 url: http://192.0.2.1:6060/debug/metrics/prometheus 158 troubleshooting: 159 problems: 160 list: [] 161 alerts: [] 162 metrics: 163 folding: 164 title: Metrics 165 enabled: false 166 description: "" 167 availability: [] 168 scopes: 169 - name: global 170 description: These metrics refer to the entire monitored application. 171 labels: [] 172 metrics: 173 - name: geth.eth_db_chaindata_ancient_io_rate 174 description: Ancient Chaindata rate 175 unit: bytes/s 176 chart_type: line 177 dimensions: 178 - name: reads 179 - name: writes 180 - name: geth.eth_db_chaindata_ancient_io 181 description: Session ancient Chaindata 182 unit: bytes 183 chart_type: line 184 dimensions: 185 - name: reads 186 - name: writes 187 - name: geth.eth_db_chaindata_disk_io 188 description: Session chaindata on disk 189 unit: bytes 190 chart_type: line 191 dimensions: 192 - name: reads 193 - name: writes 194 - name: geth.goroutines 195 description: Number of goroutines 196 unit: goroutines 197 chart_type: line 198 dimensions: 199 - name: goroutines 200 - name: geth.eth_db_chaindata_disk_io_rate 201 description: On disk Chaindata rate 202 unit: bytes/s 203 chart_type: line 204 dimensions: 205 - name: reads 206 - name: writes 207 - name: geth.chaindata_db_size 208 description: Chaindata Size 209 unit: bytes 210 chart_type: line 211 dimensions: 212 - name: level_db 213 - name: ancient_db 214 - name: geth.chainhead 215 description: Chainhead 216 unit: block 217 chart_type: line 218 dimensions: 219 - name: block 220 - name: receipt 221 - name: header 222 - name: geth.tx_pool_pending 223 description: Pending Transaction Pool 224 unit: transactions 225 chart_type: line 226 dimensions: 227 - name: invalid 228 - name: pending 229 - name: local 230 - name: discard 231 - name: no_funds 232 - name: ratelimit 233 - name: replace 234 - name: geth.tx_pool_current 235 description: Transaction Pool 236 unit: transactions 237 chart_type: line 238 dimensions: 239 - name: invalid 240 - name: pending 241 - name: local 242 - name: pool 243 - name: geth.tx_pool_queued 244 description: Queued Transaction Pool 245 unit: transactions 246 chart_type: line 247 dimensions: 248 - name: discard 249 - name: eviction 250 - name: no_funds 251 - name: ratelimit 252 - name: geth.p2p_bandwidth 253 description: P2P bandwidth 254 unit: bytes/s 255 chart_type: line 256 dimensions: 257 - name: ingress 258 - name: egress 259 - name: geth.reorgs 260 description: Executed Reorgs 261 unit: reorgs 262 chart_type: line 263 dimensions: 264 - name: executed 265 - name: geth.reorgs_blocks 266 description: Blocks Added/Removed from Reorg 267 unit: blocks 268 chart_type: line 269 dimensions: 270 - name: added 271 - name: dropped 272 - name: geth.p2p_peers 273 description: Number of Peers 274 unit: peers 275 chart_type: line 276 dimensions: 277 - name: peers 278 - name: geth.p2p_peers_calls 279 description: P2P Serves and Dials 280 unit: calls/s 281 chart_type: line 282 dimensions: 283 - name: dials 284 - name: serves 285 - name: geth.rpc_calls 286 description: rpc calls 287 unit: calls/s 288 chart_type: line 289 dimensions: 290 - name: failed 291 - name: successful