Commit 6f6a4cf9 authored by Naoki Kambe's avatar Naoki Kambe
Browse files

[trac930] update spec file of stats module

 - update description of status command, shutdown command and show
   command

 - change argument of show command (Owner module name of statistics
   data can be specified)

 - change argument of set command (Owner module name of statistics
   data is always required)

 - add showschema command which shows statistics data schema of each
   module specified)

 - disabled reset command and remove command
parent 36a53f41
......@@ -6,55 +6,74 @@
"commands": [
{
"command_name": "status",
"command_description": "identify whether stats module is alive or not",
"command_description": "Show status of the stats daemon",
"command_args": []
},
{
"command_name": "shutdown",
"command_description": "Shut down the stats module",
"command_args": []
},
{
"command_name": "show",
"command_description": "show the specified/all statistics data",
"command_description": "Show the specified/all statistics data",
"command_args": [
{
"item_name": "stats_item_name",
"item_name": "owner",
"item_type": "string",
"item_optional": true,
"item_default": "",
"item_description": "module name of the owner of the statistics data"
},
{
"item_name": "name",
"item_type": "string",
"item_optional": true,
"item_default": ""
"item_default": "",
"item_description": "statistics item name of the owner"
}
]
},
{
"command_name": "set",
"command_description": "set the value of specified name in statistics data",
"command_name": "showschema",
"command_description": "show the specified/all statistics shema",
"command_args": [
{
"item_name": "stats_data",
"item_type": "map",
"item_optional": false,
"item_default": {},
"map_item_spec": []
"item_name": "owner",
"item_type": "string",
"item_optional": true,
"item_default": "",
"item_description": "module name of the owner of the statistics data"
},
{
"item_name": "name",
"item_type": "string",
"item_optional": true,
"item_default": "",
"item_description": "statistics item name of the owner"
}
]
},
{
"command_name": "remove",
"command_description": "remove the specified name from statistics data",
"command_name": "set",
"command_description": "set the value of specified name in statistics data",
"command_args": [
{
"item_name": "stats_item_name",
"item_name": "owner",
"item_type": "string",
"item_optional": false,
"item_default": ""
"item_default": "",
"item_description": "module name of the owner of the statistics data"
},
{
"item_name": "data",
"item_type": "map",
"item_optional": false,
"item_default": {},
"item_description": "statistics data set of the owner",
"map_item_spec": []
}
]
},
{
"command_name": "reset",
"command_description": "reset all statistics data to default values except for several constant names",
"command_args": []
},
{
"command_name": "shutdown",
"command_description": "Shut down the stats module",
"command_args": []
}
],
"statistics": [
......@@ -100,7 +119,7 @@
"item_default": "",
"item_title": "Local Name",
"item_description": "A localname of stats module given via CC protocol"
}
}
]
}
}
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment