docs: add doc for stats

This commit is contained in:
Zaiming (Stone) Shi 2022-03-22 08:22:20 +01:00
parent 83e16a5bc5
commit f9bad0412b
1 changed files with 14 additions and 5 deletions

View File

@ -206,21 +206,27 @@ roots(low) ->
ref("force_gc"), ref("force_gc"),
#{ #{
desc => desc =>
""
"Force the MQTT connection process garbage collection after\n" "Force the MQTT connection process garbage collection after\n"
"this number of messages or bytes have passed through." "this number of messages or bytes have passed through."
""
} }
)}, )},
{"conn_congestion", {"conn_congestion",
sc( sc(
ref("conn_congestion"), ref("conn_congestion"),
#{} #{
desc => "Congession alarm settings"
}
)}, )},
{"stats", {"stats",
sc( sc(
ref("stats"), 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", {"sysmon",
sc( sc(
@ -335,7 +341,10 @@ fields("stats") ->
{"enable", {"enable",
sc( sc(
boolean(), boolean(),
#{default => true} #{
default => true,
desc => "Enable/disable statistic data collection"
}
)} )}
]; ];
fields("authorization") -> fields("authorization") ->