Merging upstream version 1.17.0.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 54 insertions, 53 deletions

diff --git a/database/README.md b/database/README.md
index de0aa9b5..2fcb69b6 100644
--- a/database/README.md
+++ b/database/README.md
@@ -3,7 +3,7 @@
 Although `netdata` does all its calculations using `long double`, it stores all values using
 a [custom-made 32-bit number](../libnetdata/storage_number/).
 
-So, for each dimension of a chart, netdata will need: `4 bytes for the value * the entries
+So, for each dimension of a chart, Netdata will need: `4 bytes for the value * the entries
 of its history`. It will not store any other data for each value in the time series database.
 Since all its values are stored in a time series with fixed step, the time each value
 corresponds can be calculated at run time, using the position of a value in the round robin database.
@@ -23,33 +23,35 @@ use the **[Database Engine](engine/)**.
 
 ## Memory modes
 
-Currently netdata supports 6 memory modes:
+Currently Netdata supports 6 memory modes:
 
-1. `ram`, data are purely in memory. Data are never saved on disk. This mode uses `mmap()` and
-   supports [KSM](#ksm).
+1.  `ram`, data are purely in memory. Data are never saved on disk. This mode uses `mmap()` and
+    supports [KSM](#ksm).
 
-2. `save`, (the default) data are only in RAM while netdata runs and are saved to / loaded from
-   disk on netdata restart. It also uses `mmap()` and supports [KSM](#ksm).
+2.  `save`, (the default) data are only in RAM while Netdata runs and are saved to / loaded from
+    disk on Netdata restart. It also uses `mmap()` and supports [KSM](#ksm).
 
-3. `map`, data are in memory mapped files. This works like the swap. Keep in mind though, this
-   will have a constant write on your disk. When netdata writes data on its memory, the Linux kernel
-   marks the related memory pages as dirty and automatically starts updating them on disk.
-   Unfortunately we cannot control how frequently this works. The Linux kernel uses exactly the
-   same algorithm it uses for its swap memory. Check below for additional information on running a
-   dedicated central netdata server. This mode uses `mmap()` but does not support [KSM](#ksm).
+3.  `map`, data are in memory mapped files. This works like the swap. Keep in mind though, this
+    will have a constant write on your disk. When Netdata writes data on its memory, the Linux kernel
+    marks the related memory pages as dirty and automatically starts updating them on disk.
+    Unfortunately we cannot control how frequently this works. The Linux kernel uses exactly the
+    same algorithm it uses for its swap memory. Check below for additional information on running a
+    dedicated central Netdata server. This mode uses `mmap()` but does not support [KSM](#ksm).
 
-4. `none`, without a database (collected metrics can only be streamed to another netdata).
+4.  `none`, without a database (collected metrics can only be streamed to another Netdata).
 
-5. `alloc`, like `ram` but it uses `calloc()` and does not support [KSM](#ksm). This mode is the
-   fallback for all others except `none`.
+5.  `alloc`, like `ram` but it uses `calloc()` and does not support [KSM](#ksm). This mode is the
+    fallback for all others except `none`.
 
-6. `dbengine`, data are in database files. The [Database Engine](engine/) works like a traditional
-   database. There is some amount of RAM dedicated to data caching and indexing and the rest of
-   the data reside compressed on disk. The number of history entries is not fixed in this case,
-   but depends on the configured disk space and the effective compression ratio of the data stored.
-   For more details see [here](engine/).
+6.  `dbengine`, data are in database files. The [Database Engine](engine/) works like a traditional
+    database. There is some amount of RAM dedicated to data caching and indexing and the rest of
+    the data reside compressed on disk. The number of history entries is not fixed in this case,
+    but depends on the configured disk space and the effective compression ratio of the data stored.
+    This is the **only mode** that supports changing the data collection update frequency
+    (`update_every`) **without losing** the previously stored metrics.
+    For more details see [here](engine/).
 
-You can select the memory mode by editing netdata.conf and setting:
+You can select the memory mode by editing `netdata.conf` and setting:
 
 ```
 [global]
