]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[756-correct-statistic-get{all}-commands] adapt changes to sphinx
authorFranciszek Gorski <fagorski9@gmail.com>
Thu, 1 Aug 2019 08:19:17 +0000 (10:19 +0200)
committerFranciszek Gorski <fagorski9@gmail.com>
Wed, 7 Aug 2019 17:50:14 +0000 (19:50 +0200)
doc/sphinx/api/statistic-get-all.json
doc/sphinx/api/statistic-get.json
doc/sphinx/arm/stats.rst

index 196867bb788337dbb5eb4c946b0d8070b559e01c..44104f17be0160742e970ae3a252f07fccee99ff 100644 (file)
@@ -18,4 +18,4 @@
         "kea-dhcp4",
         "kea-dhcp6"
     ]
-}
\ No newline at end of file
+}
index 5031937226c2438db5ad6a799faae10f5aed89a5..1bba792ab4b7cbdc60f5d28cee04cd0acf08a2a6 100644 (file)
@@ -20,4 +20,4 @@
         "kea-dhcp4",
         "kea-dhcp6"
     ]
-}
\ No newline at end of file
+}
index 88e5d2d81cfe3b0f6a5e5a8679b4aad059457c67..4351ba9f3f80b121646ea9f8af3ab00ab47b6eb4 100644 (file)
@@ -123,6 +123,17 @@ The server returns details of the requested statistic, with a result of
 "arguments" parameter. If the requested statistic is not found, the
 response will contain an empty map, i.e. only { } as an argument, but
 the status code will still indicate success (0).
+An example response:
+
+::
+
+   {
+       "command": "statistic-get",
+       "arguments": {
+           "pkt4-received": [ [ 125, "2019-07-30 10:11:19.498739" ], [ 100, "2019-07-30 10:11:19.498662" ] ]
+       },
+       "result": 0
+   }
 
 .. _command-statistic-reset:
 
@@ -192,6 +203,21 @@ example command may look like this:
 The server responds with details of all recorded statistics, with a
 result set to 0 to indicate that it iterated over all statistics (even
 when the total number of statistics is zero).
+An example response returning all collected statistics:
+
+::
+
+   {
+       "command": "statistic-get",
+       "arguments": {
+       "declined-addresses": [ [ 0, "2019-07-30 10:04:28.386733" ] ], "reclaimed-declined-addresses": [ [ 0, "2019-07-30 10:04:28.386735" ] ],
+       "reclaimed-leases": [ [ 0, "2019-07-30 10:04:28.386736" ] ], "subnet[1].assigned-addresses": [ [ 0, "2019-07-30 10:04:28.386740" ] ],
+       "subnet[1].declined-addresses": [ [ 0, "2019-07-30 10:04:28.386743" ] ], "subnet[1].reclaimed-declined-addresses": [ [ 0, "2019-07-30 10:04:28.386745" ] ],
+       "subnet[1].reclaimed-leases": [ [ 0, "2019-07-30 10:04:28.386747" ] ], "subnet[1].total-addresses": [ [ 200, "2019-07-30 10:04:28.386719" ] ]
+
+       },
+       "result": 0
+   }
 
 .. _command-statistic-reset-all: