Feature: added vhost_traffic_status_dump to maintain statistics data …

…permanently
vozlt · Apr 4, 2017 · fc73722 · fc73722
1 parent dbbe2a9
commit fc73722
Show file tree

Hide file tree

Showing 7 changed files with 715 additions and 75 deletions.
diff --git a/README.md b/README.md
@@ -43,12 +43,14 @@ Table of Contents
   * [To calculate traffic for individual user agent](#to-calculate-traffic-for-individual-user-agent)
   * [To calculate traffic for dynamic dns](#to-calculate-traffic-for-dynamic-dns)
   * [To calculate traffic except for status page](#to-calculate-traffic-except-for-status-page)
+  * [To maintain statistics data permanently](#to-maintain-statistics-data-permanently)
 * [Customizing](#customizing)
   * [To customize after the module installed](#to-customize-after-the-module-installed)
   * [To customize before the module installed](#to-customize-before-the-module-installed)
 * [Directives](#directives)
   * [vhost_traffic_status](#vhost_traffic_status)
   * [vhost_traffic_status_zone](#vhost_traffic_status_zone)
+  * [vhost_traffic_status_dump](#vhost_traffic_status_dump)
   * [vhost_traffic_status_display](#vhost_traffic_status_display)
   * [vhost_traffic_status_display_format](#vhost_traffic_status_display_format)
   * [vhost_traffic_status_display_jsonp](#vhost_traffic_status_display_jsonp)
@@ -71,17 +73,18 @@ Table of Contents
 * [Author](#author)
 
 ## Version
-This document describes nginx-module-vts `v0.1.14` released on 14 Mar 2017.
+This document describes nginx-module-vts `v0.1.15` released on 3 Apr 2017.
 
 ## Dependencies
 * [nginx](http://nginx.org)
 
 ## Compatibility
-* 1.11.x (last tested: 1.11.10)
-* 1.10.x (last tested: 1.10.3)
-* 1.8.x (last tested: 1.8.0)
-* 1.6.x (last tested: 1.6.3)
-* 1.4.x (last tested: 1.4.7)
+* Nginx
+  * 1.11.x (last tested: 1.11.10)
+  * 1.10.x (last tested: 1.10.3)
+  * 1.8.x (last tested: 1.8.0)
+  * 1.6.x (last tested: 1.6.3)
+  * 1.4.x (last tested: 1.4.7)
 
 Earlier versions is not tested.
 
@@ -1018,6 +1021,27 @@ See the following directives:
   * [vhost_traffic_status_bypass_stats](#vhost_traffic_status_bypass_stats)
 
 
+### To maintain statistics data permanently
+
+```Nginx
+http {
+    vhost_traffic_status_zone;
+    vhost_traffic_status_dump /var/log/nginx/vts.db;
+
+    ...
+
+    server {
+
+        ...
+
+    }
+}
+```
+
+* The `vhost_traffic_status_dump` directive maintains statistics data permanently
+even if system has been rebooted or nginx has been restarted.
+Please see the [vhost_traffic_status_dump](#vhost_traffic_status_dump) directive for detailed usage.
+
 ## Customizing
 ### To customize after the module installed
 1. You need to change the `{{uri}}` string to your status uri in status.template.html as follows:
@@ -1102,6 +1126,19 @@ If you set `vhost_traffic_status_zone` directive, is automatically enabled.
 `Description:` Sets parameters for a shared memory zone that will keep states for various keys.
 The cache is shared between all worker processes.
 
+### vhost_traffic_status_dump
+
+| -   | - |
+| --- | --- |
+| **Syntax**  | **vhost_traffic_status_dump** *path* [*period*] |
+| **Default** | - |
+| **Context** | http |
+
+`Description:` Enables the statistics data dump and restore.
+The *path* is a location to dump the statistics data.(e.g. `/var/log/nginx/vts.db`)
+The *period* is a backup cycle time.(Default: 60s)
+It is backed up immediately regardless of the backup cycle if nginx is exited by signal(`SIGKILL`).
+
 ### vhost_traffic_status_display
 
 | -   | - |

diff --git a/config b/config
@@ -12,6 +12,7 @@ HTTP_VTS_SRCS=" \
                  $ngx_addon_dir/src/ngx_http_vhost_traffic_status_limit.c       \
                  $ngx_addon_dir/src/ngx_http_vhost_traffic_status_display.c     \
                  $ngx_addon_dir/src/ngx_http_vhost_traffic_status_set.c         \
+                 $ngx_addon_dir/src/ngx_http_vhost_traffic_status_dump.c        \
                  "
 
 HTTP_VTS_DEPS=" \
@@ -25,6 +26,7 @@ HTTP_VTS_DEPS=" \
                  $ngx_addon_dir/src/ngx_http_vhost_traffic_status_limit.h       \
                  $ngx_addon_dir/src/ngx_http_vhost_traffic_status_display.h     \
                  $ngx_addon_dir/src/ngx_http_vhost_traffic_status_set.h         \
+                 $ngx_addon_dir/src/ngx_http_vhost_traffic_status_dump.h        \
                  $ngx_addon_dir/src/ngx_http_vhost_traffic_status_module_html.h \
                  "
 if test -n "$ngx_module_link"; then

diff --git a/src/ngx_http_vhost_traffic_status_control.c b/src/ngx_http_vhost_traffic_status_control.c
@@ -88,7 +88,7 @@ ngx_http_vhost_traffic_status_node_upstream_lookup(
         uscf = uscfp[i];
 
         /* nogroups */
-        if(uscf->servers == NULL && uscf->port != 0) {
+        if (uscf->servers == NULL && uscf->port != 0) {
             continue;
         }
 
@@ -135,7 +135,7 @@ ngx_http_vhost_traffic_status_node_control_range_set(
             state = NGX_HTTP_VHOST_TRAFFIC_STATUS_CONTROL_RANGE_NONE;
 
         } else if (control->zone->len == 1) {
-            if(ngx_strncmp(control->zone->data, "*", 1) == 0) {
+            if (ngx_strncmp(control->zone->data, "*", 1) == 0) {
                 state = NGX_HTTP_VHOST_TRAFFIC_STATUS_CONTROL_RANGE_GROUP;
             }
         }