mir/kea
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-29 13:07:50 +00:00
Code Issues Releases Wiki Activity

[#3831] fixed forensic log path in docs

Browse Source
This commit is contained in:
Razvan Becheriu 2025-05-22 15:13:58 +03:00
parent 727d286db7
commit 2b9b79e7a5
5 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/examples/kea4/hooks.json
View File

@ -40,7 +40,7 @@
{ {
"library": "/opt/lib/charging.so", "library": "/opt/lib/charging.so",
"parameters": { "parameters": {
"path": "/var/lib/kea", "path": "/var/log/kea",
"base-name": "kea-forensic6" "base-name": "kea-forensic6"
} }
} }

2
doc/examples/kea6/hooks.json
View File

@ -48,7 +48,7 @@
{ {
"library": "/opt/lib/charging.so", "library": "/opt/lib/charging.so",
"parameters": { "parameters": {
"path": "/var/lib/kea", "path": "/var/log/kea",
"base-name": "kea-forensic6" "base-name": "kea-forensic6"
} }
} }

10
doc/sphinx/arm/hooks-legal-log.rst
View File

@ -85,7 +85,7 @@ configuration of the desired DHCP server modules. :ischooklib:`libdhcp_legal_log
can save logs to a text file or to a database (created using can save logs to a text file or to a database (created using
:iscman:`kea-admin`; see :ref:`mysql-database-create` and :ref:`pgsql-database-create`). :iscman:`kea-admin`; see :ref:`mysql-database-create` and :ref:`pgsql-database-create`).
The library is installed alongside the Kea libraries in The library is installed alongside the Kea libraries in
``[kea-install-dir]/var/lib/kea``, where ``kea-install-dir`` is determined ``[kea-install-dir]/var/log/kea``, where ``kea-install-dir`` is determined
by the ``--prefix`` meson setup option which defaults to by the ``--prefix`` meson setup option which defaults to
``/usr/local``. Assuming the default value, :iscman:`kea-dhcp4` can be configured to load ``/usr/local``. Assuming the default value, :iscman:`kea-dhcp4` can be configured to load
:ischooklib:`libdhcp_legal_log.so` like this: :ischooklib:`libdhcp_legal_log.so` like this:
@ -98,7 +98,7 @@ by the ``--prefix`` meson setup option which defaults to
{ {
"library": "/usr/local/lib/kea/hooks/libdhcp_legal_log.so", "library": "/usr/local/lib/kea/hooks/libdhcp_legal_log.so",
"parameters": { "parameters": {
"path": "/var/lib/kea/log", "path": "/var/log/kea",
"base-name": "kea-forensic4" "base-name": "kea-forensic4"
} }
} }
@ -116,7 +116,7 @@ For :iscman:`kea-dhcp6`, the configuration is:
{ {
"library": "/usr/local/lib/kea/hooks/libdhcp_legal_log.so", "library": "/usr/local/lib/kea/hooks/libdhcp_legal_log.so",
"parameters": { "parameters": {
"path": "/var/lib/kea/log", "path": "/var/log/kea",
"base-name": "kea-forensic6" "base-name": "kea-forensic6"
} }
} }
@ -198,7 +198,7 @@ Examples:
{ {
"library": "/usr/local/lib/kea/hooks/libdhcp_legal_log.so", "library": "/usr/local/lib/kea/hooks/libdhcp_legal_log.so",
"parameters": { "parameters": {
"path": "/var/lib/kea/log", "path": "/var/log/kea",
"base-name": "kea-forensic6", "base-name": "kea-forensic6",
"request-parser-format": "'first line' + 0x0a + 'second line'", "request-parser-format": "'first line' + 0x0a + 'second line'",
"response-parser-format": "'also second line' + 0x0a + 'third line'" "response-parser-format": "'also second line' + 0x0a + 'third line'"
@ -231,7 +231,7 @@ Examples:
{ {
"library": "/usr/local/lib/kea/hooks/libdhcp_legal_log.so", "library": "/usr/local/lib/kea/hooks/libdhcp_legal_log.so",
"parameters": { "parameters": {
"path": "/var/lib/kea/log", "path": "/var/log/kea",
"base-name": "kea-forensic6", "base-name": "kea-forensic6",
"timestamp-format": "%H%t%w %F%%" "timestamp-format": "%H%t%w %F%%"
} }

6
src/hooks/dhcp/forensic_log/libdhcp_legal_log.dox
View File

@ -357,7 +357,7 @@ configuration:
"hooks-libraries": [ "hooks-libraries": [
{ "library": "/usr/local/lib/libdhcp_legal_log.so", { "library": "/usr/local/lib/libdhcp_legal_log.so",
"parameters": { "parameters": {
"path": "/var/lib/kea", "path": "/var/log/kea",
"base-name": "kea-legal4" } }, "base-name": "kea-legal4" } },
... ...
] ]
@ -371,7 +371,7 @@ To configure it for kea-dhcp6, the commands are simply as shown below:
"hooks-libraries": [ "hooks-libraries": [
{ "library": "/usr/local/lib/libdhcp_legal_log.so", { "library": "/usr/local/lib/libdhcp_legal_log.so",
"parameters": { "parameters": {
"path": "/var/lib/kea", "path": "/var/log/kea",
"base-name": "kea-legal6" } }, "base-name": "kea-legal6" } },
... ...
] ]
@ -380,7 +380,7 @@ To configure it for kea-dhcp6, the commands are simply as shown below:
Two string Hook Library Parameters are supported: Two string Hook Library Parameters are supported:
- @b path - Directory in which the legal file(s) will be written. The - @b path - Directory in which the legal file(s) will be written. The
default value is "<prefix>/var/lib/kea". The directory must exist. default value is "<prefix>/var/log/kea". The directory must exist.
- @b base-name - An arbitrary value which is used in conjunction with - @b base-name - An arbitrary value which is used in conjunction with
the current system date to form the current legal file name. It defaults the current system date to form the current legal file name. It defaults
to "kea-legal". to "kea-legal".

2
src/hooks/dhcp/forensic_log/rotating_file.h
View File

@ -93,7 +93,7 @@ public:
/// mechanism: /// mechanism:
/// ///
/// @b path - Directory in which the legal file(s) will be written. /// @b path - Directory in which the legal file(s) will be written.
/// The default value is "<prefix>/var/lib/kea". The directory must exist. /// The default value is "<prefix>/var/log/kea". The directory must exist.
/// ///
/// @b base-name - An arbitrary value which is used in conjunction /// @b base-name - An arbitrary value which is used in conjunction
/// with current system date to form the current legal file name. /// with current system date to form the current legal file name.