[3794] Remaining stats added, docs updated.

diff --git a/doc/guide/Makefile.am b/doc/guide/Makefile.am
index 8076fb673a616fd197c98b5c9703a5467052c803..44e92987ae3b97e2e138e73d8b72c90b4ed9cf5f 100644 (file)
--- a/doc/guide/Makefile.am
+++ b/doc/guide/Makefile.am
@@ -7,7 +7,7 @@ dist_html_DATA = $(HTMLDOCS) kea-guide.css
 
 DOCBOOK = kea-guide.xml intro.xml quickstart.xml install.xml admin.xml config.xml
 DOCBOOK += keactrl.xml dhcp4-srv.xml dhcp6-srv.xml logging.xml ddns.xml hooks.xml
-DOCBOOK += libdhcp.xml lfc.xml
+DOCBOOK += libdhcp.xml lfc.xml stats.xml
 
 EXTRA_DIST = $(DOCBOOK)
 DISTCLEANFILES = $(HTMLDOCS) $(DOCS) kea-messages.xml

diff --git a/doc/guide/dhcp4-srv.xml b/doc/guide/dhcp4-srv.xml
index 41bd5852a07db685bb3fe50eb05270efabdbe66c..34d6707bd716cb28b0a8e1906bf9c556aa68cfd4 100644 (file)
--- a/doc/guide/dhcp4-srv.xml
+++ b/doc/guide/dhcp4-srv.xml
@@ -2418,6 +2418,158 @@ temporarily override a list of interface names and listen on all interfaces.
 
     </section>
 
