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