github.com/netdata/go.d.plugin@v0.58.1/modules/energid/integrations/energi_core_wallet.md (about) 1 <!--startmeta 2 custom_edit_url: "https://github.com/netdata/go.d.plugin/edit/master/modules/energid/README.md" 3 meta_yaml: "https://github.com/netdata/go.d.plugin/edit/master/modules/energid/metadata.yaml" 4 sidebar_label: "Energi Core Wallet" 5 learn_status: "Published" 6 learn_rel_path: "Data Collection/Blockchain Servers" 7 most_popular: True 8 message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" 9 endmeta--> 10 11 # Energi Core Wallet 12 13 14 <img src="https://netdata.cloud/img/energi.png" width="150"/> 15 16 17 Plugin: go.d.plugin 18 Module: apache 19 20 <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> 21 22 ## Overview 23 24 This module monitors Energi Core Wallet instances. 25 Works only with [Generation 2 wallets](https://docs.energi.software/en/downloads/gen2-core-wallet). 26 27 28 29 30 This collector is supported on all platforms. 31 32 This collector supports collecting metrics from multiple instances of this integration, including remote instances. 33 34 35 ### Default Behavior 36 37 #### Auto-Detection 38 39 This integration doesn't support auto-detection. 40 41 #### Limits 42 43 The default configuration for this integration does not impose any limits on data collection. 44 45 #### Performance Impact 46 47 The default configuration for this integration is not expected to impose a significant performance impact on the system. 48 49 50 ## Metrics 51 52 Metrics grouped by *scope*. 53 54 The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. 55 56 57 58 ### Per Energi Core Wallet instance 59 60 These metrics refer to the entire monitored application. 61 62 This scope has no labels. 63 64 Metrics: 65 66 | Metric | Dimensions | Unit | 67 |:------|:----------|:----| 68 | energid.blockindex | blocks, headers | count | 69 | energid.difficulty | difficulty | difficulty | 70 | energid.mempool | max, usage, tx_size | bytes | 71 | energid.secmem | total, used, free, locked | bytes | 72 | energid.network | connections | connections | 73 | energid.timeoffset | timeoffset | seconds | 74 | energid.utxo_transactions | transactions, output_transactions | transactions | 75 76 77 78 ## Alerts 79 80 There are no alerts configured by default for this integration. 81 82 83 ## Setup 84 85 ### Prerequisites 86 87 No action required. 88 89 ### Configuration 90 91 #### File 92 93 The configuration file name for this integration is `go.d/energid.conf`. 94 95 96 You can edit the configuration file using the `edit-config` script from the 97 Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory). 98 99 ```bash 100 cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata 101 sudo ./edit-config go.d/energid.conf 102 ``` 103 #### Options 104 105 The following options can be defined globally: update_every, autodetection_retry. 106 107 108 <details><summary>Config options</summary> 109 110 | Name | Description | Default | Required | 111 |:----|:-----------|:-------|:--------:| 112 | update_every | Data collection frequency. | 1 | no | 113 | autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no | 114 | url | Server URL. | http://127.0.0.1:9796 | yes | 115 | timeout | HTTP request timeout. | 1 | no | 116 | username | Username for basic HTTP authentication. | | no | 117 | password | Password for basic HTTP authentication. | | no | 118 | proxy_url | Proxy URL. | | no | 119 | proxy_username | Username for proxy basic HTTP authentication. | | no | 120 | proxy_password | Password for proxy basic HTTP authentication. | | no | 121 | method | HTTP request method. | GET | no | 122 | body | HTTP request body. | | no | 123 | headers | HTTP request headers. | | no | 124 | not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no | 125 | tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no | 126 | tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no | 127 | tls_cert | Client TLS certificate. | | no | 128 | tls_key | Client TLS key. | | no | 129 130 </details> 131 132 #### Examples 133 134 ##### Basic 135 136 A basic example configuration. 137 138 ```yaml 139 jobs: 140 - name: local 141 url: http://127.0.0.1:9796 142 143 ``` 144 ##### HTTP authentication 145 146 Basic HTTP authentication. 147 148 <details><summary>Config</summary> 149 150 ```yaml 151 jobs: 152 - name: local 153 url: http://127.0.0.1:9796 154 username: username 155 password: password 156 157 ``` 158 </details> 159 160 ##### HTTPS with self-signed certificate 161 162 Do not validate server certificate chain and hostname. 163 164 165 <details><summary>Config</summary> 166 167 ```yaml 168 jobs: 169 - name: local 170 url: https://127.0.0.1:9796 171 tls_skip_verify: yes 172 173 ``` 174 </details> 175 176 ##### Multi-instance 177 178 > **Note**: When you define multiple jobs, their names must be unique. 179 180 Collecting metrics from local and remote instances. 181 182 183 <details><summary>Config</summary> 184 185 ```yaml 186 jobs: 187 - name: local 188 url: http://127.0.0.1:9796 189 190 - name: remote 191 url: http://192.0.2.1:9796 192 193 ``` 194 </details> 195 196 197 198 ## Troubleshooting 199 200 ### Debug Mode 201 202 To troubleshoot issues with the `apache` collector, run the `go.d.plugin` with the debug option enabled. The output 203 should give you clues as to why the collector isn't working. 204 205 - Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on 206 your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`. 207 208 ```bash 209 cd /usr/libexec/netdata/plugins.d/ 210 ``` 211 212 - Switch to the `netdata` user. 213 214 ```bash 215 sudo -u netdata -s 216 ``` 217 218 - Run the `go.d.plugin` to debug the collector: 219 220 ```bash 221 ./go.d.plugin -d -m apache 222 ``` 223 224