Log message format section (19.1.2) in ARM could be more clear
I find this section: 19.1.2. Logging Message Format of the ARM a little confusing and so wanted to detail below what I find confusing about it.
Potential Issue 1: https://kea.readthedocs.io/en/kea-2.4.0/arm/logging.html#id4 - The wording of the sentence preceeding this table and the title of the table imply that it is a complete list of all possible format options. It appears to be only a list of date/time format options possible inside of the %D{}
or %d{}
block. The sentence following seems to imply that this is indeed the content of the table as it refers to strftime(3)
man page.
Potential Issue 2: Are there other non-time format strings besides %D
, %-5p
, %c
, %i
, %t
, and %m
? It isn't clear if this is an exhaustive list.
Potential Issue 3: The examples "%D{%Y-%m-%d %H:%M:%S.%q} %-5p [%c/%i.%t] %m\n";
and "%-5p [%c.%t] %m\n";
have semicolons at the end of the strings. These semicolons cause syntax errors if used literally in Kea configuration. Perhaps a better way might be showing the way they would actually look in output-options
(e.g., "pattern": "%D{%Y-%m-%d %H:%M:%S.%q} %-5p [%c/%i.%t] %m\n"
)