mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-31 05:55:28 +00:00
Code Issues Releases Wiki Activity

[#3328] Doc updates

Browse Source 
/doc/sphinx/api-files.txt
/src/share/api/api_files.mk
    Added new command files
        src/share/api/perfmon-control.json
        src/share/api/perfmon-get-all-durations.json

/doc/sphinx/arm/hooks-perfmon.rst
    Updated API section

/src/hooks/dhcp/perfmon/perfmon_mgr.cc
    Added "result-set-format" to get-all-durations results.
This commit is contained in:
Thomas Markwalder
2024-06-12 15:57:49 -04:00
committed by Francis Dupont
parent d61188ed8c
commit 6f9989b6d2
4 changed files with 114 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/sphinx/api-files.txt
View File

@@ -81,6 +81,8 @@ src/share/api/network6-get.json
src/share/api/network6-list.json
src/share/api/network6-subnet-add.json
src/share/api/network6-subnet-del.json
src/share/api/perfmon-control.json
src/share/api/perfmon-get-all-durations.json
src/share/api/remote-class4-del.json
src/share/api/remote-class4-get-all.json
src/share/api/remote-class4-get.json

110
doc/sphinx/arm/hooks-perfmon.rst
View File

@@ -225,6 +225,10 @@ The alarm-cleared INFO log looks like this:
API Commands
~~~~~~~~~~~~
The ``perfmon-control`` Command
-------------------------------
.. isccmd:: command-perfmon-control:
.. _command-perfmon-control:
This command can be used to enable or disable active monitoring and statistics
@@ -240,7 +244,7 @@ reporting at runtime without altering or reloading configuration.
}
}
Regardless of the arguments (if any) are supplied, the current values of both
Regardless of the arguments (if any) supplied, the resulting values of both
flags are always returned:
::
@@ -254,8 +258,112 @@ flags are always returned:
}
}
The ``perfmon-get-all-durations`` Command
-----------------------------------------
.. isccmd:: perfmon-get-all-durations:
.. _command-perfmon-get-all-durations:
This command fetches all monitored duration data currently held in memory by
the Perfmon hook library.
::
{
"command": "perfmon-get-all-durations",
"arguments": {
"result-set-format\": true"
}
}
A result of 0 is returned if command succeeds along with monitored duration data,
while a result of 1 is returned if command is invalid or command processing
encounters an error.
The format of the monitored duration data returned is determined by the
optional argument, ``result-set-format``. When false, (the default), the list
of durations will be returned as a list of individual elements as shown below:
::
{
"arguments": {
"durations\": [{
"duration-key": {
"query-type": "DHCPDISCOVER",
"response-type": "DHCPOFFER",
"start-event": "buffer_read",
"stop-event": "mt_queued",
"subnet-id": 0
},
"max-duration-usecs": 118,
"min-duration-usecs": 31,
"occurrences": 501,
"start-time": "2024-06-12 17:52:06.814884",
"total-duration-usecs": 23951,
"ave-duration-usecs\": 47
},
..,
]",
"result-set-format": false,
"interval-width-secs": 5,
"timestamp": "2024-06-12 17:52:22.397233"
},
"result": 0,
"text": "perfmon-get-all-durations: n found"
}
When ``result-set-format`` is true, the list of durations will be returned in
a format similar to an SQL result set as follows:
::
{
"arguments": {
"durations-result-set": {
"columns": [
"query-type",
"response-type",
"start-event",
"end-event",
"subnet-id",
"interval-start",
"occurences",
"min-duration-usecs",
"max-duration-usecs",
"total-duration-usecsave-duration-usecs"
],
"rows": [ [
"DHCPDISCOVER",
"DHCPOFFER",
"buffer_read",
"mt_queued",
0,
"2024-06-12 17:52:06.814884",
501,
31,
118,
23951,
47
],
..
]
}
"result-set-format": true,
"interval-width-secs": 5,
"timestamp": "2024-06-12 17:52:22.397233"
},
"result": 0,
"text": "perfmon-get-all-durations: n found"
}
The data values for each duration will be from the duration's last completed data
interval. If a duration has no such interval, ``interval-start`` will be reported
as "<none>" and the remaining values will be zero.
.. _perfmon-configuration:
Configuration
~~~~~~~~~~~~~

2
src/hooks/dhcp/perfmon/perfmon_mgr.cc
View File

@@ -287,7 +287,6 @@ PerfMonMgr::perfmonGetAllDurationsHandler(hooks::CalloutHandle& handle) {
extractCommand(handle);
if (cmd_args_) {
SimpleParser::checkKeywords(keywords, cmd_args_);
ConstElementPtr elem = cmd_args_->get("result-set-format");
if (elem) {
result_set_format = elem->boolValue();
@@ -309,6 +308,7 @@ PerfMonMgr::perfmonGetAllDurationsHandler(hooks::CalloutHandle& handle) {
// Construct the result
result->set("interval-width-secs", Element::create(getIntervalWidthSecs()));
result->set("timestamp", Element::create(isc::util::ptimeToText(PktEvent::now())));
result->set("result-set-format", Element::create(result_set_format));
result->set((result_set_format ? "durations-result-set" : "durations"), formatted_durations);
std::ostringstream oss;

2
src/share/api/api_files.mk
View File

@@ -81,6 +81,8 @@ api_files += $(top_srcdir)/src/share/api/network6-get.json
api_files += $(top_srcdir)/src/share/api/network6-list.json
api_files += $(top_srcdir)/src/share/api/network6-subnet-add.json
api_files += $(top_srcdir)/src/share/api/network6-subnet-del.json
api_files += $(top_srcdir)/src/share/api/perfmon-control.json
api_files += $(top_srcdir)/src/share/api/perfmon-get-all-durations.json
api_files += $(top_srcdir)/src/share/api/remote-class4-del.json
api_files += $(top_srcdir)/src/share/api/remote-class4-get-all.json
api_files += $(top_srcdir)/src/share/api/remote-class4-get.json