Merging upstream version 1.11.1+dfsg

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

3 files changed, 69 insertions, 72 deletions

diff --git a/collectors/tc.plugin/README.md b/collectors/tc.plugin/README.md
index 6670c491f..a8b151de3 100644
--- a/collectors/tc.plugin/README.md
+++ b/collectors/tc.plugin/README.md
@@ -18,75 +18,69 @@ dynamically creates.
 
 ## Motivation
 
-One category of metrics missing in Linux monitoring, is bandwidth consumption for each open
-socket (inbound and outbound traffic). So, you cannot tell how much bandwidth your web server,
-your database server, your backup, your ssh sessions, etc are using.
+One category of metrics missing in Linux monitoring, is bandwidth consumption for each open socket (inbound and outbound traffic). So, you cannot tell how much bandwidth your web server, your database server, your backup, your ssh sessions, etc are using.
 
-To solve this problem, the most *adventurous* Linux monitoring tools install kernel modules to
-capture all traffic, analyze it and provide reports per application. A lot of work, CPU intensive
-and with a great degree of risk (due to the kernel modules involved which might affect the
-stability of the whole system). Not to mention that such solutions are probably better suited
-for a core linux router in your network.
+To solve this problem, the most *adventurous* Linux monitoring tools install kernel modules to capture all traffic, analyze it and provide reports per application. A lot of work, CPU intensive and with a great degree of risk (due to the kernel modules involved which might affect the stability of the whole system). Not to mention that such solutions are probably better suited for a core linux router in your network.
 
-Others use NFACCT, the netfilter accounting module which is already part of the Linux firewall.
-However, this would require configuring a firewall on every system you want to measure bandwidth.
+Others use NFACCT, the netfilter accounting module which is already part of the Linux firewall. However, this would require configuring a firewall on every system you want to measure bandwidth (just FYI, I do install a firewall on every server - and I strongly advise you to do so too - but configuring accounting on all servers seems overkill when you don't really need it for billing purposes).
 
-QoS monitoring attempts to solve this in a much cleaner way.
+**There is however a much simpler approach**.
 
-## Introduction to QoS
+## QoS
 
-One of the features the Linux kernel has, but it is rarely used, is its ability to
-**apply QoS on traffic**. Even most interesting is that it can apply QoS to **both inbound and
-outbound traffic**.
+One of the features the Linux kernel has, but it is rarely used, is its ability to **apply QoS on traffic**. Even most interesting is that it can apply QoS to **both inbound and outbound traffic**.
 
 QoS is about 2 features:
 
 1. **Classify traffic**
 
-   Classification is the process of organizing traffic in groups, called **classes**.
-   Classification can evaluate every aspect of network packets, like source and destination ports,
-   source and destination IPs, netfilter marks, etc.
+  Classification is the process of organizing traffic in groups, called **classes**. Classification can evaluate every aspect of network packets, like source and destination ports, source and destination IPs, netfilter marks, etc.
 
-   When you classify traffic, you just assign a label to it. For example **I call `web server`
-   traffic, the traffic from my server's tcp/80, tcp/443 and to my server's tcp/80, tcp/443,
-   while I call `web surfing` all other tcp/80 and tcp/443 traffic**. You can use any combinations
-   you like. There is no limit.
+  When you classify traffic, you just assign a label to it. Of course classes have some properties themselves (like queuing mechanisms), but let's say it is that simple: **a label**. For example **I call `web server` traffic, the traffic from my server's tcp/80, tcp/443 and to my server's tcp/80, tcp/443, while I call `web surfing` all other tcp/80 and tcp/443 traffic**. You can use any combinations you like. There is no limit.
 
 2. **Apply traffic shaping rules to these classes**
 
-   Traffic shaping is used to control how network interface bandwidth should be shared among the
-   classes. Of course we are not interested for this feature to just monitor the traffic.
-   Classification will be enough for monitoring everything.
+  Traffic shaping is used to control how network interface bandwidth should be shared among the classes. Normally, you need to do this, when there is not enough bandwidth to satisfy all the demand, or when you want to control the supply of bandwidth to certain services. Of course classification is sufficient for monitoring traffic, but traffic shaping is also quite important, as we will explain in the next section.
 
-The key reasons of applying QoS on all servers (even cloud ones) are:
+## Why you want QoS
 
-   - **ensure administrative tasks (like ssh, dns, etc) will always have a small but guaranteed
-      bandwidth.** QoS can guarantee that services like ssh, dns, ntp, etc will always have a small
-      supply of bandwidth. So, no matter what happens, you will be able to ssh to your server and
-      DNS will always work.
+1. **Monitoring the bandwidth used by services**
 
-   - **ensure other administrative tasks will not monopolize all the available bandwidth.**
-      Services like backups, file copies, database dumps, etc can easily monopolize all the
-      available bandwidth. It is common for example a nightly backup, or a huge file transfer
-      to negatively influence the end-user experience. QoS can fix that.
+   netdata provides wonderful real-time charts, like this one (wait to see the orange `rsync` part):
 
-   - **ensure each end-user connection will get a fair cut of the available bandwidth.**
-      Several QoS queuing disciplines in Linux do this automatically, without any configuration from you.
-      The result is that new sockets are favored over older ones, so that users will get a snappier
-      experience, while others are transferring large amounts of traffic.
-   
-   - **protect the servers from DDoS attacks.**
-      When your system is under a DDoS attack, it will get a lot more bandwidth compared to the one it
-      can handle and probably your applications will crash. Setting a limit on the inbound traffic using
-      QoS, will protect your servers (throttle the requests) and depending on the size of the attack may
-      allow your legitimate users to access the server, while the attack is taking place.
+   ![qos3](https://cloud.githubusercontent.com/assets/2662304/14474189/713ede84-0104-11e6-8c9c-8dca5c2abd63.gif)
 
+2. **Ensure sensitive administrative tasks will not starve for bandwidth**
 
-Once **traffic classification** is applied, netdata can visualize the bandwidth consumption per
-class in real-time (no configuration is needed for netdata - it will figure it out).
+   Have you tried to ssh to a server when the network is congested? If you have, you already know it does not work very well. QoS can guarantee that services like ssh, dns, ntp, etc will always have a small supply of bandwidth. So, no matter what happens, you will be able to ssh to your server and DNS will always work.
 
-QoS, is extremely light. You will configure it once, and this is it. It will not bother you again
-and it will not use any noticeable CPU resources, especially on application and database servers.
+3. **Ensure administrative tasks will not monopolize all the bandwidth**
+
+   Services like backups, file copies, database dumps, etc can easily monopolize all the available bandwidth. It is common for example a nightly backup, or a huge file transfer to negatively influence the end-user experience. QoS can fix that.
+
+4. **Ensure each end-user connection will get a fair cut of the available bandwidth.**
+
+   Several QoS queuing disciplines in Linux do this automatically, without any configuration from you. The result is that new sockets are favored over older ones, so that users will get a snappier experience, while others are transferring large amounts of traffic.
+
+5. **Protect the servers from DDoS attacks.**
+
+   When your system is under a DDoS attack, it will get a lot more bandwidth compared to the one it can handle and probably your applications will crash. Setting a limit on the inbound traffic using QoS, will protect your servers (throttle the requests) and depending on the size of the attack may allow your legitimate users to access the server, while the attack is taking place.
+
+   Using QoS together with a [SYNPROXY](../proc.plugin/README.md#linux-anti-ddos) will provide a great degree of protection against most DDoS attacks. Actually when I wrote that article, a few folks tried to DDoS the netdata demo site to see in real-time the SYNPROXY operation. They did not do it right, but anyway a great deal of requests reached the netdata server. What saved netdata was QoS. The netdata demo server has QoS installed, so the requests were throttled and the server did not even reach the point of resource starvation. Read about it [here](../proc.plugin/README.md#linux-anti-ddos).
+
+On top of all these, QoS is extremely light. You will configure it once, and this is it. It will not bother you again and it will not use any noticeable CPU resources, especially on application and database servers.
+
+	- ensure administrative tasks (like ssh, dns, etc) will always have a small but guaranteed bandwidth. So, no matter what happens, I will be able to ssh to my server and DNS will work.
+
+	- ensure other administrative tasks will not monopolize all the available bandwidth. So, my nightly backup will not hurt my users, a developer that is copying files over the net will not get all the available bandwidth, etc.
+
+	- ensure each end-user connection will get a fair cut of the available bandwidth.
+
+Once **traffic classification** is applied, we can use **[netdata](https://github.com/netdata/netdata)** to visualize the bandwidth consumption per class in real-time (no configuration is needed for netdata - it will figure it out).
+
+QoS, is extremely light. You will configure it once, and this is it. It will not bother you again and it will not use any noticeable CPU resources, especially on application and database servers.
+
+---
 
 ## QoS in Linux? Have you lost your mind?
 
@@ -94,28 +88,35 @@ Yes I know... but no, I have not!
 
 Of course, `tc` is probably **the most undocumented, complicated and unfriendly** command in Linux. 
 
-For example, for matching a simple port range in `tc`, e.g. all the high ports, from 1025 to 65535
-inclusive, you have to match these:
+For example, do you know that for matching a simple port range in `tc`, e.g. all the high ports, from 1025 to 65535 inclusive, you have to match these:
 
 ```
-1025/0xffff 1026/0xfffe 1028/0xfffc  1032/0xfff8  1040/0xfff0
-1056/0xffe0 1088/0xffc0 1152/0xff80  1280/0xff00  1536/0xfe00
-2048/0xf800 4096/0xf000 8192/0xe000 16384/0xc000 32768/0x8000
+1025/0xffff
+1026/0xfffe
+1028/0xfffc
+1032/0xfff8
+1040/0xfff0
+1056/0xffe0
+1088/0xffc0
+1152/0xff80
+1280/0xff00
+1536/0xfe00
+2048/0xf800
+4096/0xf000
+8192/0xe000
+16384/0xc000
+32768/0x8000
 ```
 
 I know what you are thinking right now! **And I agree!**
 
-This is why I wrote **[FireQOS](https://firehol.org/tutorial/fireqos-new-user/)**, a tool to
-simplify QoS management in Linux.
+This is why I wrote **[FireQOS](https://firehol.org/tutorial/fireqos-new-user/)**, a tool to simplify QoS management in Linux.
 
-The **[FireHOL](https://firehol.org/)** package already distributes **[FireQOS](https://firehol.org/tutorial/fireqos-new-user/)**.
-Check the **[FireQOS tutorial](https://firehol.org/tutorial/fireqos-new-user/)**
-to learn how to write your own QoS configuration.
+The **[FireHOL](https://firehol.org/)** package already distributes **[FireQOS](https://firehol.org/tutorial/fireqos-new-user/)**. Check the **[FireQOS tutorial](https://firehol.org/tutorial/fireqos-new-user/)** to learn how to write your own QoS configuration.
 
-With **[FireQOS](https://firehol.org/tutorial/fireqos-new-user/)**, it is **really simple for everyone
-to use QoS in Linux**. Just install the package `firehol`. It should already be available for your
-distribution. If not, check the **[FireHOL Installation Guide](https://firehol.org/installing/)**.
-After that, you will have the `fireqos` command.
+With **[FireQOS](https://firehol.org/tutorial/fireqos-new-user/)**, it is **really simple for everyone to use QoS in Linux**. Just install the package `firehol`. It should already be available for your distribution. If not, check the **[FireHOL Installation Guide](https://firehol.org/installing/)**. After that, you will have the `fireqos` command which uses a configuration like the following:
+
+## QoS Configuration
 
 This is the file `/etc/firehol/fireqos.conf` we use at the netdata demo site:
 
@@ -157,14 +158,9 @@ This is the file `/etc/firehol/fireqos.conf` we use at the netdata demo site:
           match input src 10.2.3.5
 ```
 
-Nothing more is needed. You just run `fireqos start` to apply this configuration, restart netdata
-and you have real-time visualization of the bandwidth consumption of your applications. FireQOS is
-not a daemon. It will just convert the configuration to `tc` commands. It will run them and it will
-exit.
+Nothing more is needed. You just run `fireqos start` to apply this configuration, restart netdata and you have real-time visualization of the bandwidth consumption of your applications. FireQOS is not a daemon. It will just convert the configuration to `tc` commands. It will run them and it will exit.
 
-**IMPORTANT**: If you copy this configuration to apply it to your system, please adapt the
-speeds - experiment in non-production environments to learn the tool, before applying it on
-your servers.
+**IMPORTANT**: If you copy this configuration to apply it to your system, please adapt the speeds - experiment in non-production environments to learn the tool, before applying it on your servers.
 
 And this is what you are going to get:
 
@@ -174,10 +170,11 @@ And this is what you are going to get:
 
 ## More examples:
 
-This is QoS from a linux router. Check these features:
+This is QoS from my home linux router. Check these features:
 
 1. It is real-time (per second updates)
 2. QoS really works in Linux - check that the `background` traffic is squeezed when `surfing` needs it.
 
 ![test2](https://cloud.githubusercontent.com/assets/2662304/14093004/68966020-f553-11e5-98fe-ffee2086fafd.gif)
 
+
diff --git a/collectors/tc.plugin/tc-qos-helper.sh b/collectors/tc.plugin/tc-qos-helper.sh
index b49d1f509..a1a2b9145 100644
--- a/collectors/tc.plugin/tc-qos-helper.sh
+++ b/collectors/tc.plugin/tc-qos-helper.sh
@@ -100,7 +100,7 @@ if [ ! -d "${fireqos_run_dir}" ]
             warning "Although FireQoS is installed on this system as '${fireqos}', I cannot find/read its installation configuration at '${fireqos_exec_dir}/install.config'."
         fi
     else
-        warning "FireQoS is not installed on this system. Use FireQoS to apply traffic QoS and expose the class names to netdata. Check https://github.com/netdata/netdata/wiki/You-should-install-QoS-on-all-your-servers"
+        warning "FireQoS is not installed on this system. Use FireQoS to apply traffic QoS and expose the class names to netdata. Check https://github.com/netdata/netdata/tree/master/collectors/tc.plugin#tcplugin"
     fi
 fi
 
diff --git a/collectors/tc.plugin/tc-qos-helper.sh.in b/collectors/tc.plugin/tc-qos-helper.sh.in
index 6f6b0a591..a15eab899 100755
--- a/collectors/tc.plugin/tc-qos-helper.sh.in
+++ b/collectors/tc.plugin/tc-qos-helper.sh.in
@@ -100,7 +100,7 @@ if [ ! -d "${fireqos_run_dir}" ]
             warning "Although FireQoS is installed on this system as '${fireqos}', I cannot find/read its installation configuration at '${fireqos_exec_dir}/install.config'."
         fi
     else
-        warning "FireQoS is not installed on this system. Use FireQoS to apply traffic QoS and expose the class names to netdata. Check https://github.com/netdata/netdata/wiki/You-should-install-QoS-on-all-your-servers"
+        warning "FireQoS is not installed on this system. Use FireQoS to apply traffic QoS and expose the class names to netdata. Check https://github.com/netdata/netdata/tree/master/collectors/tc.plugin#tcplugin"
     fi
 fi