+    <section id="dhcp4-stats">
+      <title>Statistics in DHCPv4 server</title>
+      <note>
+        <para>This section describes DHCPv4-specific statistics. For a general
+        overview and usage of statistics, see <xref linkend="stats" />.</para>
+      </note>
+
+      <para>
+        The DHCPv4 server supports the following statistics:
+      </para>
+      <para>
+        <itemizedlist>
+          <listitem>
+            <simpara><emphasis>pkt4-received</emphasis> (integer) - this
+            statistic shows the the number of received packets. That includes
+            all packets: valid, bogus, corrupted, rejected etc. This statistic
+            is expected to grow rapidly.</simpara>
+          </listitem>
+          <listitem>
+            <simpara><emphasis>pkt4-discover-received</emphasis> (integer) -
+            specifies the number of received DHCPDISCOVER packets. 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.</simpara>
+          </listitem>
+          <listitem>
+            <simpara><emphasis>pkt4-offer-received</emphasis> (integer) -
+            specifies the number of received DHCPOFFER packets. This statistic
+            is expected to remain zero at all times, as DHCPOFFER packets are sent
+            by the server and the server is never expected to receive them. Non-zero
+            value indicates an error. One likely cause would be a misbehaving relay
+            agent that incorrectly forwards DHCPOFFER messages towards the server,
+            rather back to the clients.</simpara>
+          </listitem>
+          <listitem>
+            <simpara><emphasis>pkt4-request-received</emphasis> (integer) -
+            specifies the number of received DHCPREQUEST packets. This statistic
+            is expected to grow. Its increase means that clients that just booted
+            received server's response (DHCPOFFER), accepted it and now requesting
+            an address (DHCPREQUEST).</simpara>
+          </listitem>
+          <listitem>
+            <simpara><emphasis>pkt4-ack-received</emphasis> (integer) -
+            specifies the number of received DHCPACK packets. This statistic
+            is expected to remain zero at all times, as DHCPACK packets are sent
+            by the server and the server is never expected to receive them. Non-zero
+            value indicates an error. One likely cause would be a misbehaving relay
+            agent that incorrectly forwards DHCPACK messages towards the server,
+            rather back to the clients.</simpara>
+          </listitem>
+          <listitem>
+            <simpara><emphasis>pkt4-nak-received</emphasis> (integer) -
+            specifies the number of received DHCPNAK packets. This statistic
+            is expected to remain zero at all times, as DHCPNAK packets are sent
+            by the server and the server is never expected to receive them. Non-zero
+            value indicates an error. One likely cause would be a misbehaving relay
+            agent that incorrectly forwards DHCPNAK messages towards the server,
+            rather back to the clients.</simpara>
+          </listitem>
+          <listitem>
+            <simpara><emphasis>pkt4-release-received</emphasis> (integer) -
+            specifies the number of received DHCPRELEASE packets. This statistic
+            is expected to grow. Its increase means that clients that had an address
+            are shutting down or stop using their addresses.</simpara>
+          </listitem>
+          <listitem>
+            <simpara><emphasis>pkt4-decline-received</emphasis> (integer) -
+            specifies the number of received DHCPDECLINE packets. This statistic
+            is expected to remain close to zero. Its increase means that clients
+            that leased an address, but discovered that the address is currently
+            used by an unknown device in your network.</simpara>
+          </listitem>
+          <listitem>
+            <simpara><emphasis>pkt4-decline-received</emphasis> (integer) -
+            specifies the number of received DHCPDECLINE packets. This statistic
+            is expected to remain close to zero. Its increase means that a client
+            that leased an address, but discovered that the address is currently
+            used by an unknown device in your network.</simpara>
+          </listitem>
+          <listitem>
+            <simpara><emphasis>pkt4-inform-received</emphasis> (integer) -
+            specifies the number of received DHCPINFORM packets. This statistic
+            is expected to grow. Its increase means that there are clients that
+            either do not need an address or already have an address and are
+            interested only in getting additional configuration parameters.
+            </simpara>
+          </listitem>
+          <listitem>
+            <simpara><emphasis>pkt4-unknown-received</emphasis> (integer) -
+            specifies the number of received packets of uknown type. Non-zero
+            value of this statistic indicates that the server received a packet
+            that it wasn't able to recognize: either with unsupported type
+            or possibly malformed (without message type option).</simpara>
+          </listitem>
+          <listitem>
+            <simpara><emphasis>pkt4-sent</emphasis> (integer) - specifies the
+            number of sent DHCPv4 packets. This statistic is expected to grow
+            every time the server transmits a packet. In general, it should
+            roughly match pkt4-received, as most incoming packets cause
+            server to respond. There are exceptions (e.g. DHCPRELEASE), so
+            do not worry, if it is lesser than pkt4-received.</simpara>
+          </listitem>
+          <listitem>
+            <simpara><emphasis>pkt4-sent</emphasis> (integer) - specifies the
+            number of sent DHCPv4 packets. This statistic is expected to grow
+            every time the server transmits a packet. In general, it should
+            roughly match pkt4-received, as most incoming packets cause
+            server to respond. There are exceptions (e.g. DHCPRELEASE), so
+            do not worry, if it is lesser than pkt4-received.</simpara>
+          </listitem>
+          <listitem>
+            <simpara><emphasis>pkt4-offer-sent</emphasis> (integer) - specifies
+            the number of sent DHCPOFFER packets. This statistic is expected to
+            grow in most cases after a DHCPDISCOVER is processed. There are
+            certain uncommon, but valid cases where incoming DHCPDISCOVER is
+            dropped, but in general this statistic is expected to be close to
+            pkt4-discover-received.</simpara>
+          </listitem>
+          <listitem>
+            <simpara><emphasis>pkt4-ack-sent</emphasis> (integer) - specifies
+            the number of sent DHCPACK packets. This statistic is expected to
+            grow in most cases after a DHCPREQUEST is processed. There are
+            certain cases where DHCPNAK is sent instead. In general, the sum of
+            pkt4-ack-sent and pkt4-nak-sent should be close to
+            pkt4-request-received.</simpara>
+          </listitem>
+          <listitem>
+            <simpara><emphasis>pkt4-nak-sent</emphasis> (integer) - specifies
+            the number of sent DHCPNAK packets. This statistic is expected to
+            grow when the server choses to not honor the address requested by a
+            client. In general, the sum of pkt4-ack-sent and pkt4-nak-sent
+            should be close to pkt4-request-received.</simpara>
+          </listitem>
+          <listitem>
+            <simpara><emphasis>pkt4-parse-failed</emphasis> (integer) - this
+            statistic denote the number of packets that were received, but the
+            Kea server was unable to parse it. Non-zero value of this statistic
+            indicates that the server received malformed or truncated packet.
+            This may indicate problems in your network, faulty clients or server
+            code bug.</simpara>
+          </listitem>
+          <listitem>
+            <simpara><emphasis>pkt4-receive-drop</emphasis> (integer) - this
+            statistic indicate number of incoming packets that were dropped.
+            Exact reason for dropping packets is logged, but the most common
+            reasons may be not accepted packet type, direct responses are
+            forbidden or the server-id the client had sent doesn't match the
+            server's.</simpara>
+          </listitem>
+      </itemizedlist>
+      </para>
+    </section>
 
     <section id="dhcp4-std">
       <title>Supported DHCP Standards</title>

