From f9bad0412b6eac416c85ae599b48415438491f04 Mon Sep 17 00:00:00 2001
From: "Zaiming (Stone) Shi" <zmstone@gmail.com>
Date: Tue, 22 Mar 2022 08:22:20 +0100
Subject: [PATCH] docs: add doc for stats

---
 apps/emqx/src/emqx_schema.erl | 19 ++++++++++++++-----
 1 file changed, 14 insertions(+), 5 deletions(-)

diff --git a/apps/emqx/src/emqx_schema.erl b/apps/emqx/src/emqx_schema.erl
index 022ab3664..105e66084 100644
--- a/apps/emqx/src/emqx_schema.erl
+++ b/apps/emqx/src/emqx_schema.erl
@@ -206,21 +206,27 @@ roots(low) ->
                 ref("force_gc"),
                 #{
                     desc =>
-                        ""
                         "Force the MQTT connection process garbage collection after\n"
                         "this number of messages or bytes have passed through."
-                        ""
                 }
             )},
         {"conn_congestion",
             sc(
                 ref("conn_congestion"),
-                #{}
+                #{
+                    desc => "Congession alarm settings"
+                }
             )},
         {"stats",
             sc(
                 ref("stats"),
-                #{}
+                #{
+                    desc =>
+                        "Enable/disable statistic data collection.\n"
+                        "Statistic data such as message receive/send count/rate etc."
+                        "can provide insights of system performance and help to diagnose issues."
+                        "You can find statistic data from the dashboard, or from the '/stats' API."
+                }
             )},
         {"sysmon",
             sc(
@@ -335,7 +341,10 @@ fields("stats") ->
         {"enable",
             sc(
                 boolean(),
-                #{default => true}
+                #{
+                    default => true,
+                    desc => "Enable/disable statistic data collection"
+                }
             )}
     ];
 fields("authorization") ->