rename chart fields to avoid conflicts with backends; fixes #1962

[netdata.git] / charts.d / README.md

diff --git a/charts.d/README.md b/charts.d/README.md
index ddbe4e1b18476797685376516a6c13629ac396e0..37c9d22ec39b92134e8831a287f2f5e2f45d34f0 100644 (file)
--- a/charts.d/README.md
+++ b/charts.d/README.md
@@ -1,34 +1,112 @@
 The following charts.d plugins are supported:
 
+# mysql
+
+The plugin will monitor one or more mysql servers
+
+It will produce the following charts:
+
+1. **Bandwidth** in kbps
+ * in
+ * out
+
+2. **Queries** in queries/sec
+ * queries
+ * questions
+ * slow queries
+
+3. **Operations** in operations/sec
+ * opened tables
+ * flush
+ * commit
+ * delete
+ * prepare
+ * read first
+ * read key
+ * read next
+ * read prev
+ * read random
+ * read random next
+ * rollback
+ * save point
+ * update
+ * write
+
+4. **Table Locks** in locks/sec
+ * immediate
+ * waited
+
+5. **Select Issues** in issues/sec
+ * full join
+ * full range join
+ * range
+ * range check
+ * scan
+
+6. **Sort Issues** in issues/sec
+ * merge passes
+ * range
+ * scan
+
+### configuration
+
+You can configure many database servers, like this:
+
+You can provide, per server, the following:
+
+1. a name, anything you like, but keep it short
+2. the mysql command to connect to the server
+3. the mysql command line options to be used for connecting to the server
+
+Here is an example for 2 servers:
+
+```sh
+mysql_opts[server1]="-h server1.example.com"
+mysql_opts[server2]="-h server2.example.com --connect_timeout 2"
+```
+
+The above will use the `mysql` command found in the system path.
+You can also provide a custom mysql command per server, like this:
+
+```sh
+mysql_cmds[server2]="/opt/mysql/bin/mysql"
+```
+
+The above sets the mysql command only for server2. server1 will use the system default.
+
+If no configuration is given, the plugin will attempt to connect to mysql server at localhost.
+
+---
+
 # squid
 
 The plugin will monitor a squid server.
 
 It will produce 4 charts:
 
-1. Squid Client Bandwidth in kbps
+1. **Squid Client Bandwidth** in kbps
 
  * in
  * out
  * hits
 
-2. Squid Client Requests in requests/sec
+2. **Squid Client Requests** in requests/sec
 
  * requests
  * hits
  * errors
 
-3. Squid Server Bandwidth
+3. **Squid Server Bandwidth** in kbps
 
  * in
  * out
 
-4. Squid Server Requests
+4. **Squid Server Requests** in requests/sec
 
  * requests
  * errors
 
-## autoconfig
+### autoconfig
 
 The plugin will by itself detect squid servers running on
 localhost, on ports 3128 or 8080.
@@ -40,7 +118,7 @@ It will attempt to download URLs in the form:
 
 If any succeeds, it will use this.
 
-## configuration
+### configuration
 
 If you need to configure it by hand, create the file
 `/etc/netdata/squid.conf` with the following variables:
@@ -74,17 +152,17 @@ The plugin will provide charts for all configured system sensors
 
 The plugin will create netdata charts for:
 
-1. temperature
-2. voltage
-3. current
-4. power
-5. fans speed
-6. energy
-7. humidity
+1. **Temperature**
+2. **Voltage**
+3. **Current**
+4. **Power**
+5. **Fans Speed**
+6. **Energy**
+7. **Humidity**
 
 One chart for every sensor chip found and each of the above will be created.
 
-## configuration
+### configuration
 
 This is the internal default for `/etc/netdata/sensors.conf`
 
@@ -103,6 +181,36 @@ sensors_source_update=1
 # how frequently to collect sensor data
 # the default is to collect it at every iteration of charts.d
 sensors_update_every=
+
+# array of sensors which are excluded
+# the default is to include all
+sensors_excluded=()
+```
+
+---
+
+# hddtemp
+
+The plugin will collect temperatures from disks 
+
+It will create one chart with all active disks
+
+1. **temperature in Celsius**
+
+### configuration
+
+hddtemp needs to be running in daemonized mode
+
+```sh
+# host with daemonized hddtemp
+hddtemp_host="localhost"
+
+# port on which hddtemp is showing data
+hddtemp_port="7634"
+
+# array of included disks
+# the default is to include all
+hddtemp_disks=()
 ```
 
 ---
@@ -113,10 +221,10 @@ The plugin will collect the postfix queue size.
 
 It will create two charts:
 
-1. queue size in emails
-2. queue size in KB
+1. **queue size in emails**
+2. **queue size in KB**
 
-## configuration
+### configuration
 
 This is the internal default for `/etc/netdata/postfix.conf`
 
@@ -137,46 +245,46 @@ The plugin will collect UPS data for all UPSes configured in the system.
 
 The following charts will be created:
 
-1. UPS Charge
+1. **UPS Charge**
 
  * percentage changed
 
-2. UPS Battery Voltage
+2. **UPS Battery Voltage**
 
  * current voltage
  * high voltage
  * low voltage
  * nominal voltage
 
-3. UPS Input Voltage
+3. **UPS Input Voltage**
 
  * current voltage
  * fault voltage
  * nominal voltage
 
-4. UPS Input Current
+4. **UPS Input Current**
 
  * nominal current
 
-5. UPS Input Frequency
+5. **UPS Input Frequency**
 
  * current frequency
  * nominal frequency
 
-6. UPS Output Voltage
+6. **UPS Output Voltage**
 
  * current voltage
 
-7. UPS Load
+7. **UPS Load**
 
  * current load
 
-8. UPS Temperature
+8. **UPS Temperature**
 
  * current temperature
 
 
-## configuration
+### configuration
 
 This is the internal default for `/etc/netdata/nut.conf`