Default parser for the control-plane stats verb. Resolves the target gobj and returns a JSON document with its statistics.
Source code:
build_stats()¶
build_stats() constructs a JSON object containing statistical data extracted from the attributes of a given hgobj instance, including attributes marked with SFD_STATS flags.
json_t *build_stats(
hgobj gobj,
const char *stats,
json_t *kw,
hgobj src
);Parameters
| Key | Type | Description |
|---|---|---|
gobj | hgobj | The hgobj instance from which statistics are gathered. |
stats | const char * | A string specifying which statistics to include. If "__reset__", resets the statistics. |
kw | json_t * | A JSON object containing additional parameters. This object is decremented after use. |
src | hgobj | The source hgobj instance, used for context in the statistics gathering process. |
Returns
A JSON object containing the collected statistics, structured by the short names of the hgobj instances.
Notes
Internally, _build_stats() is used to extract statistics from the hgobj instance and its bottom-level objects.
The function iterates through the hierarchy of hgobj instances, aggregating statistics from each level.
stats_parser()¶
stats_parser() generates a JSON-formatted statistical report by extracting relevant attributes from the given hgobj instance and formatting them into a structured response.
json_t *stats_parser(
hgobj gobj,
const char *stats,
json_t *kw,
hgobj src
);Parameters
| Key | Type | Description |
|---|---|---|
gobj | hgobj | The hgobj instance from which statistics are extracted. |
stats | const char * | A string specifying which statistics to retrieve. If NULL, all available statistics are included. |
kw | json_t * | A JSON object containing additional parameters. Ownership is transferred to stats_parser(). |
src | hgobj | The source hgobj that initiated the request. |
Returns
A JSON object containing the formatted statistical report. The caller assumes ownership of the returned object.
Notes
Internally, stats_parser() calls build_stats() to generate the statistical data.
The function wraps the generated statistics in a standard command response format before returning.
build_stats_response()¶
Description pending — signature extracted from header.
json_t *build_stats_response(
hgobj gobj,
json_int_t result,
json_t *jn_comment,
json_t *jn_schema,
json_t *jn_data
);