From: Andrei Pavel <andrei@isc.org>
Date: Fri, 28 Apr 2023 12:18:55 +0000 (+0300)
Subject: [#2797] document lease reuse statistics
X-Git-Tag: Kea-2.3.8~191
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=dfeea9fc52ed95eb5d4107f21e92d46614e884c2;p=thirdparty%2Fkea.git

[#2797] document lease reuse statistics
---

diff --git a/doc/sphinx/arm/dhcp4-srv.rst b/doc/sphinx/arm/dhcp4-srv.rst
index 89e7f703b3..c83dc8b3f9 100644
--- a/doc/sphinx/arm/dhcp4-srv.rst
+++ b/doc/sphinx/arm/dhcp4-srv.rst
@@ -7026,6 +7026,24 @@ The DHCPv4 server supports the following statistics:
    |                                              |                | statistic is exposed for each      |
    |                                              |                | subnet separately.                 |
    +----------------------------------------------+----------------+------------------------------------+
+   | v4-lease-reuses                              | integer        | Number of times an IPv4 lease had  |
+   |                                              |                | its CLTT increased in memory and   |
+   |                                              |                | its expiration time left unchanged |
+   |                                              |                | in persistent storage as part of   |
+   |                                              |                | the lease caching feature. This is |
+   |                                              |                | referred to as a lease reuse.      |
+   |                                              |                | This statistic is global.          |
+   +----------------------------------------------+----------------+------------------------------------+
+   | subnet[id].v4-lease-reuses                   | integer        | Number of times an IPv4 lease had  |
+   |                                              |                | its CLTT increased in memory and   |
+   |                                              |                | its expiration time left unchanged |
+   |                                              |                | in persistent storage as part of   |
+   |                                              |                | the lease caching feature. This is |
+   |                                              |                | referred to as a lease reuse.      |
+   |                                              |                | This statistic is on a per-subnet  |
+   |                                              |                | basis. The *id* is the subnet-id   |
+   |                                              |                | of a given subnet.                 |
+   +----------------------------------------------+----------------+------------------------------------+
    | v4-reservation-conflicts                     | integer        | Number of host reservation         |
    |                                              |                | allocation conflicts which have    |
    |                                              |                | occurred across every subnet. When |
diff --git a/doc/sphinx/arm/dhcp6-srv.rst b/doc/sphinx/arm/dhcp6-srv.rst
index 3ec9569033..d692f71bc1 100644
--- a/doc/sphinx/arm/dhcp6-srv.rst
+++ b/doc/sphinx/arm/dhcp6-srv.rst
@@ -6731,6 +6731,42 @@ The DHCPv6 server supports the following statistics:
    |                                              |                | statistic is exposed for each      |
    |                                              |                | subnet separately.                 |
    +----------------------------------------------+----------------+------------------------------------+
+   | v6-ia-na-lease-reuses                        | integer        | Number of times an IA_NA lease had |
+   |                                              |                | its CLTT increased in memory and   |
+   |                                              |                | its expiration time left unchanged |
+   |                                              |                | in persistent storage as part of   |
+   |                                              |                | the lease caching feature. This is |
+   |                                              |                | referred to as a lease reuse.      |
+   |                                              |                | This statistic is global.          |
+   +----------------------------------------------+----------------+------------------------------------+
+   | subnet[id].v6-ia-na-lease-reuses             | integer        | Number of times an IA_NA lease had |
+   |                                              |                | its CLTT increased in memory and   |
+   |                                              |                | its expiration time left unchanged |
+   |                                              |                | in persistent storage as part of   |
+   |                                              |                | the lease caching feature. This is |
+   |                                              |                | referred to as a lease reuse.      |
+   |                                              |                | This statistic is on a per-subnet  |
+   |                                              |                | basis. The *id* is the subnet-id   |
+   |                                              |                | of a given subnet.                 |
+   +----------------------------------------------+----------------+------------------------------------+
+   | v6-ia-pd-lease-reuses                        | integer        | Number of times an IA_PD lease had |
+   |                                              |                | its CLTT increased in memory and   |
+   |                                              |                | its expiration time left unchanged |
+   |                                              |                | in persistent storage as part of   |
+   |                                              |                | the lease caching feature. This is |
+   |                                              |                | referred to as a lease reuse.      |
+   |                                              |                | This statistic is global.          |
+   +----------------------------------------------+----------------+------------------------------------+
+   | subnet[id].v6-ia-pd-lease-reuses             | integer        | Number of times an IA_PD lease had |
+   |                                              |                | its CLTT increased in memory and   |
+   |                                              |                | its expiration time left unchanged |
+   |                                              |                | in persistent storage as part of   |
+   |                                              |                | the lease caching feature. This is |
+   |                                              |                | referred to as a lease reuse.      |
+   |                                              |                | This statistic is on a per-subnet  |
+   |                                              |                | basis. The *id* is the subnet-id   |
+   |                                              |                | of a given subnet.                 |
+   +----------------------------------------------+----------------+------------------------------------+
 
 .. note::
 
diff --git a/doc/sphinx/arm/stats.rst b/doc/sphinx/arm/stats.rst
index 1a05c30bb8..4c59a29f17 100644
--- a/doc/sphinx/arm/stats.rst
+++ b/doc/sphinx/arm/stats.rst
@@ -375,6 +375,18 @@ Here is an example response returning all collected statistics:
                    "2022-02-11 17:54:17.487512"
                ]
            ],
+           "subnet[1].v4-lease-reuses": [
+               [
+                   0,
+                   "2022-02-11 17:54:17.487516"
+               ]
+           ],
+           "subnet[1].v4-reservation-conflicts": [
+               [
+                   0,
+                   "2022-02-11 17:54:17.487520"
+               ]
+           ],
            "v4-allocation-fail": [
                [
                    0,
@@ -404,6 +416,18 @@ Here is an example response returning all collected statistics:
                    0,
                    "2022-02-11 17:54:17.455323"
                ]
+           ],
+           "v4-lease-reuses": [
+               [
+                   0,
+                   "2022-02-11 17:54:17.455328"
+               ]
+           ],
+           "v4-reservation-conflicts": [
+               [
+                   0,
+                   "2022-02-11 17:54:17.455332"
+               ]
            ]
        },
        "result": 0