From 1cad8353e3fc04b2b8486fd490b57591a2cc0a9a Mon Sep 17 00:00:00 2001 From: Daniel-Constantin Mierla Date: Mon, 16 Jul 2018 14:03:43 +0200 Subject: [PATCH] kex: docs - note about stats.fetch in the section for stats.get_statistics --- src/modules/kex/doc/kex_admin.xml | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/src/modules/kex/doc/kex_admin.xml b/src/modules/kex/doc/kex_admin.xml index 8fe4e84ba8d..b55bfa4be43 100644 --- a/src/modules/kex/doc/kex_admin.xml +++ b/src/modules/kex/doc/kex_admin.xml @@ -735,11 +735,15 @@ resetdebug(); stats.get_statistics Print the list of available internal statistics. + NOTE: the result is an array of strings that have the list of + statistics formated like "name = value", being propagated over the time + from the MI variant. Use "stats.fetch" command to have a more + JSON-friendly output. Parameters: statsid - which statistics to - be printed. If set to 'all' then all statistics are printed; if - set to 'statsgroup:' then all statistics in the group are printed; - if set to 'statsname' then the statistics identified by the name - is printed. + be printed. If set to 'all' then all statistics are printed; if + set to 'statsgroup:' then all statistics in the group are printed; + if set to 'statsname' then the statistics identified by the name + is printed. Examples: &kamcmd; stats.get_statistics all @@ -757,11 +761,11 @@ resetdebug(); structure: {"statsgroup.statsname" : "statsvalue"}. The value is represented as string to accomodate large numbers. Parameters: statsid - which statistics to - be printed. If set to 'all' then all statistics are printed; if - set to 'statsgroup:' then all statistics in the group are printed; - if set to 'statsname' then the statistics identified by the name - is printed (can be also 'statsgroup.stastname' or - 'statsgroup:statsname'). + be printed. If set to 'all' then all statistics are printed; if + set to 'statsgroup:' then all statistics in the group are printed; + if set to 'statsname' then the statistics identified by the name + is printed (can be also 'statsgroup.stastname' or + 'statsgroup:statsname'). Examples: &kamcmd; stats.fetch all