[#1445] Updated doc

diff --git a/ChangeLog b/ChangeLog
index cf1db1cc1334000af39fe40df21933a22bb74e1f..f4faf4734d60d3761a70712bd2c791ffbca61b47 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+1821.  [func]          fdupont
+       The forensic log hook library now logs release and decline
+       events. The event logged for DHCPv6 rebind is now named
+       "rebound" (it was named "renewed" i.e. with the same name as
+       renew events).
+       (Gitlab #1445)
+
 1820.  [bug]           razvan
        Fixed lease update when using HA and lease_cmds hooks with
        database backend. Previously, HA updates were rejected because

diff --git a/doc/sphinx/arm/hooks.rst b/doc/sphinx/arm/hooks.rst
index 03034ae21106566ee7b38330280cf5331713ab13..3917bf4b467234b532f61144e1d0f95b29c94864 100644 (file)
--- a/doc/sphinx/arm/hooks.rst
+++ b/doc/sphinx/arm/hooks.rst
@@ -604,7 +604,8 @@ DHCPv4 Log Entries
 
 For DHCPv4, the library creates entries based on DHCPREQUEST messages and
 corresponding DHCPv4 leases intercepted by the lease4_select (for new
-leases) and the lease4_renew (for renewed leases) hooks.
+leases), the lease4_renew (for renewed leases), the lease4_release
+(for released leases), and the lease4_decline (for decline leases) hooks.
 
 An entry is a single string with no embedded end-of-line markers and a
 prepended timestamp, and has the following sections:
@@ -623,7 +624,8 @@ Where:
 
 -  duration - the lease lifetime expressed in days (if present), hours,
    minutes, and seconds. A lease lifetime of 0xFFFFFFFF will be denoted
-   with the text "infinite duration".
+   with the text "infinite duration". This information is not given
+   when the lease is released or declined.
 
 -  device-id - the client's hardware address shown as numerical type and
    hex digit string.
@@ -647,6 +649,14 @@ present in the log file):
    hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54 connected via relay at address: 192.2.16.33,
    identified by circuit-id: 68:6f:77:64:79 (howdy) and remote-id: 87:f6:79:77:ef
 
+or for a release:
+
+::
+
+   2018-01-06 01:02:03 CET Address: 192.2.1.100 has been released from a device with hardware address:
+   hwtype=1 08:00:2b:02:3f:4e, client-id: 17:34:e2:ff:09:92:54 connected via relay at address: 192.2.16.33,
+   identified by circuit-id: 68:6f:77:64:79 (howdy) and remote-id: 87:f6:79:77:ef
+
 In addition to logging lease activity driven by DHCPv4 client traffic,
 the hooks library also logs entries for the following lease management control channel
 commands: lease4-add, lease4-update, and lease4-del. Each entry is a
@@ -713,7 +723,8 @@ DHCPv6 Log Entries
 
 For DHCPv6 the library creates entries based on lease management actions
 intercepted by lease6_select (for new leases), lease6_renew (for
-renewed leases), and lease6_rebind (for rebound leases).
+renewed leases), lease6_rebind (for rebound leases), lease6_release
+(for released leases), and the lease6_decline (for decline leases) hooks.
 
 An entry is a single string with no embedded end-of-line markers and a
 prepended timestamp, and has the following sections:
@@ -732,7 +743,8 @@ Where:
 
 -  duration - the lease lifetime expressed in days (if present), hours,
    minutes, and seconds. A lease lifetime of 0xFFFFFFFF will be denoted
-   with the text "infinite duration".
+   with the text "infinite duration". This information is not given
+   when the lease is released or declined.
 
 -  device-id - the client's DUID and hardware address (if present).
 
@@ -757,6 +769,20 @@ present in the log file):
    (from Raw Socket) connected via relay at address: fe80::abcd for client on link address: 3001::1,
    hop count: 1, identified by remote-id: 01:02:03:04:0a:0b:0c:0d:0e:0f and subscriber-id: 1a:2b:3c:4d:5e:6f
 
+or for a release:
+
+::
+
+   2018-01-06 01:02:03 PST Address:2001:db8:1:: has been released
+   from a device with DUID: 17:34:e2:ff:09:92:54 and hardware address: hwtype=1 08:00:2b:02:3f:4e
+   (from Raw Socket) connected via relay at address: fe80::abcd for client on link address: 3001::1,
+   hop count: 1, identified by remote-id: 01:02:03:04:0a:0b:0c:0d:0e:0f and subscriber-id: 1a:2b:3c:4d:5e:6f
+
+.. note::
+
+   Beginning with Kea 1.9.1 the rebind event is logged as "rebound": before
+   it was logged as "renewed" i.e. the same way as the renew event.
+
 In addition to logging lease activity driven by DHCPv6 client traffic,
 the hooks library also logs entries for the following lease management control channel
 commands: lease6-add, lease6-update, and lease6-del. Each entry is a