]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#1285] Rephrased perf tuning section a bit
authorTomek Mrugalski <tomek@isc.org>
Mon, 27 Jul 2020 18:18:08 +0000 (20:18 +0200)
committerTomek Mrugalski <tomek@isc.org>
Mon, 27 Jul 2020 18:24:03 +0000 (20:24 +0200)
doc/sphinx/arm/dhcp4-srv.rst
doc/sphinx/arm/dhcp6-srv.rst

index a11d2d14325be863b47a81c654221c645f0e01f1..ed9040e65b7213a74f9c3747186c954c0a6f35f2 100644 (file)
@@ -3772,15 +3772,16 @@ An example configuration that sets these parameter looks as follows:
 Multi-threading settings in different backends
 ----------------------------------------------
 
-Both kea-dhcp4 and kea-dhcp6 are tested internally to determine which setting
-is the best. Although this section will describe our results those are just
-recommendations. We strongly advice to run your own performance tests.
+Both kea-dhcp4 and kea-dhcp6 are tested internally to determine which settings
+gave the best performance. Although this section describes our results, those are just
+recommendations and are very dependent on the particular hardware that was used
+for testing. We strongly advice to run your own performance tests.
 
-Full report Kea 1.7 results can be found `here <https://jenkins.isc.org/job/kea-1.7/job/performance/KeaPerformanceReport/>`_.
+Full report of Kea 1.7 performance results can be found `here <https://jenkins.isc.org/job/kea-1.7/job/performance/KeaPerformanceReport/>`_.
 This include hardware description, test scenario descriptions and
 current results.
 
-After enabling multi-threading number of threads is set by ``thread-pool-size``
+After enabling multi-threading, the number of threads is set by ``thread-pool-size``
 parameter, and results from our tests show that best configurations for
 kea-dhcp4 are:
 
@@ -3797,10 +3798,12 @@ on ``thread-pool-size``.
 Our tests reported best results when:
 
 -  ``packet-queue-size``: 7 * ``thread-pool-size`` when using ``memfile`` for
-   storing leases. In our case it's 7 * 4 = 28.
+   storing leases. In our case it's 7 * 4 = 28. This means that at any given
+   time, up to 28 packets could be queued.
 
 -  ``packet-queue-size``: 66 * ``thread-pool-size`` when using ``mysql`` for
-   storing leases. In our case it's 66 * 12 = 792.
+   storing leases. In our case it's 66 * 12 = 792. This means that up to
+   792 packets could be queued.
 
 -  ``packet-queue-size``: 11 * ``thread-pool-size`` when using ``postgresql`` for
    storing leases. In our case it's 11 * 8 = 88.
index 9aebbc09389e5781910ab0aae2b4a3afaa04200d..04943166adf16f2d6c55dc88a31eb94093bfef9e 100644 (file)
@@ -3284,15 +3284,16 @@ An example configuration that sets these parameter looks as follows:
 Multi-threading settings in different backends
 ----------------------------------------------
 
-Both kea-dhcp4 and kea-dhcp6 are tested internally to determine which setting
-is the best. Although this section will describe our results those are just
-recommendations. We strongly advice to run your own performance tests.
+Both kea-dhcp4 and kea-dhcp6 are tested internally to determine which settings
+gave the best performance. Although this section describes our results, those are just
+recommendations and are very dependent on the particular hardware that was used
+for testing. We strongly advice to run your own performance tests.
 
-Full report Kea 1.7 results can be found `here <https://jenkins.isc.org/job/kea-1.7/job/performance/KeaPerformanceReport/>`_.
-This include hardware description, test scenario descriptions and
+Full report of Kea 1.7 performance results can be found `here <https://jenkins.isc.org/job/kea-1.7/job/performance/KeaPerformanceReport/>`_.
+This includes hardware description, test scenario descriptions and
 current results.
 
-After enabling multi-threading number of threads is set by ``thread-pool-size``
+After enabling multi-threading, the number of threads is set by ``thread-pool-size``
 parameter, and results from our tests show that best configurations for
 kea-dhcp6 are:
 
@@ -3309,14 +3310,17 @@ on ``thread-pool-size``.
 Our tests reported best results when:
 
 -  ``packet-queue-size``: 150 * ``thread-pool-size`` when using ``memfile`` for
-   storing leases. In our case it's 150 * 4 = 600.
+   storing leases. In our case it's 150 * 4 = 600. This means that at any given
+   time, up to 600 packets could be queued.
 
 -  ``packet-queue-size``: 200 * ``thread-pool-size`` when using ``mysql`` for
-   storing leases. In our case it's 200 * 12 = 2400.
+   storing leases. In our case it's 200 * 12 = 2400. This means that up to
+   2400 packets could be queued.
 
 -  ``packet-queue-size``: 11 * ``thread-pool-size`` when using ``postgresql`` for
    storing leases. In our case it's 11 * 6 = 66.
 
+
 .. _host-reservation-v6:
 
 Host Reservation in DHCPv6