mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-09-01 06:25:34 +00:00
Code Issues Releases Wiki Activity

[3794] Converted dhcp4 guide statistics list to table

Browse Source 
doc/guide/dhcp4-srv.xml
    converted item list of statistics to a table to improve readability.
This commit is contained in:
Thomas Markwalder
2015-05-29 09:37:31 -04:00
parent afb45a9e6f
commit 055a5b32e9
1 changed files with 166 additions and 108 deletions
Download Patch File Download Diff File Expand all files Collapse all files

274
doc/guide/dhcp4-srv.xml
View File

@@ -2266,7 +2266,7 @@ temporarily override a list of interface names and listen on all interfaces.
] ]
} }
</screen> </screen>
</para> </para>
</section> </section>
</section> </section>
@@ -2428,147 +2428,205 @@ temporarily override a list of interface names and listen on all interfaces.
<para> <para>
The DHCPv4 server supports the following statistics: The DHCPv4 server supports the following statistics:
</para> </para>
<para> <table frame="all" id="dhcp4-statistics">
<itemizedlist> <title>DHCPv4 Statistics</title>
<listitem> <tgroup cols='3'>
<simpara><emphasis>pkt4-received</emphasis> (integer) - this <colspec colname='statistic' align='center'/>
statistic shows the the number of received packets. That includes <colspec colname='type' align='center'/>
all packets: valid, bogus, corrupted, rejected etc. This statistic <colspec colname='description' align='left'/>
is expected to grow rapidly.</simpara> <thead>
</listitem> <row>
<listitem> <entry>Statistic</entry>
<simpara><emphasis>pkt4-discover-received</emphasis> (integer) - <entry>Data Type</entry>
specifies the number of received DHCPDISCOVER packets. This statistic <entry>Description</entry>
is expected to grow. Its increase means that clients that just booted </row>
started their configuration process and their initial packets reached </thead>
your server.</simpara> <tbody>
</listitem>
<listitem> <row>
<simpara><emphasis>pkt4-offer-received</emphasis> (integer) - <entry>pkt4-received</entry>
specifies the number of received DHCPOFFER packets. This statistic <entry>integer</entry>
<entry>
Number of packets received. This includes all packets: valid, bogus, corrupted,
rejected etc. This statistic is expected to grow rapidly.
</entry>
</row>
<row>
<entry>pkt4-discover-received</entry>
<entry>integer</entry>
<entry>
Number of DHCPDISCOVER 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>pkt4-offer-received</entry>
<entry>integer</entry>
<entry>
Number of DHCPOFFER packets received. This statistic
is expected to remain zero at all times, as DHCPOFFER packets are sent 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 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 value indicates an error. One likely cause would be a misbehaving relay
agent that incorrectly forwards DHCPOFFER messages towards the server, agent that incorrectly forwards DHCPOFFER messages towards the server,
rather back to the clients.</simpara> rather back to the clients.
</listitem> </entry>
<listitem> </row>
<simpara><emphasis>pkt4-request-received</emphasis> (integer) -
specifies the number of received DHCPREQUEST packets. This statistic <row>
<entry>pkt4-request-received</entry>
<entry>integer</entry>
<entry>
Number of DHCPREQUEST packets received. This statistic
is expected to grow. Its increase means that clients that just booted is expected to grow. Its increase means that clients that just booted
received server's response (DHCPOFFER), accepted it and now requesting received server's response (DHCPOFFER), accepted it and now requesting
an address (DHCPREQUEST).</simpara> an address (DHCPREQUEST).
</listitem> </entry>
<listitem> </row>
<simpara><emphasis>pkt4-ack-received</emphasis> (integer) -
specifies the number of received DHCPACK packets. This statistic <row>
<entry>pkt4-ack-received</entry>
<entry>integer</entry>
<entry>
Number of DHCPACK packets received. This statistic
is expected to remain zero at all times, as DHCPACK packets are sent 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 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 value indicates an error. One likely cause would be a misbehaving relay
agent that incorrectly forwards DHCPACK messages towards the server, agent that incorrectly forwards DHCPACK messages towards the server,
rather back to the clients.</simpara> rather back to the clients.
</listitem> </entry>
<listitem> </row>
<simpara><emphasis>pkt4-nak-received</emphasis> (integer) -
specifies the number of received DHCPNAK packets. This statistic <row>
<entry>pkt4-nak-received</entry>
<entry>integer</entry>
<entry>
Number of DHCPNAK packets received. This statistic
is expected to remain zero at all times, as DHCPNAK packets are sent 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 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 value indicates an error. One likely cause would be a misbehaving relay
agent that incorrectly forwards DHCPNAK messages towards the server, agent that incorrectly forwards DHCPNAK messages towards the server,
rather back to the clients.</simpara> rather back to the clients.
</listitem> </entry>
<listitem> </row>
<simpara><emphasis>pkt4-release-received</emphasis> (integer) -
specifies the number of received DHCPRELEASE packets. This statistic <row>
<entry>pkt4-release-received</entry>
<entry>integer</entry>
<entry>
Number of DHCPRELEASE packets received. This statistic
is expected to grow. Its increase means that clients that had an address is expected to grow. Its increase means that clients that had an address
are shutting down or stop using their addresses.</simpara> are shutting down or stop using their addresses.
</listitem> </entry>
<listitem> </row>
<simpara><emphasis>pkt4-decline-received</emphasis> (integer) -
specifies the number of received DHCPDECLINE packets. This statistic <row>
is expected to remain close to zero. Its increase means that clients <entry>pkt4-decline-received</entry>
that leased an address, but discovered that the address is currently <entry>integer</entry>
used by an unknown device in your network.</simpara> <entry>
</listitem> Number of DHCPDECLINE packets received. This statistic
<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 is expected to remain close to zero. Its increase means that a client
that leased an address, but discovered that the address is currently that leased an address, but discovered that the address is currently
used by an unknown device in your network.</simpara> used by an unknown device in your network.
</listitem> </entry>
<listitem> </row>
<simpara><emphasis>pkt4-inform-received</emphasis> (integer) -
specifies the number of received DHCPINFORM packets. This statistic <row>
<entry>pkt4-inform-received</entry>
<entry>integer</entry>
<entry>
Number of DHCPINFORM packets received. This statistic
is expected to grow. Its increase means that there are clients that 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 either do not need an address or already have an address and are
interested only in getting additional configuration parameters. interested only in getting additional configuration parameters.
</simpara> </entry>
</listitem> </row>
<listitem>
<simpara><emphasis>pkt4-unknown-received</emphasis> (integer) - <row>
specifies the number of received packets of uknown type. Non-zero <entry>pkt4-unknown-received</entry>
<entry>integer</entry>
<entry>
Number of packets received of an unknown type. Non-zero
value of this statistic indicates that the server received a packet value of this statistic indicates that the server received a packet
that it wasn't able to recognize: either with unsupported type that it wasn't able to recognize: either with unsupported type
or possibly malformed (without message type option).</simpara> or possibly malformed (without message type option).
</listitem> </entry>
<listitem> </row>
<simpara><emphasis>pkt4-sent</emphasis> (integer) - specifies the
number of sent DHCPv4 packets. This statistic is expected to grow <row>
<entry>pkt4-sent</entry>
<entry>integer</entry>
<entry>
Number of DHCPv4 packets sent. This statistic is expected to grow
every time the server transmits a packet. In general, it should every time the server transmits a packet. In general, it should
roughly match pkt4-received, as most incoming packets cause roughly match pkt4-received, as most incoming packets cause
server to respond. There are exceptions (e.g. DHCPRELEASE), so server to respond. There are exceptions (e.g. DHCPRELEASE), so
do not worry, if it is lesser than pkt4-received.</simpara> do not worry, if it is lesser than pkt4-received.
</listitem> </entry>
<listitem> </row>
<simpara><emphasis>pkt4-sent</emphasis> (integer) - specifies the
number of sent DHCPv4 packets. This statistic is expected to grow <row>
every time the server transmits a packet. In general, it should <entry>pkt4-offer-sent</entry>
roughly match pkt4-received, as most incoming packets cause <entry>integer</entry>
server to respond. There are exceptions (e.g. DHCPRELEASE), so <entry>
do not worry, if it is lesser than pkt4-received.</simpara> Number of DHCPOFFER packets sent. This statistic is expected to
</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 grow in most cases after a DHCPDISCOVER is processed. There are
certain uncommon, but valid cases where incoming DHCPDISCOVER is certain uncommon, but valid cases where incoming DHCPDISCOVER is
dropped, but in general this statistic is expected to be close to dropped, but in general this statistic is expected to be close to
pkt4-discover-received.</simpara> pkt4-discover-received.
</listitem> </entry>
<listitem> </row>
<simpara><emphasis>pkt4-ack-sent</emphasis> (integer) - specifies
the number of sent DHCPACK packets. This statistic is expected to <row>
<entry>pkt4-ack-sent</entry>
<entry>integer</entry>
<entry>
Number of DHCPACK packets sent. This statistic is expected to
grow in most cases after a DHCPREQUEST is processed. There are grow in most cases after a DHCPREQUEST is processed. There are
certain cases where DHCPNAK is sent instead. In general, the sum of certain cases where DHCPNAK is sent instead. In general, the sum of
pkt4-ack-sent and pkt4-nak-sent should be close to pkt4-ack-sent and pkt4-nak-sent should be close to
pkt4-request-received.</simpara> pkt4-request-received.
</listitem> </entry>
<listitem> </row>
<simpara><emphasis>pkt4-nak-sent</emphasis> (integer) - specifies
the number of sent DHCPNAK packets. This statistic is expected to <row>
<entry>pkt4-nak-sent</entry>
<entry>integer</entry>
<entry>
Number of DHCPNAK packets sent. This statistic is expected to
grow when the server choses to not honor the address requested by a 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 client. In general, the sum of pkt4-ack-sent and pkt4-nak-sent
should be close to pkt4-request-received.</simpara> should be close to pkt4-request-received.
</listitem> </entry>
<listitem> </row>
<simpara><emphasis>pkt4-parse-failed</emphasis> (integer) - this
statistic denote the number of packets that were received, but the <row>
Kea server was unable to parse it. Non-zero value of this statistic <entry>pkt4-parse-failed</entry>
indicates that the server received malformed or truncated packet. <entry>integer</entry>
This may indicate problems in your network, faulty clients or server <entry>
code bug.</simpara> Number of incoming packets that could not be parsed. Non-zero value of
</listitem> this statistic indicates that the server received malformed or truncated packet.
<listitem> This may indicate problems in your network, faulty clients or server code bug.
<simpara><emphasis>pkt4-receive-drop</emphasis> (integer) - this </entry>
statistic indicate number of incoming packets that were dropped. </row>
<row>
<entry>pkt4-receive-drop</entry>
<entry>integer</entry>
<entry>
Number of incoming packets that were dropped.
Exact reason for dropping packets is logged, but the most common Exact reason for dropping packets is logged, but the most common
reasons may be not accepted packet type, direct responses are reasons may be: an unacceptable packet type, direct responses are
forbidden or the server-id the client had sent doesn't match the forbidden, or the server-id sent by the client does not match
server's.</simpara> the server's server-id.
</listitem> </entry>
</itemizedlist> </row>
</para>
</tbody>
</tgroup>
</table>
</section> </section>
<section id="dhcp4-std"> <section id="dhcp4-std">