charts.d/README.md

   1 The following charts.d plugins are supported:
   2
   3 # mysql
   4
   5 The plugin will monitor one or more mysql servers
   6
   7 It will produce the following charts:
   8
   9 1. **Bandwidth** in kbps
  10  * in
  11  * out
  12
  13 2. **Queries** in queries/sec
  14  * queries
  15  * questions
  16  * slow queries
  17
  18 3. **Operations** in operations/sec
  19  * opened tables
  20  * flush
  21  * commit
  22  * delete
  23  * prepare
  24  * read first
  25  * read key
  26  * read next
  27  * read prev
  28  * read random
  29  * read random next
  30  * rollback
  31  * save point
  32  * update
  33  * write
  34
  35 4. **Table Locks** in locks/sec
  36  * immediate
  37  * waited
  38
  39 5. **Select Issues** in issues/sec
  40  * full join
  41  * full range join
  42  * range
  43  * range check
  44  * scan
  45
  46 6. **Sort Issues** in issues/sec
  47  * merge passes
  48  * range
  49  * scan
  50
  51 ### configuration
  52
  53 You can configure many database servers, like this:
  54
  55 You can provide, per server, the following:
  56
  57 1. a name, anything you like, but keep it short
  58 2. the mysql command to connect to the server
  59 3. the mysql command line options to be used for connecting to the server
  60
  61 Here is an example for 2 servers:
  62
  63 ```sh
  64 mysql_opts[server1]="-h server1.example.com"
  65 mysql_opts[server2]="-h server2.example.com --connect_timeout 2"
  66 ```
  67
  68 The above will use the `mysql` command found in the system path.
  69 You can also provide a custom mysql command per server, like this:
  70
  71 ```sh
  72 mysql_cmds[server2]="/opt/mysql/bin/mysql"
  73 ```
  74
  75 The above sets the mysql command only for server2. server1 will use the system default.
  76
  77 If no configuration is given, the plugin will attempt to connect to mysql server at localhost.
  78
  79 ---
  80
  81 # squid
  82
  83 The plugin will monitor a squid server.
  84
  85 It will produce 4 charts:
  86
  87 1. **Squid Client Bandwidth** in kbps
  88
  89  * in
  90  * out
  91  * hits
  92
  93 2. **Squid Client Requests** in requests/sec
  94
  95  * requests
  96  * hits
  97  * errors
  98
  99 3. **Squid Server Bandwidth** in kbps
 100
 101  * in
 102  * out
 103
 104 4. **Squid Server Requests** in requests/sec
 105
 106  * requests
 107  * errors
 108
 109 ### autoconfig
 110
 111 The plugin will by itself detect squid servers running on
 112 localhost, on ports 3128 or 8080.
 113
 114 It will attempt to download URLs in the form:
 115
 116 - `cache_object://HOST:PORT/counters`
 117 - `/squid-internal-mgr/counters`
 118
 119 If any succeeds, it will use this.
 120
 121 ### configuration
 122
 123 If you need to configure it by hand, create the file
 124 `/etc/netdata/squid.conf` with the following variables:
 125
 126 - `squid_host=IP` the IP of the squid host
 127 - `squid_port=PORT` the port the squid is listening
 128 - `squid_url="URL"` the URL with the statistics to be fetched from squid
 129 - `squid_timeout=SECONDS` how much time we should wait for squid to respond
 130 - `squid_update_every=SECONDS` the frequency of the data collection
 131
 132 Example `/etc/netdata/squid.conf`:
 133
 134 ```sh
 135 squid_host=127.0.0.1
 136 squid_port=3128
 137 squid_url="cache_object://127.0.0.1:3128/counters"
 138 squid_timeout=2
 139 squid_update_every=5
 140 ```
 141
 142 ---
 143
 144 # sensors
 145
 146 The plugin will provide charts for all configured system sensors
 147
 148 > This plugin is reading sensors directly from the kernel.
 149 > The `lm-sensors` package is able to perform calculations on the
 150 > kernel provided values, this plugin will not perform.
 151 > So, the values graphed, are the raw hardware values of the sensors.
 152
 153 The plugin will create netdata charts for:
 154
 155 1. **Temperature**
 156 2. **Voltage**
 157 3. **Current**
 158 4. **Power**
 159 5. **Fans Speed**
 160 6. **Energy**
 161 7. **Humidity**
 162
 163 One chart for every sensor chip found and each of the above will be created.
 164
 165 ### configuration
 166
 167 This is the internal default for `/etc/netdata/sensors.conf`
 168
 169 ```sh
 170 # the directory the kernel keeps sensor data
 171 sensors_sys_dir="${NETDATA_HOST_PREFIX}/sys/devices"
 172
 173 # how deep in the tree to check for sensor data
 174 sensors_sys_depth=10
 175
 176 # if set to 1, the script will overwrite internal
 177 # script functions with code generated ones
 178 # leave to 1, is faster
 179 sensors_source_update=1
 180
 181 # how frequently to collect sensor data
 182 # the default is to collect it at every iteration of charts.d
 183 sensors_update_every=
 184
 185 # array of sensors which are excluded
 186 # the default is to include all
 187 sensors_excluded=()
 188 ```
 189
 190 ---
 191
 192 # hddtemp
 193
 194 The plugin will collect temperatures from disks
 195
 196 It will create one chart with all active disks
 197
 198 1. **temperature in Celsius**
 199
 200 ### configuration
 201
 202 hddtemp needs to be running in daemonized mode
 203
 204 ```sh
 205 # host with daemonized hddtemp
 206 hddtemp_host="localhost"
 207
 208 # port on which hddtemp is showing data
 209 hddtemp_port="7634"
 210
 211 # array of included disks
 212 # the default is to include all
 213 hddtemp_disks=()
 214 ```
 215
 216 ---
 217
 218 # postfix
 219
 220 The plugin will collect the postfix queue size.
 221
 222 It will create two charts:
 223
 224 1. **queue size in emails**
 225 2. **queue size in KB**
 226
 227 ### configuration
 228
 229 This is the internal default for `/etc/netdata/postfix.conf`
 230
 231 ```sh
 232 # the postqueue command
 233 # if empty, it will use the one found in the system path
 234 postfix_postqueue=
 235
 236 # how frequently to collect queue size
 237 postfix_update_every=15
 238 ```
 239
 240 ---
 241
 242 # nut
 243
 244 The plugin will collect UPS data for all UPSes configured in the system.
 245
 246 The following charts will be created:
 247
 248 1. **UPS Charge**
 249
 250  * percentage changed
 251
 252 2. **UPS Battery Voltage**
 253
 254  * current voltage
 255  * high voltage
 256  * low voltage
 257  * nominal voltage
 258
 259 3. **UPS Input Voltage**
 260
 261  * current voltage
 262  * fault voltage
 263  * nominal voltage
 264
 265 4. **UPS Input Current**
 266
 267  * nominal current
 268
 269 5. **UPS Input Frequency**
 270
 271  * current frequency
 272  * nominal frequency
 273
 274 6. **UPS Output Voltage**
 275
 276  * current voltage
 277
 278 7. **UPS Load**
 279
 280  * current load
 281
 282 8. **UPS Temperature**
 283
 284  * current temperature
 285
 286
 287 ### configuration
 288
 289 This is the internal default for `/etc/netdata/nut.conf`
 290
 291 ```sh
 292 # a space separated list of UPS names
 293 # if empty, the list returned by 'upsc -l' will be used
 294 nut_ups=
 295
 296 # how frequently to collect UPS data
 297 nut_update_every=2
 298 ```
 299
 300 ---
 301