@@ -60,63 +62,62 @@ You can select the memory mode by editing netdata.conf and setting:
     cache directory = /var/cache/netdata
 ```
 
-## Running netdata in embedded devices
+## Running Netdata in embedded devices
 
 Embedded devices usually have very limited RAM resources available.
 
 There are 2 settings for you to tweak:
 
-1. `update every`, which controls the data collection frequency
-2. `history`, which controls the size of the database in RAM
+1.  `update every`, which controls the data collection frequency
+2.  `history`, which controls the size of the database in RAM
 
 By default `update every = 1` and `history = 3600`. This gives you an hour of data with per
 second updates.
 
 If you set `update every = 2` and `history = 1800`, you will still have an hour of data, but
 collected once every 2 seconds. This will **cut in half** both CPU and RAM resources consumed
-by netdata. Of course experiment a bit. On very weak devices you might have to use
+by Netdata. Of course experiment a bit. On very weak devices you might have to use
 `update every = 5` and `history = 720` (still 1 hour of data, but 1/5 of the CPU and RAM resources).
 
 You can also disable [data collection plugins](../collectors) you don't need.
 Disabling such plugins will also free both CPU and RAM resources.
 
-## Running a dedicated central netdata server
+## Running a dedicated central Netdata server
 
-Netdata allows streaming data between netdata nodes. This allows us to have a central netdata
+Netdata allows streaming data between Netdata nodes. This allows us to have a central Netdata
 server that will maintain the entire database for all nodes, and will also run health checks/alarms
 for all nodes.
 
-For this central netdata, memory size can be a problem. Fortunately, netdata supports several
+For this central Netdata, memory size can be a problem. Fortunately, Netdata supports several
 memory modes. **One interesting option** for this setup is `memory mode = map`.
 
 ### map
 
-In this mode, the database of netdata is stored in memory mapped files. netdata continues to read
+In this mode, the database of Netdata is stored in memory mapped files. Netdata continues to read
 and write the database in memory, but the kernel automatically loads and saves memory pages from/to
 disk.
 
 **We suggest _not_ to use this mode on nodes that run other applications.** There will always be
 dirty memory to be synced and this syncing process may influence the way other applications work.
-This mode however is useful when we need a central netdata server that would normally need huge
+This mode however is useful when we need a central Netdata server that would normally need huge
 amounts of memory. Using memory mode `map` we can overcome all memory restrictions.
 
 There are a few kernel options that provide finer control on the way this syncing works. But before
-explaining them, a brief introduction of how netdata database works is needed.
+explaining them, a brief introduction of how Netdata database works is needed.
 
-For each chart, netdata maps the following files:
+For each chart, Netdata maps the following files:
 
-1. `chart/main.db`, this is the file that maintains chart information. Every time data are collected
-   for a chart, this is updated.
-   
-2. `chart/dimension_name.db`, this is the file for each dimension. At its beginning there is a
-   header, followed by the round robin database where metrics are stored.
+1.  `chart/main.db`, this is the file that maintains chart information. Every time data are collected
+    for a chart, this is updated.
+2.  `chart/dimension_name.db`, this is the file for each dimension. At its beginning there is a
+    header, followed by the round robin database where metrics are stored.
 
-So, every time netdata collects data, the following pages will become dirty:
+So, every time Netdata collects data, the following pages will become dirty:
 
-1. the chart file
-2. the header part of all dimension files
-3. if the collected metrics are stored far enough in the dimension file, another page will
-   become dirty, for each dimension
+1.  the chart file
+2.  the header part of all dimension files
+3.  if the collected metrics are stored far enough in the dimension file, another page will
+    become dirty, for each dimension
 
 Each page in Linux is 4KB. So, with 200 charts and 1000 dimensions, there will be 1200 to 2200 4KB
 pages dirty pages every second. Of course 1200 of them will always be dirty (the chart header and
@@ -143,12 +144,12 @@ get an abnormal shutdown.
 
 There are 2 more options to tweak:
 
-1. `dirty_background_ratio`, by default `10`.
-2. `dirty_ratio`, by default `20`.
+1.  `dirty_background_ratio`, by default `10`.
+2.  `dirty_ratio`, by default `20`.
 
 These control the amount of memory that should be dirty for disk syncing to be triggered.
-On dedicated netdata servers, you can use: `80` and `90` respectively, so that all RAM is given
-to netdata.
+On dedicated Netdata servers, you can use: `80` and `90` respectively, so that all RAM is given
+to Netdata.
 
 With these settings, you can expect a little `iowait` spike once every 10 minutes and in case
 of system crash, data on disk will be up to 10 minutes old.
@@ -169,7 +170,7 @@ for this setup** is `memory mode = dbengine`.
 
 ### dbengine
 
-In this mode, the database of netdata is stored in database files. The [Database Engine](engine/)
+In this mode, the database of Netdata is stored in database files. The [Database Engine](engine/)
 works like a traditional database. There is some amount of RAM dedicated to data caching and
 indexing and the rest of the data reside compressed on disk. The number of history entries is not 
 fixed in this case, but depends on the configured disk space and the effective compression ratio
@@ -187,10 +188,10 @@ Netdata offers all its round robin database to kernel for deduplication
 
 In the past KSM has been criticized for consuming a lot of CPU resources.
 Although this is true when KSM is used for deduplicating certain applications, it is not true with
-netdata, since the netdata memory is written very infrequently (if you have 24 hours of metrics in
+netdata, since the Netdata memory is written very infrequently (if you have 24 hours of metrics in
 netdata, each byte at the in-memory database will be updated just once per day).
 
-KSM is a solution that will provide 60+% memory savings to netdata.
+KSM is a solution that will provide 60+% memory savings to Netdata.
 
 ### Enable KSM in kernel
 
@@ -206,9 +207,9 @@ So, if you build a kernel with `CONFIG_KSM=y` you will just get a few files in `
 
 The files that `CONFIG_KSM=y` offers include:
 
-- `/sys/kernel/mm/ksm/run` by default `0`. You have to set this to `1` for the kernel to spawn `ksmd`.
-- `/sys/kernel/mm/ksm/sleep_millisecs`, by default `20`. The frequency ksmd should evaluate memory for deduplication.
-- `/sys/kernel/mm/ksm/pages_to_scan`, by default `100`. The amount of pages ksmd will evaluate on each run.
+-   `/sys/kernel/mm/ksm/run` by default `0`. You have to set this to `1` for the kernel to spawn `ksmd`.
+-   `/sys/kernel/mm/ksm/sleep_millisecs`, by default `20`. The frequency ksmd should evaluate memory for deduplication.
+-   `/sys/kernel/mm/ksm/pages_to_scan`, by default `100`. The amount of pages ksmd will evaluate on each run.
 
 So, by default `ksmd` is just disabled. It will not harm performance and the user/admin can control the CPU resources he/she is willing `ksmd` to use.
 
@@ -231,4 +232,4 @@ Netdata will create charts for kernel memory de-duplication performance, like th
 
 ![image](https://cloud.githubusercontent.com/assets/2662304/11998786/eb23ae54-aab6-11e5-94d4-e848e8a5c56a.png)
 
-[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fdatabase%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
+[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fdatabase%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)