Browse Source

[3795] User's Guide update, part 1

Tomek Mrugalski 10 years ago
parent
commit
13d3525ce6
2 changed files with 102 additions and 38 deletions
  1. 29 38
      doc/guide/dhcp4-srv.xml
  2. 73 0
      doc/guide/dhcp6-srv.xml

+ 29 - 38
doc/guide/dhcp4-srv.xml

@@ -2643,12 +2643,13 @@ temporarily override a list of interface names and listen on all interfaces.
             <entry>pkt4-received</entry>
             <entry>integer</entry>
             <entry>
-            Number of packets received. This includes all packets: valid, bogus, corrupted,
-            rejected etc.  This statistic is expected to grow rapidly.
+            Number of DHCPv4 packets received. This includes all packets: valid,
+            bogus, corrupted, rejected etc.  This statistic is expected to grow
+            rapidly.
             </entry>
             </row>
-            <row>
 
+            <row>
             <entry>pkt4-discover-received</entry>
             <entry>integer</entry>
             <entry>
@@ -2820,46 +2821,36 @@ temporarily override a list of interface names and listen on all interfaces.
             </entry>
             </row>
 
+            <row>
+              <entry>subnet[id].total-addresses</entry>
+              <entry>integer</entry>
+              <entry>The total number of addresses available for the DHCPv4
+              management. In other words, this is the sum of all addresses in
+              all configured pools. This statistic changes only during
+              configuration changes. Note it does not take into account any
+              addresses that may be reserved due to host reservation. The
+              <emphasis>id</emphasis> is the subnet-id of a given subnet. This
+              statistic is exposed for each subnet separately. This statistic is
+              reset during reconfiguration event.</entry>
+            </row>
+            <row>
+              <entry><emphasis>subnet[id].assigned-addresses</emphasis></entry>
+              <entry>integer</entry>
+              <entry>This statistic shows the number of assigned addresses in a
+              given subnet.  This statistic increases every time a new lease is
+              allocated (as a result of receiving a DHCPREQUEST message) and is
+              decreased every time a lease is released (a DHCPRELEASE message is
+              received). When lease expiration is implemented (planned for Kea
+              1.0), it will also decrease when a lease is expired. The
+              <emphasis>id</emphasis> is the subnet-id of a given subnet. This
+              statistic is exposed for each subnet separately. This statistic is
+              reset during reconfiguration event.</entry>
+            </row>
         </tbody>
         </tgroup>
         </table>
     </section>
 
-<!-- proper section structure added in ticket 3794, will merge it
-appropiately -->
-
-
-<section id="dummy">
-  <title>MERGE ME</title>
-  <para>
-    <itemizedlist>
-      <listitem>
-        <simpara><emphasis>subnet[id].total-addresses</emphasis> (integer) -
-        this statistic shows the total number of addresses available for the
-        DHCPv4 management. In other words, this is the sum of all addresses in
-        all configured pools. This statistic changes only during configuration
-        changes. Note it does not take into account any addresses that may be
-        reserved due to host reservation. The <emphasis>id</emphasis> is the
-        subnet-id of a given subnet. This statistic is exposed for each subnet
-	separately. This statistic is reset during reconfiguration event.
-	</simpara>
-      </listitem>
-      <listitem>
-        <simpara><emphasis>subnet[id].assigned-addresses</emphasis> (integer) -
-        this statistic shows the number of assigned addresses in a given subnet.
-        This statistic increases every time a new lease is allocated (as a result
-        of receiving a DHCPREQUEST message) and is decreased every time a lease is
-        released (a DHCPRELEASE message is received). When lease expiration
-        is implemented (planned for Kea 1.0), it will also decrease when a lease
-        is expired. The <emphasis>id</emphasis> is the subnet-id of a given
-        subnet. This statistic is exposed for each subnet separately. This
-        statistic is reset during reconfiguration event.
-	</simpara>
-      </listitem>
-    </itemizedlist>
-    </para>
-</section>
-
     <section id="dhcp4-std">
       <title>Supported DHCP Standards</title>
       <para>The following standards are currently supported:</para>

+ 73 - 0
doc/guide/dhcp6-srv.xml

@@ -2579,6 +2579,79 @@ should include options from the isc option space:
     </para>
     </section>
 
+    <section id="dhcp6-stats">
+      <title>Statistics in DHCPv6 server</title>
+      <note>
+        <para>This section describes DHCPv6-specific statistics. For a general
+        overview and usage of statistics, see <xref linkend="stats" />.</para>
+      </note>
+
+      <para>
+        The DHCPv6 server supports the following statistics:
+      </para>
+        <table frame="all" id="dhcp4-statistics">
+          <title>DHCPv4 Statistics</title>
+          <tgroup cols='3'>
+          <colspec colname='statistic' align='center'/>
+          <colspec colname='type' align='center'/>
+          <colspec colname='description' align='left'/>
+          <thead>
+            <row>
+              <entry>Statistic</entry>
+              <entry>Data Type</entry>
+              <entry>Description</entry>
+            </row>
+          </thead>
+          <tbody>
+
+            <row>
+              <entry>pkt6-received</entry>
+              <entry>integer</entry>
+              <entry>Number of DHCPv6 packets received. This includes all packets:
+              valid, bogus, corrupted, rejected etc. This statistic is expected
+              to grow rapidly.</entry>
+            </row>
+
+            <row>
+              <entry>pkt6-solicit-received</entry>
+              <entry>integer</entry>
+              <entry>
+                Number of SOLICIT packets received. This statistic is expected
+                to grow.  Its increase means that clients that just booted
+                started their configuration process and their initial packets
+                reached your server.
+              </entry>
+            </row>
+
+            <row>
+              <entry>pkt6-advertise-received</entry>
+              <entry>integer</entry>
+              <entry>
+                Number of ADVERTISE packets received. Advertise packets are sent
+                by the server and the server is never expected to receive them. Non-zero
+                value of tris statistic indicates an error ocurring in the network.
+                One likely cause would be a misbehaving relay agent that incorrectly
+                forwards ADVERTISE messages towards the server, rather back to the
+                clients.
+              </entry>
+            </row>
+
+            <row>
+              <entry>pkt6-request-received</entry>
+              <entry>integer</entry>
+              <entry>Number of REQUEST packets received. This statistic
+                is expected to grow. Its increase means that clients that just booted
+                received server's response (ADVERTISE), accepted it and now requesting
+                an address (REQUEST).
+              </entry>
+            </row>
+
+
+
+          </tbody>
+          </tgroup>
+        </table>
+    </section>
     <section id="dhcp6-std">
       <title>Supported DHCPv6 Standards</title>
       <para>The following standards are currently