Feature: added vhost_traffic_status_average_method to support for selecting an average formula

Author: vozlt

README.md

@@ -60,6 +60,7 @@ Table of Contents
  * [vhost_traffic_status_limit_traffic_by_set_key](#vhost_traffic_status_limit_traffic_by_set_key)
  * [vhost_traffic_status_limit_check_duplicate](#vhost_traffic_status_limit_check_duplicate)
  * [vhost_traffic_status_set_by_filter](#vhost_traffic_status_set_by_filter)
+ * [vhost_traffic_status_average_method](#vhost_traffic_status_average_method)
 * [See Also](#see-also)
 * [TODO](#todo)
 * [Donation](#donation)
@@ -1397,6 +1398,21 @@ For examples:
 * cacheHit in cacheZones
  * **vhost_traffic_status_set_by_filter** `$cacheHit` `cache/my_cache_name/cacheHit`
 
+### vhost_traffic_status_average_method
+
+- | -
+--- | ---
+**Syntax** | **vhost_traffic_status_average_method** \<AMM\|WMA\>
+**Default** | AMM
+**Context** | http, server, location
+
+`Description:` Sets the method which is a formula that calculate the average of response processing times.
+The corresponding values are `requestMsec` and `responseMsec` in JSON.
+
+* **AMM**
+ * The AMM is the [arithmetic mean](https://en.wikipedia.org/wiki/Arithmetic_mean).
+* **WMA**
+ * THE WMA is the [weighted moving average](https://en.wikipedia.org/wiki/Moving_average#Weighted_moving_average).
 
 ## See Also
 * Stream traffic status

src/ngx_http_vhost_traffic_status_module.c

@@ -41,6 +41,13 @@ static ngx_conf_enum_t ngx_http_vhost_traffic_status_display_format[] = {
 };
 
 
+static ngx_conf_enum_t ngx_http_vhost_traffic_status_average_method[] = {
+ { ngx_string("AMM"), NGX_HTTP_VHOST_TRAFFIC_STATUS_AVERAGE_METHOD_AMM },
+ { ngx_string("WMA"), NGX_HTTP_VHOST_TRAFFIC_STATUS_AVERAGE_METHOD_WMA },
+ { ngx_null_string, 0 }
+};
+
+
 static ngx_command_t ngx_http_vhost_traffic_status_commands[] = {
 
  { ngx_string("vhost_traffic_status"),
@@ -149,6 +156,13 @@ static ngx_command_t ngx_http_vhost_traffic_status_commands[] = {
  0,
  NULL },
 
+ { ngx_string("vhost_traffic_status_average_method"),
+ NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1,
+ ngx_conf_set_enum_slot,
+ NGX_HTTP_LOC_CONF_OFFSET,
+ offsetof(ngx_http_vhost_traffic_status_loc_conf_t, average_method),
+ &ngx_http_vhost_traffic_status_average_method },
+
  ngx_null_command
 };
 
@@ -541,16 +555,44 @@ ngx_http_vhost_traffic_status_create_loc_conf(ngx_conf_t *cf)
  return NULL;
  }
 
- conf->start_msec = ngx_current_msec;
+ /*
+ * set by ngx_pcalloc():
+ *
+ * conf->shm_zone = { NULL, ... };
+ * conf->enable = 0;
+ * conf->filter = 0;
+ * conf->filter_host = 0;
+ * conf->filter_check_duplicate = 0;
+ * conf->filter_keys = { NULL, ... };
+ * conf->filter_vars = { NULL, ... };
+ *
+ * conf->limit = 0;
+ * conf->limit_check_duplicate = 0;
+ * conf->limit_traffics = { NULL, ... };
+ * conf->limit_filter_traffics = { NULL, ... };
+ *
+ * conf->shm_name = { 0, NULL };
+ * conf->stats = { 0, ... };
+ * conf->start_msec = 0;
+ * conf->format = 0;
+ * conf->jsonp = { 0, NULL };
+ * conf->sum_key = { 0, NULL };
+ * conf->average_method = 0;
+ */
+
+ conf->shm_zone = NGX_CONF_UNSET_PTR;
  conf->enable = NGX_CONF_UNSET;
  conf->filter = NGX_CONF_UNSET;
  conf->filter_host = NGX_CONF_UNSET;
  conf->filter_check_duplicate = NGX_CONF_UNSET;
+ conf->filter_vars = NGX_CONF_UNSET_PTR;
+
  conf->limit = NGX_CONF_UNSET;
  conf->limit_check_duplicate = NGX_CONF_UNSET;
- conf->shm_zone = NGX_CONF_UNSET_PTR;
+
+ conf->start_msec = ngx_current_msec;
  conf->format = NGX_CONF_UNSET;
- conf->filter_vars = NGX_CONF_UNSET_PTR;
+ conf->average_method = NGX_CONF_UNSET;
 
  conf->node_caches = ngx_pcalloc(cf->pool, sizeof(ngx_rbtree_node_t *)
  * (NGX_HTTP_VHOST_TRAFFIC_STATUS_UPSTREAM_FG + 1));
@@ -638,21 +680,23 @@ ngx_http_vhost_traffic_status_merge_loc_conf(ngx_conf_t *cf, void *parent, void
  }
  }
 
+ ngx_conf_merge_ptr_value(conf->shm_zone, prev->shm_zone, NULL);
  ngx_conf_merge_value(conf->enable, prev->enable, 1);
  ngx_conf_merge_value(conf->filter, prev->filter, 1);
  ngx_conf_merge_value(conf->filter_host, prev->filter_host, 0);
  ngx_conf_merge_value(conf->filter_check_duplicate, prev->filter_check_duplicate, 1);
  ngx_conf_merge_value(conf->limit, prev->limit, 1);
  ngx_conf_merge_value(conf->limit_check_duplicate, prev->limit_check_duplicate, 1);
- ngx_conf_merge_ptr_value(conf->shm_zone, prev->shm_zone, NULL);
+ ngx_conf_merge_ptr_value(conf->filter_vars, prev->filter_vars, NULL);
+
  ngx_conf_merge_value(conf->format, prev->format,
  NGX_HTTP_VHOST_TRAFFIC_STATUS_FORMAT_JSON);
  ngx_conf_merge_str_value(conf->jsonp, prev->jsonp,
  NGX_HTTP_VHOST_TRAFFIC_STATUS_DEFAULT_JSONP);
  ngx_conf_merge_str_value(conf->sum_key, prev->sum_key,
  NGX_HTTP_VHOST_TRAFFIC_STATUS_DEFAULT_SUM_KEY);
-
- ngx_conf_merge_ptr_value(conf->filter_vars, prev->filter_vars, NULL);
+ ngx_conf_merge_value(conf->average_method, prev->average_method,
+  NGX_HTTP_VHOST_TRAFFIC_STATUS_AVERAGE_METHOD_AMM);
 
  name = ctx->shm_name;
 

src/ngx_http_vhost_traffic_status_module.h

@@ -34,6 +34,9 @@
 #define NGX_HTTP_VHOST_TRAFFIC_STATUS_FORMAT_HTML 2
 #define NGX_HTTP_VHOST_TRAFFIC_STATUS_FORMAT_JSONP 3
 
+#define NGX_HTTP_VHOST_TRAFFIC_STATUS_AVERAGE_METHOD_AMM 0
+#define NGX_HTTP_VHOST_TRAFFIC_STATUS_AVERAGE_METHOD_WMA 1
+
 #define NGX_HTTP_VHOST_TRAFFIC_STATUS_DEFAULT_SHM_NAME "ngx_http_vhost_traffic_status"
 #define NGX_HTTP_VHOST_TRAFFIC_STATUS_DEFAULT_SHM_SIZE 0xfffff
 #define NGX_HTTP_VHOST_TRAFFIC_STATUS_DEFAULT_JSONP "ngx_http_vhost_traffic_status_jsonp_callback"
@@ -436,6 +439,7 @@ typedef struct {
  ngx_flag_t format;
  ngx_str_t jsonp;
  ngx_str_t sum_key;
+ ngx_flag_t average_method;
 
  ngx_rbtree_node_t **node_caches;
 } ngx_http_vhost_traffic_status_loc_conf_t;

src/ngx_http_vhost_traffic_status_node.c

@@ -251,9 +251,12 @@ void
 ngx_http_vhost_traffic_status_node_set(ngx_http_request_t *r,
  ngx_http_vhost_traffic_status_node_t *vtsn)
 {
- ngx_uint_t status;
- ngx_msec_int_t ms;
- ngx_http_vhost_traffic_status_node_t ovtsn;
+ ngx_uint_t status;
+ ngx_msec_int_t ms;
+ ngx_http_vhost_traffic_status_node_t ovtsn;
+ ngx_http_vhost_traffic_status_loc_conf_t *vtscf;
+
+ vtscf = ngx_http_get_module_loc_conf(r, ngx_http_vhost_traffic_status_module);
 
  status = r->headers_out.status;
  ovtsn = *vtsn;
@@ -269,8 +272,8 @@ ngx_http_vhost_traffic_status_node_set(ngx_http_request_t *r,
  ngx_http_vhost_traffic_status_node_time_queue_insert(&vtsn->stat_request_times,
  ms);
 
- vtsn->stat_request_time = ngx_http_vhost_traffic_status_node_time_queue_wma(
- &vtsn->stat_request_times);
+ vtsn->stat_request_time = ngx_http_vhost_traffic_status_node_time_queue_average(
+ &vtsn->stat_request_times, vtscf->average_method);
 
 #if (NGX_HTTP_CACHE)
  if (r->upstream != NULL && r->upstream->cache_status != 0) {
@@ -349,6 +352,41 @@ ngx_http_vhost_traffic_status_node_time_queue_insert(
 }
 
 
+ngx_msec_t
+ngx_http_vhost_traffic_status_node_time_queue_average(
+ ngx_http_vhost_traffic_status_node_time_queue_t *q,
+ ngx_int_t method)
+{
+ ngx_msec_t avg;
+
+ if (method == NGX_HTTP_VHOST_TRAFFIC_STATUS_AVERAGE_METHOD_AMM) {
+ avg = ngx_http_vhost_traffic_status_node_time_queue_amm(q);
+ } else {
+ avg = ngx_http_vhost_traffic_status_node_time_queue_wma(q);
+ }
+
+ return avg;
+}
+
+
+ngx_msec_t
+ngx_http_vhost_traffic_status_node_time_queue_amm(
+ ngx_http_vhost_traffic_status_node_time_queue_t *q)
+{
+ ngx_int_t i, j, k;
+
+ for (i = q->front, j = 1, k = 0; i != q->rear; i = (i + 1) % q->len, j++) {
+ k += (ngx_int_t) q->times[i].msec;
+ }
+
+ if (j != q->len) {
+ ngx_http_vhost_traffic_status_node_time_queue_init(q);
+ }
+
+ return (ngx_msec_t) (k / (q->len - 1));
+}
+
+
 ngx_msec_t
 ngx_http_vhost_traffic_status_node_time_queue_wma(
  ngx_http_vhost_traffic_status_node_time_queue_t *q)

src/ngx_http_vhost_traffic_status_node.h

@@ -113,6 +113,12 @@ ngx_int_t ngx_http_vhost_traffic_status_node_time_queue_push(
 ngx_int_t ngx_http_vhost_traffic_status_node_time_queue_pop(
  ngx_http_vhost_traffic_status_node_time_queue_t *q,
  ngx_http_vhost_traffic_status_node_time_t *x);
+
+ngx_msec_t ngx_http_vhost_traffic_status_node_time_queue_average(
+ ngx_http_vhost_traffic_status_node_time_queue_t *q,
+ ngx_int_t method);
+ngx_msec_t ngx_http_vhost_traffic_status_node_time_queue_amm(
+ ngx_http_vhost_traffic_status_node_time_queue_t *q);
 ngx_msec_t ngx_http_vhost_traffic_status_node_time_queue_wma(
  ngx_http_vhost_traffic_status_node_time_queue_t *q);
 

src/ngx_http_vhost_traffic_status_shm.c

@@ -171,7 +171,10 @@ static ngx_int_t
 ngx_http_vhost_traffic_status_shm_add_node_upstream(ngx_http_request_t *r,
  ngx_http_vhost_traffic_status_node_t *vtsn, unsigned init)
 {
- ngx_msec_int_t ms;
+ ngx_msec_int_t ms;
+ ngx_http_vhost_traffic_status_loc_conf_t *vtscf;
+
+ vtscf = ngx_http_get_module_loc_conf(r, ngx_http_vhost_traffic_status_module);
 
  ms = ngx_http_vhost_traffic_status_upstream_response_time(r);
 
@@ -182,8 +185,9 @@ ngx_http_vhost_traffic_status_shm_add_node_upstream(ngx_http_request_t *r,
  vtsn->stat_upstream.response_time = (ngx_msec_t) ms;
 
  } else {
- vtsn->stat_upstream.response_time = ngx_http_vhost_traffic_status_node_time_queue_wma(
- &vtsn->stat_upstream.response_times);
+ vtsn->stat_upstream.response_time = ngx_http_vhost_traffic_status_node_time_queue_average(
+ &vtsn->stat_upstream.response_times,
+ vtscf->average_method);
  }
 
  return NGX_OK;