charts.d/README.md

   1 The following charts.d plugins are supported:
   2
   3 # squid
   4
   5 The plugin will monitor a squid server.
   6
   7 It will produce 4 charts:
   8
   9 1. Squid Client Bandwidth in kbps
  10
  11  * in
  12  * out
  13  * hits
  14
  15 2. Squid Client Requests in requests/sec
  16
  17  * requests
  18  * hits
  19  * errors
  20
  21 3. Squid Server Bandwidth
  22
  23  * in
  24  * out
  25
  26 4. Squid Server Requests
  27
  28  * requests
  29  * errors
  30
  31 ## autoconfig
  32
  33 The plugin will by itself detect squid servers running on
  34 localhost, on ports 3128 or 8080.
  35
  36 It will attempt to download URLs in the form:
  37
  38 - `cache_object://HOST:PORT/counters`
  39 - `/squid-internal-mgr/counters`
  40
  41 If any succeeds, it will use this.
  42
  43 ## configuration
  44
  45 If you need to configure it by hand, create the file
  46 `/etc/netdata/squid.conf` with the following variables:
  47
  48 - `squid_host=IP` the IP of the squid host
  49 - `squid_port=PORT` the port the squid is listening
  50 - `squid_url="URL"` the URL with the statistics to be fetched from squid
  51 - `squid_timeout=SECONDS` how much time we should wait for squid to respond
  52 - `squid_update_every=SECONDS` the frequency of the data collection
  53
  54 Example `/etc/netdata/squid.conf`:
  55
  56 ```sh
  57 squid_host=127.0.0.1
  58 squid_port=3128
  59 squid_url="cache_object://127.0.0.1:3128/counters"
  60 squid_timeout=2
  61 squid_update_every=5
  62 ```
  63
  64 ---
  65
  66 # sensors
  67
  68 The plugin will provide charts for all configured system sensors
  69
  70 > This plugin is reading sensors directly from the kernel.
  71 > The `lm-sensors` package is able to perform calculations on the
  72 > kernel provided values, this plugin will not perform.
  73 > So, the values graphed, are the raw hardware values of the sensors.
  74
  75 The plugin will create netdata charts for:
  76
  77 1. temperature
  78 2. voltage
  79 3. current
  80 4. power
  81 5. fans speed
  82 6. energy
  83 7. humidity
  84
  85 One chart for every sensor chip found and each of the above will be created.
  86
  87 ## configuration
  88
  89 This is the internal default for `/etc/netdata/sensors.conf`
  90
  91 ```sh
  92 # the directory the kernel keeps sensor data
  93 sensors_sys_dir="${NETDATA_HOST_PREFIX}/sys/devices"
  94
  95 # how deep in the tree to check for sensor data
  96 sensors_sys_depth=10
  97
  98 # if set to 1, the script will overwrite internal
  99 # script functions with code generated ones
 100 # leave to 1, is faster
 101 sensors_source_update=1
 102
 103 # how frequently to collect sensor data
 104 # the default is to collect it at every iteration of charts.d
 105 sensors_update_every=
 106 ```
 107
 108 ---
 109
 110 # postfix
 111
 112 The plugin will collect the postfix queue size.
 113
 114 It will create two charts:
 115
 116 1. queue size in emails
 117 2. queue size in KB
 118
 119 ## configuration
 120
 121 This is the internal default for `/etc/netdata/postfix.conf`
 122
 123 ```sh
 124 # the postqueue command
 125 # if empty, it will use the one found in the system path
 126 postfix_postqueue=
 127
 128 # how frequently to collect queue size
 129 postfix_update_every=15
 130 ```
 131
 132 ---
 133
 134 # nut
 135
 136 The plugin will collect UPS data for all UPSes configured in the system.
 137
 138 The following charts will be created:
 139
 140 1. UPS Charge
 141
 142  * percentage changed
 143
 144 2. UPS Battery Voltage
 145
 146  * current voltage
 147  * high voltage
 148  * low voltage
 149  * nominal voltage
 150
 151 3. UPS Input Voltage
 152
 153  * current voltage
 154  * fault voltage
 155  * nominal voltage
 156
 157 4. UPS Input Current
 158
 159  * nominal current
 160
 161 5. UPS Input Frequency
 162
 163  * current frequency
 164  * nominal frequency
 165
 166 6. UPS Output Voltage
 167
 168  * current voltage
 169
 170 7. UPS Load
 171
 172  * current load
 173
 174 8. UPS Temperature
 175
 176  * current temperature
 177
 178
 179 ## configuration
 180
 181 This is the internal default for `/etc/netdata/nut.conf`
 182
 183 ```sh
 184 # a space separated list of UPS names
 185 # if empty, the list returned by 'upsc -l' will be used
 186 nut_ups=
 187
 188 # how frequently to collect UPS data
 189 nut_update_every=2
 190 ```
 191
 192 ---
 193