diff --git a/doc/guide/kea-guide.xml b/doc/guide/kea-guide.xml
index 0095931a6c1db700c0a7bcc6c4f1ecfa380d3ba6..8610398d7efe01774f9db576e20de835446fe7a5 100644 (file)
--- a/doc/guide/kea-guide.xml
+++ b/doc/guide/kea-guide.xml
@@ -73,6 +73,8 @@
 
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="hooks.xml" />
 
+  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="stats.xml" />
+
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="libdhcp.xml" />
 
   <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="logging.xml" />

diff --git a/doc/guide/stats.xml b/doc/guide/stats.xml
new file mode 100644 (file)
index 0000000..9f907c3
--- /dev/null
+++ b/doc/guide/stats.xml
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+<!ENTITY mdash  "&#x2014;" >
+]>
+
+  <!-- Note: Please use the following terminology:
+       - daemon - one process (e.g. kea-dhcp4)
+       - component - one piece of code within a daemon (e.g. libdhcp or hooks)
+       - server - currently equal to daemon, but the difference will be more
+                  prominent once we add client or relay support
+       - logger - one instance of isc::log::Logger
+       - structure - an element in config file (e.g. "Dhcp4")
+
+       Do not use:
+       - module => daemon
+    -->
+
+<chapter id="stats">
+  <title>Statistics</title>
+
+  <section>
+    <title>Statistics Overview</title>
+    
+    <para>
+      TODO: Describe statistics collection here as part of ticket #3800.
+      For DHCPv4 specific statistics, see <xref linkend="dhcp4-stats"/>.
+      For DHCPv6 specific statistics, see TODO.
+      For DDNS specific statistics, see TODO.
+    </para>
+  </section>
+</chapter>
+

diff --git a/src/bin/dhcp4/dhcp4_srv.cc b/src/bin/dhcp4/dhcp4_srv.cc
index 459a43aaeb36427a1f6baa60ff22445428f134c2..c398fe1fc61a507b1a303a956dfb9672dbfc627f 100644 (file)
--- a/src/bin/dhcp4/dhcp4_srv.cc
+++ b/src/bin/dhcp4/dhcp4_srv.cc
@@ -465,6 +465,10 @@ Dhcpv4Srv::run() {
                     .arg(query->getLocalAddr().toText())
                     .arg(query->getIface())
                     .arg(e.what());
+
+                // Increase the statistics of parse failues and dropped packets.
+                isc::stats::StatsMgr::instance().addValue("pkt4-parse-failed", 1ul);
+                isc::stats::StatsMgr::instance().addValue("pkt4-receive-drop", 1ul);
                 continue;
             }
         }
@@ -480,6 +484,7 @@ Dhcpv4Srv::run() {
         // Check whether the message should be further processed or discarded.
         // There is no need to log anything here. This function logs by itself.
         if (!accept(query)) {
+            // Increase the statistic of dropped packets.
             isc::stats::StatsMgr::instance().addValue("pkt4-receive-drop", 1ul);
             continue;
         }
@@ -567,6 +572,9 @@ Dhcpv4Srv::run() {
                       DHCP4_PACKET_DROP_0007)
                 .arg(query->getLabel())
                 .arg(e.what());
+
+            // Increase the statistic of dropped packets.
+            isc::stats::StatsMgr::instance().addValue("pkt4-receive-drop", 1ul);
         }
 
         if (!rsp) {