From: Andrei Pavel <andrei@isc.org>
Date: Thu, 21 Jul 2022 10:09:12 +0000 (+0300)
Subject: [#2434] document socket status in status-get
X-Git-Tag: Kea-2.2.0~23
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a8033a9a5a7feb09d10bf84c593fd4ea11cd4721;p=thirdparty%2Fkea.git

[#2434] document socket status in status-get
---

diff --git a/doc/sphinx/arm/hooks-ha.rst b/doc/sphinx/arm/hooks-ha.rst
index ca5947836f..80f66f2318 100644
--- a/doc/sphinx/arm/hooks-ha.rst
+++ b/doc/sphinx/arm/hooks-ha.rst
@@ -2081,7 +2081,7 @@ available.
 The following is an example response to the ``status-get`` command, including
 the HA status of two ``load-balancing`` servers:
 
-::
+.. code-block:: json
 
    {
        "result": 0,
@@ -2117,7 +2117,10 @@ the HA status of two ``load-balancing`` servers:
            "multi-threading-enabled": true,
            "thread-pool-size": 4,
            "packet-queue-size": 64,
-           "packet-queue-statistics": [ 0.2, 0.1, 0.1 ]
+           "packet-queue-statistics": [ 0.2, 0.1, 0.1 ],
+           "sockets": {
+               "status": "ready"
+           }
        }
    }
 
diff --git a/src/share/api/status-get.json b/src/share/api/status-get.json
index e574841abe..eea4acf316 100644
--- a/src/share/api/status-get.json
+++ b/src/share/api/status-get.json
@@ -44,7 +44,13 @@
         "        \"multi-threading-enabled\": true,",
         "        \"thread-pool-size\": 4,",
         "        \"packet-queue-size\": 64,",
-        "        \"packet-queue-statistics\": [ 1.2, 2.3, 3.4 ]",
+        "        \"packet-queue-statistics\": [ 1.2, 2.3, 3.4 ],",
+        "        \"sockets\": {",
+        "            \"errors\": [",
+        "                <error received during the last attempt to open all sockets>",
+        "            ]",
+        "            \"status\": <ready, retrying, or failed>",
+        "        }",
         "    }",
         "}"
     ],