This is the documentation for the latest (main) development branch of Zephyr. If you are looking for the documentation of previous releases, use the drop-down menu on the left and select the desired version.

Statistics management

Statistics management allows to obtain data gathered by Statistics subsystem of Zephyr, enabled by CONFIG_STATS.

Statistics management group defines commands:

Command ID

Command description

0

Group data

1

List groups

Statistics: group data

The command is used to obtain data for group specified by a name. The name is one of group names as registered, with STATS_INIT_AND_REG macro or stats_init_and_reg(...) function call, within module that gathers the statistics.

Statistics: group data request

Statistics group data request header:

OP

Group ID

Command ID

0

2

0

CBOR data of request:

{
    (str)"name" :  (str)
}

where:

“name”

is group name

Statistics: group data response

Statistics group data response header:

OP

Group ID

Command ID

1

2

0

CBOR data of successful response:

{
    (str)"name"     : (str)
    (str)"fields"   : {
        (str)<entry_name> : (uint)
        ...
    }
}

In case of error the CBOR data takes the form:

{
    (str)"rc"       : (int)
}

where:

“name”

this is name of group the response contains data for

“fields”

this is map of entries within groups that consists of pairs where entry name is mapped to value it represents in statistics

<entry_name>

single entry to value mapping; value is hardcoded to unsigned integer type, in a CBOR meaning

“rc”

Status/error codes in responses only appears if non-zero (error condition).

Statistics: list of groups

The command is used to obtain list of groups of statistics that are gathered on a device. This is a list of names as given to groups with STATS_INIT_AND_REG macro or stats_init_and_reg(...) function calls, within module that gathers the statistics; this means that this command may be considered optional as it is known during compilation what groups will be included into build and listing them is not needed prior to issuing a query.

Statistics: list of groups request

Statistics group list request header:

OP

Group ID

Command ID

0

2

1

The command sends an empty CBOR map as data.

Statistics: list of groups response

Statistics group list request header:

OP

Group ID

Command ID

1

2

1

CBOR data of successful response:

{
    (str)"stat_list" :  [
        (str)<stat_group_name>, ...
    ]
}

In case of error the CBOR data takes the form:

{
    (str)"rc"       : (int)
}

where:

“stat_list”

array of strings representing group names; this array may be empty if there are no groups

“rc”

Status/error codes in responses only appears if non-zero (error condition).