From abb74056bd6a281b8c9b34d0c59b2ba2b2c0ec39 Mon Sep 17 00:00:00 2001
From: Zaiming Shi <zmstone@gmail.com>
Date: Mon, 2 Nov 2020 12:12:06 +0100
Subject: [PATCH] refactor(metrics): Use modified moving average for topic
 metrics speed

---
 apps/emqx/src/emqx_mod_topic_metrics.erl | 39 +++++++++---------------
 1 file changed, 15 insertions(+), 24 deletions(-)

diff --git a/apps/emqx/src/emqx_mod_topic_metrics.erl b/apps/emqx/src/emqx_mod_topic_metrics.erl
index cfcf1ae79..2041acb96 100644
--- a/apps/emqx/src/emqx_mod_topic_metrics.erl
+++ b/apps/emqx/src/emqx_mod_topic_metrics.erl
@@ -43,7 +43,6 @@
 -export([ inc/2
         , inc/3
         , val/2
-        , rate/2
         , metrics/1
         , register/1
         , unregister/1
@@ -52,6 +51,10 @@
         , all_registered_topics/0
         ]).
 
+%% Exposed for test only.
+-export([ rate/2
+        ]).
+
 %% gen_server callbacks
 -export([ init/1
         , handle_call/3
@@ -78,13 +81,11 @@
         ]).
 
 -define(TICKING_INTERVAL, 1).
+-define(SPEED_AVERAGE_WINDOW_SIZE, 5).
 
 -record(speed, {
             last = 0 :: number(),
-            tick = 1 :: number(),
-            last_v = 0 :: number(),
-            acc = 0 :: number(),
-            samples = [] :: list()
+            last_v = 0 :: number()
         }).
 
 -record(state, {
@@ -358,25 +359,15 @@ counters_size() ->
 number_of_registered_topics() ->
     proplists:get_value(size, ets:info(?TAB)).
 
-calculate_speed(CurVal, #speed{last_v = LastVal, tick = Tick, acc = Acc, samples = Samples}) ->
+calculate_speed(CurVal, #speed{last = Last,
+                               last_v = LastVal
+                              }) ->
     %% calculate the current speed based on the last value of the counter
     CurSpeed = (CurVal - LastVal) / ?TICKING_INTERVAL,
+    #speed{last = mma(?SPEED_AVERAGE_WINDOW_SIZE, Last, CurSpeed),
+           last_v = CurVal
+          }.
 
-    %% calculate the average speed in last 5 seconds
-    case Tick < 5 of
-        true ->
-            Acc1 = Acc + CurSpeed,
-            #speed{last = Acc1 / Tick,
-                   last_v = CurVal,
-                   acc = Acc1,
-                   samples = Samples ++ [CurSpeed],
-                   tick = Tick + 1};
-        false ->
-            [FirstSpeed | Speeds] = Samples,
-            Acc1 =  Acc + CurSpeed - FirstSpeed,
-            #speed{last = Acc1 / Tick,
-                   last_v = CurVal,
-                   acc = Acc1,
-                   samples = Speeds ++ [CurSpeed],
-                   tick = Tick}
-    end.
+%% Modified Moving Average ref: https://en.wikipedia.org/wiki/Moving_average
+mma(WindowSize, LastSpeed, CurSpeed) ->
+  (LastSpeed * (WindowSize - 1) + CurSpeed) / WindowSize.